Class
NumCosmoMathMSetFunc
Description [src]
abstract class NumCosmoMath.MSetFunc : GObject.Object
{
/* No available fields */
}
Abstract class for arbitrary MSet functions.
This abstract class provides a framework for functions that operate on any model
in a NcmMSet and additional extra variables. It establishes methods to
inquire about the function’s expectations and characteristics.
The functions implemented by subclasses may depend on any model specified by
NcmMSet and may incorporate extra variables. The method
ncm_mset_func_get_nvar() retrieves the count of extra variables expected
by the function, and ncm_mset_func_get_dim() returns the number of values
returned by the function.
Functions can be categorized as scalar or vectorial. A scalar function returns
a single value, while a vectorial function returns an array of values. The
method ncm_mset_func_is_scalar() returns TRUE if the function is scalar.
Functions
ncm_mset_func_clear
If func is not NULL, decreases the reference count of func by one
and sets func to NULL.
Instance methods
ncm_mset_func_eval0
Evaluate the function func and return the result. This
function is only valid if func is a scalar function.
The function’s arguments are either none, if the function is constant,
or the arguments passed to ncm_mset_func_set_eval_x().
ncm_mset_func_eval1
Evaluate the function func at x and return the result. This
function is only valid if func is a scalar function.
ncm_mset_func_eval_nvar
Evaluate the function func at x and return the result. This
function is only valid if func is a scalar function.
ncm_mset_func_eval_vector
Compute the function func at x_v and store the result in res_v. This function is
only valid if func is a vectorial function.
ncm_mset_func_free
Decreases the reference count of func by one. If the reference count
reaches zero, func is freed.
ncm_mset_func_numdiff_fparams
Computes the gradient of func at x and stores the result in out.
This function is only valid if func is a scalar function.
ncm_mset_func_set_eval_x
Sets the function’s arguments to x. Once this function is called, the
function’s arguments are fixed and func becomes a constant function.
ncm_mset_func_set_meta
Sets the function’s metadata. This function is called by subclasses’ to set the function’s metadata. It should not be called by users.
Signals
Signals inherited from GObject (1)
GObject::notify
The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.
Class structure
struct NumCosmoMathMSetFuncClass {
/* no available fields */
}
No description available.