Top |
NcmSParam * | ncm_sparam_new () |
NcmSParam * | ncm_sparam_copy () |
NcmSParam * | ncm_sparam_ref () |
void | ncm_sparam_free () |
void | ncm_sparam_clear () |
void | ncm_sparam_set_lower_bound () |
void | ncm_sparam_set_upper_bound () |
void | ncm_sparam_set_scale () |
void | ncm_sparam_set_absolute_tolerance () |
void | ncm_sparam_set_default_value () |
void | ncm_sparam_set_fit_type () |
void | ncm_sparam_take_name () |
void | ncm_sparam_take_symbol () |
const gchar * | ncm_sparam_name () |
const gchar * | ncm_sparam_symbol () |
gdouble | ncm_sparam_get_lower_bound () |
gdouble | ncm_sparam_get_upper_bound () |
gdouble | ncm_sparam_get_scale () |
gdouble | ncm_sparam_get_absolute_tolerance () |
gdouble | ncm_sparam_get_default_value () |
NcmParamType | ncm_sparam_get_fit_type () |
double | absolute-tolerance | Read / Write |
double | default-value | Read / Write |
NcmParamType | fit-type | Read / Write |
double | lower-bound | Read / Write |
char * | name | Read / Write / Construct Only |
double | scale | Read / Write |
char * | symbol | Read / Write / Construct |
double | upper-bound | Read / Write |
This object comprises the necessary properties to define a scalar parameter. It is used by NcmModel to store the description of the scalar model parameters.
NcmSParam * ncm_sparam_new (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 NcmSParam 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.
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 |
NcmSParam *
ncm_sparam_copy (NcmSParam *sparam
);
Duplicates the NcmSParam object setting the same values of the original propertities.
NcmSParam *
ncm_sparam_ref (NcmSParam *sparam
);
Atomically increases the reference count of sparam
by one.
void
ncm_sparam_free (NcmSParam *sparam
);
Atomically decrements the reference count of sparam
by one. If the reference count drops to 0,
all memory allocated by sparam
is released.
void
ncm_sparam_clear (NcmSParam **sparam
);
Atomically decrements the reference count of sparam
by one. If the reference count drops to 0,
all memory allocated by sparam
is released. Set the pointer to NULL.
void ncm_sparam_set_lower_bound (NcmSParam *sparam
,const gdouble lb
);
Sets the value lb
to the “lower-bound” property.
void ncm_sparam_set_upper_bound (NcmSParam *sparam
,const gdouble ub
);
Sets the value ub
to the “upper-bound” property.
void ncm_sparam_set_scale (NcmSParam *sparam
,const gdouble scale
);
Sets the value scale
to the “scale” property.
void ncm_sparam_set_absolute_tolerance (NcmSParam *sparam
,const gdouble abstol
);
Sets the value abstol
to the “absolute-tolerance” property.
void ncm_sparam_set_default_value (NcmSParam *sparam
,const gdouble default_val
);
Sets the value default_val
to the “default-value” property.
void ncm_sparam_set_fit_type (NcmSParam *sparam
,const NcmParamType ftype
);
Sets the value ftype
to the “fit-type” property.
void ncm_sparam_take_name (NcmSParam *sparam
,gchar *name
);
Takes name
as the name string.
The caller doesn't have to free it any more.
void ncm_sparam_take_symbol (NcmSParam *sparam
,gchar *symbol
);
Takes symbol
as the symbol string.
The caller doesn't have to free it any more.
gdouble
ncm_sparam_get_absolute_tolerance (const NcmSParam *sparam
);
NcmParamType indicates if the parameter must be fitted, NCM_PARAM_TYPE_FREE
,
or if it remains fixed, NCM_PARAM_TYPE_FIXED
, when a statistical analysis is
carried out.
“absolute-tolerance”
property “absolute-tolerance” double
Absolute tolerance, whose value is restricted to [0, G_MAXDOUBLE], is the size of the error used by NcmFit.
Owner: NcmSParam
Flags: Read / Write
Allowed values: >= 0
Default value: 0
“default-value”
property “default-value” double
Parameter's default value.
Owner: NcmSParam
Flags: Read / Write
Default value: 0
“fit-type”
property“fit-type” NcmParamType
Parameter's fit type: FIXED or FREE.
Owner: NcmSParam
Flags: Read / Write
Default value: NCM_PARAM_TYPE_FREE
“lower-bound”
property “lower-bound” double
Lower parameter threshold whose value is restricted to [-G_MAXDOUBLE, G_MAXDOUBLE].
Owner: NcmSParam
Flags: Read / Write
Default value: 0
“name”
property “name” char *
The parameter' s name must be a string written using only ASCII and -.
Owner: NcmSParam
Flags: Read / Write / Construct Only
Default value: NULL
“scale”
property “scale” double
Scale, whose value is restricted to [0, G_MAXDOUBLE], is the step used by NcmFit to increment the value of the parameter.
Owner: NcmSParam
Flags: Read / Write
Allowed values: >= 0
Default value: 0
“symbol”
property “symbol” char *
Parameter's name written in a usual form (including latex).
Owner: NcmSParam
Flags: Read / Write / Construct
Default value: NULL