![]() |
![]() |
![]() |
NumCosmo Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy | Properties |
Model Vector Parameter DescriptionModel Vector Parameter Description — Describes the properties of a vector parameter |
Synopsis
struct NcmVParamClass; struct NcmVParam; NcmVParam * ncm_vparam_new (guint len
,NcmSParam *default_param
); NcmVParam * ncm_vparam_full_new (guint len
,gchar *name
,gchar *symbol
,gdouble lower_bound
,gdouble upper_bound
,gdouble scale
,gdouble abstol
,gdouble default_val
,NcmParamType ftype
); NcmVParam * ncm_vparam_copy (NcmVParam *vparam
); void ncm_vparam_free (NcmVParam *vparam
); void ncm_vparam_clear (NcmVParam **vparam
); void ncm_vparam_set_len (NcmVParam *vparam
,guint len
); guint ncm_vparam_get_len (NcmVParam *vparam
); void ncm_vparam_set_sparam (NcmVParam *vparam
,guint n
,NcmSParam *spn
); void ncm_vparam_set_sparam_full (NcmVParam *vparam
,guint n
,gchar *name
,gchar *symbol
,gdouble lower_bound
,gdouble upper_bound
,gdouble scale
,gdouble abstol
,gdouble default_val
,NcmParamType ftype
); NcmSParam * ncm_vparam_peek_sparam (const NcmVParam *vparam
,guint n
); NcmSParam * ncm_vparam_get_sparam (NcmVParam *vparam
,guint n
); void ncm_vparam_set_lower_bound (NcmVParam *vparam
,guint n
,const gdouble lb
); void ncm_vparam_set_upper_bound (NcmVParam *vparam
,guint n
,const gdouble ub
); void ncm_vparam_set_scale (NcmVParam *vparam
,guint n
,const gdouble scale
); void ncm_vparam_set_absolute_tolerance (NcmVParam *vparam
,guint n
,const gdouble abstol
); void ncm_vparam_set_default_value (NcmVParam *vparam
,guint n
,const gdouble default_val
); void ncm_vparam_set_fit_type (NcmVParam *vparam
,guint n
,const NcmParamType ftype
); gdouble ncm_vparam_get_lower_bound (const NcmVParam *vparam
,guint n
); gdouble ncm_vparam_get_upper_bound (const NcmVParam *vparam
,guint n
); gdouble ncm_vparam_get_scale (const NcmVParam *vparam
,guint n
); gdouble ncm_vparam_get_absolute_tolerance (const NcmVParam *vparam
,guint n
); gdouble ncm_vparam_get_default_value (const NcmVParam *vparam
,guint n
); NcmParamType ncm_vparam_get_fit_type (const NcmVParam *vparam
,guint n
);
Description
This object comprises the necessary properties to define a vector parameter. It is used by NcmModel to store the description of the vector model parameters.
Details
ncm_vparam_new ()
NcmVParam * ncm_vparam_new (guint len
,NcmSParam *default_param
);
This function allocates memory for a new NcmVParam object and sets its properties to the values from
the input arguments. len
provides the number of components.
ncm_vparam_full_new ()
NcmVParam * ncm_vparam_full_new (guint len
,gchar *name
,gchar *symbol
,gdouble lower_bound
,gdouble upper_bound
,gdouble scale
,gdouble abstol
,gdouble default_val
,NcmParamType ftype
);
This function allocates memory for a new NcmVParam object and sets its properties to the values from the input arguments.
The name
parameter is restricted to the interval [lower_bound
, upper_bound
].
scale
is an initial step for the statistical algorithms.
abstol
is the absolute error tolerance of the parameter.
ftype
indicates if the parameter will be fitted or not.
|
vector length. |
|
"name". |
|
"symbol". |
|
value of "lower-bound". |
|
value of "upper-bound". |
|
value of "scale". |
|
value of "absolute-tolerance". |
|
value of "default-value". |
|
a NcmParamType. |
Returns : |
A new NcmVParam. |
ncm_vparam_copy ()
NcmVParam * ncm_vparam_copy (NcmVParam *vparam
);
Duplicates the NcmVParam object setting the same values of the original propertities.
ncm_vparam_free ()
void ncm_vparam_free (NcmVParam *vparam
);
Atomically decrements the reference count of vparam
by one. If the reference count drops to 0,
all memory allocated by vparam
is released.
|
a NcmVParam. |
ncm_vparam_clear ()
void ncm_vparam_clear (NcmVParam **vparam
);
Atomically decrements the reference count of vparam
by one. If the reference count drops to 0,
all memory allocated by vparam
is released.
|
a NcmVParam. |
ncm_vparam_set_len ()
void ncm_vparam_set_len (NcmVParam *vparam
,guint len
);
Sets the length of vparam
to len
.
ncm_vparam_get_len ()
guint ncm_vparam_get_len (NcmVParam *vparam
);
|
a NcmVParam. |
Returns : |
The length of vparam . |
ncm_vparam_set_sparam ()
void ncm_vparam_set_sparam (NcmVParam *vparam
,guint n
,NcmSParam *spn
);
Sets the NcmSParam associated with the n
-th component of NcmVParam.
ncm_vparam_set_sparam_full ()
void ncm_vparam_set_sparam_full (NcmVParam *vparam
,guint n
,gchar *name
,gchar *symbol
,gdouble lower_bound
,gdouble upper_bound
,gdouble scale
,gdouble abstol
,gdouble default_val
,NcmParamType ftype
);
This function sets the properties of the n
-th vparam
component.
|
a NcmVParam. |
|
vector index. |
|
"name". |
|
"symbol". |
|
value of "lower-bound". |
|
value of "upper-bound". |
|
value of "scale". |
|
value of "absolute-tolerance". |
|
value of "default-value". |
|
a NcmParamType. |
ncm_vparam_peek_sparam ()
NcmSParam * ncm_vparam_peek_sparam (const NcmVParam *vparam
,guint n
);
This function does not increment the reference count of NcmSParam.
ncm_vparam_get_sparam ()
NcmSParam * ncm_vparam_get_sparam (NcmVParam *vparam
,guint n
);
This function returns the n
-th component of vparam
increasing its reference count.
ncm_vparam_set_lower_bound ()
void ncm_vparam_set_lower_bound (NcmVParam *vparam
,guint n
,const gdouble lb
);
Sets the value lb
to the "lower-bound" property of the n
-th component of vparam
.
|
a NcmVParam. |
|
vector index. |
|
value of "lower-bound". |
ncm_vparam_set_upper_bound ()
void ncm_vparam_set_upper_bound (NcmVParam *vparam
,guint n
,const gdouble ub
);
Sets the value ub
to the "upper-bound" property of the n
-th component of vparam
.
|
a NcmVParam. |
|
vector index. |
|
value of "upper-bound". |
ncm_vparam_set_scale ()
void ncm_vparam_set_scale (NcmVParam *vparam
,guint n
,const gdouble scale
);
Sets the value scale
to the "scale" property of the n
-th component of vparam
.
ncm_vparam_set_absolute_tolerance ()
void ncm_vparam_set_absolute_tolerance (NcmVParam *vparam
,guint n
,const gdouble abstol
);
Sets the value abstol
to the "absolute-tolerance" property of the n
-th component of vparam
.
|
a NcmVParam. |
|
vector index. |
|
value of "absolute-tolerance". |
ncm_vparam_set_default_value ()
void ncm_vparam_set_default_value (NcmVParam *vparam
,guint n
,const gdouble default_val
);
Sets the value default_val
to the "default-value" property of the n
-th component of vparam
.
|
a NcmVParam. |
|
vector index. |
|
value of "default-value". |
ncm_vparam_set_fit_type ()
void ncm_vparam_set_fit_type (NcmVParam *vparam
,guint n
,const NcmParamType ftype
);
Sets ftype
to the "fit-type" property of the n
-th component of vparam
.
|
a NcmVParam. |
|
vector index. |
|
a NcmParamType. |
ncm_vparam_get_lower_bound ()
gdouble ncm_vparam_get_lower_bound (const NcmVParam *vparam
,guint n
);
|
a NcmVParam. |
|
vector index. |
Returns : |
The value of "lower-bound" property of the n -th component of vparam . |
ncm_vparam_get_upper_bound ()
gdouble ncm_vparam_get_upper_bound (const NcmVParam *vparam
,guint n
);
|
a NcmVParam. |
|
vector index. |
Returns : |
The value of "upper-bound" property of the n -th component of vparam . |
ncm_vparam_get_absolute_tolerance ()
gdouble ncm_vparam_get_absolute_tolerance (const NcmVParam *vparam
,guint n
);
|
a NcmVParam. |
|
vector index. |
Returns : |
The value of "absolute-tolerance" property of the n -th component of vparam . |
ncm_vparam_get_default_value ()
gdouble ncm_vparam_get_default_value (const NcmVParam *vparam
,guint n
);
|
a NcmVParam. |
|
vector index. |
Returns : |
The value of "default-value" property of the n -th component of vparam . |
ncm_vparam_get_fit_type ()
NcmParamType ncm_vparam_get_fit_type (const NcmVParam *vparam
,guint n
);
|
a NcmVParam. |
|
vector index. |
Returns : |
The value of "fit-type" property of the n -th component of vparam . |
Property Details
The "default-sparam"
property
"default-sparam" NcmSParam* : Read / Write / Construct Only
Default sparam for the vector components.