NcmPriorGaussParam: NumCosmo Reference Manual

NcmPriorGaussParam

NcmPriorGaussParam — a gaussian prior on a parameter

Functions

NcmPriorGaussParam *	ncm_prior_gauss_param_new ()
NcmPriorGaussParam *	ncm_prior_gauss_param_new_name ()
NcmPriorGaussParam *	ncm_prior_gauss_param_ref ()
void	ncm_prior_gauss_param_free ()
void	ncm_prior_gauss_param_clear ()
void	ncm_prior_gauss_param_set_model_ns ()
void	ncm_prior_gauss_param_set_stack_pos ()
void	ncm_prior_gauss_param_set_param_name ()
const gchar *	ncm_prior_gauss_param_peek_model_ns ()
const gchar *	ncm_prior_gauss_param_peek_param_name ()
guint	ncm_prior_gauss_param_get_stack_pos ()

Properties

char *	model-ns	Read / Write / Construct
char *	parameter-name	Read / Write / Construct
guint	stack-pos	Read / Write / Construct

Types and Values

#define	NCM_TYPE_PRIOR_GAUSS_PARAM
	NcmPriorGaussParam

Object Hierarchy

    GObject
    ╰── NcmMSetFunc
        ╰── NcmPrior
            ╰── NcmPriorGauss
                ╰── NcmPriorGaussParam

Description

This object is a subclass of NcmPriorGauss, precisely designed for a Gaussian prior on a parameter. The prior relies on a parameter ID and user-specified mean and standard deviation parameters.

Users have flexibility in specifying the parameter in various ways:

Using the pair NcmModelID and the parameter pid.
Providing a single NcmMSetPIndex.
Supplying a string consisting of a parameter full name "model:parameter".

These options provide versatile and convenient methods for parameter identification.

Functions

ncm_prior_gauss_param_new ()

NcmPriorGaussParam *
ncm_prior_gauss_param_new (NcmModel *model,
                           guint pid,
                           gdouble mu,
                           gdouble sigma);

Creates a new Gaussian prior for parameter pid of model .

Parameters

model	a NcmModel
pid	parameter id
mu	mean
sigma	standard deviation

Returns

pgp .

[transfer full]

ncm_prior_gauss_param_new_name ()

NcmPriorGaussParam *
ncm_prior_gauss_param_new_name (const gchar *name,
                                gdouble mu,
                                gdouble sigma);

Creates a new Gaussian prior for parameter named name in mset . See ncm_mset_split_full_name() for details on the parameter name format.

Parameters

name	parameter name
mu	mean
sigma	standard deviation

Returns

pgp .

[transfer full]

ncm_prior_gauss_param_ref ()

NcmPriorGaussParam *
ncm_prior_gauss_param_ref (NcmPriorGaussParam *pgp);

Increases the reference count of pgp atomically.

Parameters

pgp

a NcmPriorGaussParam

Returns

pgp .

[transfer full]

ncm_prior_gauss_param_free ()

void
ncm_prior_gauss_param_free (NcmPriorGaussParam *pgp);

Decreases the reference count of pgp atomically.

Parameters

pgp

a NcmPriorGaussParam

ncm_prior_gauss_param_clear ()

void
ncm_prior_gauss_param_clear (NcmPriorGaussParam **pgp);

Decreases the reference count of *pgp and sets *pgp to NULL.

Parameters

pgp

a NcmPriorGaussParam

ncm_prior_gauss_param_set_model_ns ()

void
ncm_prior_gauss_param_set_model_ns (NcmPriorGaussParam *pgp,
                                    const gchar *model_ns);

Sets the model namespace of pgp to model_ns .

Parameters

pgp	a NcmPriorGaussParam
model_ns	model namespace

ncm_prior_gauss_param_set_stack_pos ()

void
ncm_prior_gauss_param_set_stack_pos (NcmPriorGaussParam *pgp,
                                     guint stack_pos);

Sets the stack position of pgp to stack_pos .

Parameters

pgp	a NcmPriorGaussParam
stack_pos	stack position

ncm_prior_gauss_param_set_param_name ()

void
ncm_prior_gauss_param_set_param_name (NcmPriorGaussParam *pgp,
                                      const gchar *param_name);

Sets the parameter name of pgp to param_name .

Parameters

pgp	a NcmPriorGaussParam
param_name	parameter name

ncm_prior_gauss_param_peek_model_ns ()

const gchar *
ncm_prior_gauss_param_peek_model_ns (NcmPriorGaussParam *pgp);

Parameters

pgp

a NcmPriorGaussParam

Returns

the model namespace of pgp .

[transfer none]

ncm_prior_gauss_param_peek_param_name ()

const gchar *
ncm_prior_gauss_param_peek_param_name (NcmPriorGaussParam *pgp);

Parameters

pgp

a NcmPriorGaussParam

Returns

the parameter name of pgp .

[transfer none]

ncm_prior_gauss_param_get_stack_pos ()

guint
ncm_prior_gauss_param_get_stack_pos (NcmPriorGaussParam *pgp);

Gets the stack position of the parameter.

Parameters

pgp

a NcmPriorGaussParam

Returns

the stack position of pgp .

Types and Values

NCM_TYPE_PRIOR_GAUSS_PARAM

#define NCM_TYPE_PRIOR_GAUSS_PARAM (ncm_prior_gauss_param_get_type ())