NcmStatsDist2d: NumCosmo Reference Manual

NcmStatsDist2d

NcmStatsDist2d — Abstract class for implementing two-dimensional probability distributions

Functions

NcmStatsDist2d *	ncm_stats_dist2d_ref ()
void	ncm_stats_dist2d_free ()
void	ncm_stats_dist2d_clear ()
void	ncm_stats_dist2d_prepare ()
void	ncm_stats_dist2d_xbounds ()
void	ncm_stats_dist2d_ybounds ()
gdouble	ncm_stats_dist2d_eval_pdf ()
gdouble	ncm_stats_dist2d_eval_m2lnp ()
gdouble	ncm_stats_dist2d_eval_cdf ()
gdouble	ncm_stats_dist2d_eval_marginal_pdf ()
gdouble	ncm_stats_dist2d_eval_marginal_cdf ()
gdouble	ncm_stats_dist2d_eval_marginal_inv_cdf ()
gdouble	ncm_stats_dist2d_eval_inv_cond ()

Types and Values

#define	NCM_TYPE_STATS_DIST2D
struct	NcmStatsDist2dClass
	NcmStatsDist2d

Object Hierarchy

    GObject
    ╰── NcmStatsDist2d
        ╰── NcmStatsDist2dSpline

Description

Abstract class to reconstruct an arbitrary two-dimensional probability distribution.

Functions

ncm_stats_dist2d_ref ()

NcmStatsDist2d *
ncm_stats_dist2d_ref (NcmStatsDist2d *sd2);

Increases the reference count of sd2 .

Parameters

sd2

a NcmStatsDist2d

Returns

sd2 .

[transfer full]

ncm_stats_dist2d_free ()

void
ncm_stats_dist2d_free (NcmStatsDist2d *sd2);

Decreases the reference count of sd2 .

Parameters

sd2

a NcmStatsDist2d

ncm_stats_dist2d_clear ()

void
ncm_stats_dist2d_clear (NcmStatsDist2d **sd2);

Decreases the reference count of *sd2 and sets the pointer *sd2 to NULL.

Parameters

sd2

a NcmStatsDist2d

ncm_stats_dist2d_prepare ()

void
ncm_stats_dist2d_prepare (NcmStatsDist2d *sd2);

Prepares the object for calculations.

[virtual prepare]

Parameters

sd2

a NcmStatsDist2d

ncm_stats_dist2d_xbounds ()

void
ncm_stats_dist2d_xbounds (NcmStatsDist2d *sd2,
                          gdouble *xi,
                          gdouble *xf);

Gets the x bounds of the distribution.

[virtual xbounds]

Parameters

sd2	a NcmStatsDist2d
xi	x lower bound.	[out]
xf	x upper bound.	[out]

ncm_stats_dist2d_ybounds ()

void
ncm_stats_dist2d_ybounds (NcmStatsDist2d *sd2,
                          gdouble *yi,
                          gdouble *yf);

Gets the y bounds of the distribution.

[virtual ybounds]

Parameters

sd2	a NcmStatsDist2d
yi	y lower bound.	[out]
yf	y upper bound.	[out]

ncm_stats_dist2d_eval_pdf ()

gdouble
ncm_stats_dist2d_eval_pdf (NcmStatsDist2d *sd2,
                           const gdouble x,
                           const gdouble y);

Calculates the value of the probability density function (PDF) at x and y .

[virtual pdf]

Parameters

sd2	a NcmStatsDist2d
x	random variable value
y	random variable value

Returns

the PDF value at x and y

ncm_stats_dist2d_eval_m2lnp ()

gdouble
ncm_stats_dist2d_eval_m2lnp (NcmStatsDist2d *sd2,
                             const gdouble x,
                             const gdouble y);

Calculates the value of the $-2\ln(p(x, y))$ for the probability density function.

[virtual m2lnp]

Parameters

sd2	a NcmStatsDist2d
x	random variable value
y	random variable value

Returns

the value of $-2\ln(p(x, y))$.

ncm_stats_dist2d_eval_cdf ()

gdouble
ncm_stats_dist2d_eval_cdf (NcmStatsDist2d *sd2,
                           const gdouble x,
                           const gdouble y);

Calculates the value of the cumulative distribution function (CDF) within [x_i, x ] and [y_i, y ].

[virtual cdf]

Parameters

sd2	a NcmStatsDist2d
x	random variable value
y	random variable value

Returns

the CDF value given the intervals [x_i, x ] and [y_i, y ]

ncm_stats_dist2d_eval_marginal_pdf ()

gdouble
ncm_stats_dist2d_eval_marginal_pdf (NcmStatsDist2d *sd2,
                                    const gdouble xy);

Evaluates the marginal PDF at xy .

[virtual marginal_pdf]

Parameters

sd2	a NcmStatsDist2d
xy	x or y

Returns

the marginal PDF value at xy

ncm_stats_dist2d_eval_marginal_cdf ()

gdouble
ncm_stats_dist2d_eval_marginal_cdf (NcmStatsDist2d *sd2,
                                    const gdouble xy);

Evaluates the marginal CDF at xy .

[virtual marginal_pdf]

Parameters

sd2	a NcmStatsDist2d
xy	x or y

Returns

the marginal CDF value at xy

ncm_stats_dist2d_eval_marginal_inv_cdf ()

gdouble
ncm_stats_dist2d_eval_marginal_inv_cdf
                               (NcmStatsDist2d *sd2,
                                const gdouble xy);

ncm_stats_dist2d_eval_inv_cond ()

gdouble
ncm_stats_dist2d_eval_inv_cond (NcmStatsDist2d *sd2,
                                const gdouble u,
                                const gdouble xy);

Evaluates the inverse conditional CDF at u and xy .

[virtual inv_cond]

Parameters

sd2	a NcmStatsDist2d
u	a number between [0, 1]
xy	x or y

Returns

the inverse conditional CDF value at u and xy .

Types and Values

NCM_TYPE_STATS_DIST2D

#define NCM_TYPE_STATS_DIST2D (ncm_stats_dist2d_get_type ())

struct NcmStatsDist2dClass

struct NcmStatsDist2dClass {
};

NcmStatsDist2d

typedef struct _NcmStatsDist2d NcmStatsDist2d;