Struct rgsl::types::histograms::Histogram2DPdf

pub struct Histogram2DPdf { /* fields omitted */ }

As in the one-dimensional case, a two-dimensional histogram made by counting events can be regarded as a measurement of a probability distribution. Allowing for statistical error, the height of each bin represents the probability of an event where (x,y) falls in the range of that bin. For a two-dimensional histogram the probability distribution takes the form p(x,y) dx dy where,

p(x,y) = n_{ij}/ (N A_{ij})

In this equation n_{ij} is the number of events in the bin which contains (x,y), A_{ij} is the area of the bin and N is the total number of events. The distribution of events within each bin is assumed to be uniform.

Implementations

impl Histogram2DPdf

pub fn new(nx: usize, ny: usize) -> Option<Histogram2DPdf>

This function allocates memory for a two-dimensional probability distribution of size nx-by-ny and returns a pointer to a newly initialized gsl_histogram2d_pdf struct. If insufficient memory is available a null pointer is returned and the error handler is invoked with an error code of Value::NoMem.

pub fn init(&mut self, h: &Histogram2D) -> Value

This function initializes the two-dimensional probability distribution calculated p from the histogram h. If any of the bins of h are negative then the error handler is invoked with an error code of GSL_EDOM because a probability distribution cannot contain negative values.

pub fn sample(&self, r1: f64, r2: f64) -> (Value, f64, f64)

This function uses two uniform random numbers between zero and one, r1 and r2, to compute a single random sample from the two-dimensional probability distribution p.

Returns (Value, x, y).

Trait Implementations

impl Drop for Histogram2DPdf

fn drop(&mut self)

Executes the destructor for this type.