NcmPriorFlatParam: NumCosmo Reference Manual

NcmPriorFlatParam

NcmPriorFlatParam — a flat prior on a sampling parameter.

Functions

NcmPriorFlatParam *	ncm_prior_flat_param_new ()
NcmPriorFlatParam *	ncm_prior_flat_param_new_name ()
NcmPriorFlatParam *	ncm_prior_flat_param_ref ()
void	ncm_prior_flat_param_free ()
void	ncm_prior_flat_param_clear ()
void	ncm_prior_flat_param_set_model_ns ()
void	ncm_prior_flat_param_set_stack_pos ()
void	ncm_prior_flat_param_set_param_name ()
const gchar *	ncm_prior_flat_param_peek_model_ns ()
const gchar *	ncm_prior_flat_param_peek_param_name ()
guint	ncm_prior_flat_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_FLAT_PARAM
	NcmPriorFlatParam

Object Hierarchy

    GObject
    ╰── NcmMSetFunc
        ╰── NcmPrior
            ╰── NcmPriorFlat
                ╰── NcmPriorFlatParam

Description

This object is a subclass of NcmPriorFlat, tailored for defining a flat prior on a sampling parameter. The prior is uniquely identified by the sampling parameter ID and is characterized by user-specified lower and upper limits, along with the scale of the prior.

Users enjoy the flexibility to specify 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 offer diverse and convenient ways for parameter identification.

Functions

ncm_prior_flat_param_new ()

NcmPriorFlatParam *
ncm_prior_flat_param_new (NcmModel *model,
                          guint pid,
                          gdouble x_low,
                          gdouble x_upp,
                          gdouble scale);

Creates a new Flat prior for parameter pid of model .

Parameters

model	a NcmModel
pid	parameter id
x_low	parameter lower limit
x_upp	parameter upper limit
scale	parameter scale

Returns

pfp .

[transfer full]

ncm_prior_flat_param_new_name ()

NcmPriorFlatParam *
ncm_prior_flat_param_new_name (const gchar *name,
                               gdouble x_low,
                               gdouble x_upp,
                               gdouble scale);

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

Parameters

name	parameter name
x_low	parameter lower limit
x_upp	parameter upper limit
scale	parameter scale

Returns

pfp .

[transfer full]

ncm_prior_flat_param_ref ()

NcmPriorFlatParam *
ncm_prior_flat_param_ref (NcmPriorFlatParam *pfp);

Increases the reference count of pfp atomically.

Parameters

pfp

a NcmPriorFlatParam

Returns

pfp .

[transfer full]

ncm_prior_flat_param_free ()

void
ncm_prior_flat_param_free (NcmPriorFlatParam *pfp);

Decreases the reference count of pfp atomically.

Parameters

pfp

a NcmPriorFlatParam

ncm_prior_flat_param_clear ()

void
ncm_prior_flat_param_clear (NcmPriorFlatParam **pfp);

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

Parameters

pfp

a NcmPriorFlatParam

ncm_prior_flat_param_set_model_ns ()

void
ncm_prior_flat_param_set_model_ns (NcmPriorFlatParam *pfp,
                                   const gchar *model_ns);

Sets the model namespace of pfp to model_ns .

Parameters

pfp	a NcmPriorFlatParam
model_ns	model namespace

ncm_prior_flat_param_set_stack_pos ()

void
ncm_prior_flat_param_set_stack_pos (NcmPriorFlatParam *pfp,
                                    guint stack_pos);

Sets the stack position of pfp to stack_pos .

Parameters

pfp	a NcmPriorFlatParam
stack_pos	stack position

ncm_prior_flat_param_set_param_name ()

void
ncm_prior_flat_param_set_param_name (NcmPriorFlatParam *pfp,
                                     const gchar *param_name);

Sets the parameter name of pfp to param_name .

Parameters

pfp	a NcmPriorFlatParam
param_name	parameter name

ncm_prior_flat_param_peek_model_ns ()

const gchar *
ncm_prior_flat_param_peek_model_ns (NcmPriorFlatParam *pfp);

Parameters

pfp

a NcmPriorFlatParam

Returns

the model namespace of pfp .

[transfer none]

ncm_prior_flat_param_peek_param_name ()

const gchar *
ncm_prior_flat_param_peek_param_name (NcmPriorFlatParam *pfp);

Parameters

pfp

a NcmPriorFlatParam

Returns

the parameter name of pfp .

[transfer none]

ncm_prior_flat_param_get_stack_pos ()

guint
ncm_prior_flat_param_get_stack_pos (NcmPriorFlatParam *pfp);

Gets the stack position of the parameter.

Parameters

pfp

a NcmPriorFlatParam

Returns

the stack position of pfp .

Types and Values

NCM_TYPE_PRIOR_FLAT_PARAM

#define NCM_TYPE_PRIOR_FLAT_PARAM (ncm_prior_flat_param_get_type ())