Numeric.GSL.Histogram

GSL histogram functions

http://www.gnu.org/software/gsl/manual/

Creation

data Histogram

A histogram structure

Instances

Eq Histogram

Binary Histogram

emptyRanges

Arguments

:: Vector Double

the ranges

-> Histogram

result

create a histogram with n bins from ranges (x0->x1),(x1->x2)..(xn->xn+1)

emptyLimits

Arguments

:: Int

bins

-> (Double, Double)

lower and upper limits

-> Histogram

result

create a histogram with n bins and lower and upper limits

fromRanges

Arguments

:: Vector Double

the ranges

-> Vector Double

the data

-> Histogram

result

create a histogram with n bins from ranges (x0->x1),(x1->x2)..(xn->xn+1) and increment from a vector

fromLimits

Arguments

:: Int

bins

-> (Double, Double)

lower and upper limits

-> Vector Double

the data

-> Histogram

result

create a histogram with n bins and lower and upper limits and increment from a vector

Loading

addList :: Histogram -> [Double] -> Histogram

adds 1.0 to the correct bin for each element of the list

addVector :: Histogram -> Vector Double -> Histogram

adds 1.0 to the correct bin for each element of the vector

addListWeighted :: Histogram -> [(Double, Double)] -> Histogram

adds the appropriate weight for each element of the list

addVectorWeighted :: Histogram -> Vector Double -> Vector Double -> Histogram

adds the appropriate weight for each element of the list

Marshalling

toVectors

Arguments

:: Histogram

-> (Vector Double, Vector Double)

(ranges,bins)

extract the ranges and bin weights

fromVectors :: Vector Double -> Vector Double -> Histogram

create a histogram from the ranges and bin weights

Information

getBin :: Histogram -> Int -> Double

returns the contents of the i-th bin

getRange :: Histogram -> Int -> (Double, Double)

returns the upper and lower limits of the i-th bin

getMax :: Histogram -> Double

the maximum upper range limit

getMin :: Histogram -> Double

the minimum lower range limit

getBins :: Histogram -> Int

the number of bins

Querying

find :: Histogram -> Double -> Maybe Int

find the bin corresponding to the value

count :: Histogram -> Vector Double -> Vector Double

find the number of occurences for each element of the input vector

prob :: Histogram -> Vector Double -> Vector Double

find the probability of occurring for each element of the input vector

countInstance :: Histogram -> Double -> Double

find the number of occurences for the input

probability :: Histogram -> Double -> Double

find the probability of the input

maxVal :: Histogram -> Double

the maximum value contained in the bins

maxBin :: Histogram -> Int

the index of the bin containing the maximum value

minVal :: Histogram -> Double

the minimum value contained in the bins

minBin :: Histogram -> Int

the index of the bin containing the minimum value

Statistics

mean :: Histogram -> Double

the mean of the values, accuracy limited by bin width

stddev :: Histogram -> Double

the standard deviation of the values, accuracy limited by bin width

sum :: Histogram -> Double

the sum of the values, accuracy limited by bin width

equalBins :: Histogram -> Histogram -> Bool

returns True of all the individual bin ranges of the two histograms are identical

Mathematics

add :: Histogram -> Histogram -> Histogram

adds the contents of the bins of the second histogram to the first

subtract :: Histogram -> Histogram -> Histogram

subtracts the contents of the bins of the second histogram from the first

multiply :: Histogram -> Histogram -> Histogram

multiplies the contents of the bins of the second histogram by the first

divide :: Histogram -> Histogram -> Histogram

divides the contents of the bins of the first histogram by the second

shift :: Histogram -> Double -> Histogram

adds a constant to the contents of the bins

scale :: Histogram -> Double -> Histogram

multiplies the contents of the bins by a constant

Files

fwriteHistogram :: FilePath -> Histogram -> IO ()

write a histogram in the native binary format (may not be portable)

freadHistogram :: FilePath -> Int -> IO Histogram

read a histogram in the native binary format, number of bins must be known

fprintfHistogram :: FilePath -> String -> String -> Histogram -> IO ()

saves the histogram with the given formats (%f,%e,%g) for ranges and bins each line comprises: range[i] range[i+1] bin[i]

fscanfHistogram :: FilePath -> Int -> IO Histogram

reads formatted data as written by fprintf, the number of bins must be known in advance

PDF

data HistogramPDF

A histogram-derived cumulative distribution function (CDF)

fromHistogram :: Histogram -> HistogramPDF

create a histogram PDF from a histogram

sample :: HistogramPDF -> Double -> Double

given a random number from the uniform distribution [0,1], draw a random sample from the PDF