Top |
NcmVParam * | ncm_vparam_new () |
NcmVParam * | ncm_vparam_full_new () |
NcmVParam * | ncm_vparam_ref () |
NcmVParam * | ncm_vparam_copy () |
void | ncm_vparam_free () |
void | ncm_vparam_clear () |
void | ncm_vparam_set_len () |
guint | ncm_vparam_get_len () |
void | ncm_vparam_set_sparam () |
void | ncm_vparam_set_sparam_full () |
NcmSParam * | ncm_vparam_peek_sparam () |
NcmSParam * | ncm_vparam_get_sparam () |
void | ncm_vparam_set_lower_bound () |
void | ncm_vparam_set_upper_bound () |
void | ncm_vparam_set_scale () |
void | ncm_vparam_set_absolute_tolerance () |
void | ncm_vparam_set_default_value () |
void | ncm_vparam_set_fit_type () |
const gchar * | ncm_vparam_name () |
const gchar * | ncm_vparam_symbol () |
gdouble | ncm_vparam_get_lower_bound () |
gdouble | ncm_vparam_get_upper_bound () |
gdouble | ncm_vparam_get_scale () |
gdouble | ncm_vparam_get_absolute_tolerance () |
gdouble | ncm_vparam_get_default_value () |
NcmParamType | ncm_vparam_get_fit_type () |
guint | ncm_vparam_len () |
guint | default-len | Read / Write / Construct Only |
NcmSParam * | default-sparam | Read / Write / Construct Only |
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.
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.
NcmVParam * ncm_vparam_full_new (guint len
,const gchar *name
,const 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.
len |
vector length. |
|
name |
||
symbol |
||
lower_bound |
value of “lower-bound”. |
|
upper_bound |
value of “upper-bound”. |
|
scale |
value of “scale”. |
|
abstol |
value of “absolute-tolerance”. |
|
default_val |
value of “default-value”. |
|
ftype |
a NcmParamType. |
NcmVParam *
ncm_vparam_ref (NcmVParam *vparam
);
Increases the reference count of vparam
by one.
NcmVParam *
ncm_vparam_copy (NcmVParam *vparam
);
Duplicates the NcmVParam object setting the same values of the original propertities.
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.
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.
void ncm_vparam_set_len (NcmVParam *vparam
,guint len
);
Sets the length of vparam
to len
.
void ncm_vparam_set_sparam (NcmVParam *vparam
,guint n
,NcmSParam *spn
);
Sets the NcmSParam associated with the n
-th component of NcmVParam.
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.
vparam |
a NcmVParam. |
|
n |
vector index. |
|
name |
||
symbol |
||
lower_bound |
value of “lower-bound”. |
|
upper_bound |
value of “upper-bound”. |
|
scale |
value of “scale”. |
|
abstol |
value of “absolute-tolerance”. |
|
default_val |
value of “default-value”. |
|
ftype |
a NcmParamType. |
NcmSParam * ncm_vparam_peek_sparam (const NcmVParam *vparam
,guint n
);
This function does not increment the reference count of NcmSParam.
NcmSParam * ncm_vparam_get_sparam (NcmVParam *vparam
,guint n
);
This function returns the n
-th component of vparam
increasing its reference count.
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
.
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
.
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
.
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
.
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
.
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
.
const gchar *
ncm_vparam_name (const NcmVParam *vparam
);
Gets the vparam
base name.
const gchar *
ncm_vparam_symbol (const NcmVParam *vparam
);
Gets the vparam
base symbol.
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_absolute_tolerance (const NcmVParam *vparam
,guint n
);
gdouble ncm_vparam_get_default_value (const NcmVParam *vparam
,guint n
);
“default-len”
property “default-len” guint
Default length of the vector.
Owner: NcmVParam
Flags: Read / Write / Construct Only
Allowed values: >= 1
Default value: 1
“default-sparam”
property“default-sparam” NcmSParam *
Default sparam for the vector components.
Owner: NcmVParam
Flags: Read / Write / Construct Only