Generic Model Pure Virtual Class

Generic Model Pure Virtual Class — FIXME

Synopsis

#define             NCM_MODEL_FUNC0_IMPL                (NS_NAME,
                                                         NsName,
                                                         ns_name,
                                                         name)
#define             NCM_MODEL_FUNC1_IMPL                (NS_NAME,
                                                         NsName,
                                                         ns_name,
                                                         name)
#define             NCM_MODEL_SET_IMPL_FUNC             (NS_NAME,
                                                         NsName,
                                                         ns_name,
                                                         type,
                                                         name)
struct              NcmModel;
struct              NcmModelClass;
gdouble             (*NcmModelFunc0)                    (NcmModel *model);
gdouble             (*NcmModelFunc1)                    (NcmModel *model,
                                                         const gdouble x);
typedef             NcmModelID;
void                ncm_model_class_add_params          (NcmModelClass *model_class,
                                                         guint sparam_len,
                                                         guint vparam_len,
                                                         guint nonparam_prop_len);
void                ncm_model_class_check_params_info   (NcmModelClass *model_class);
void                ncm_model_class_get_property        (GObject *object,
                                                         guint prop_id,
                                                         GValue *value,
                                                         GParamSpec *pspec);
void                ncm_model_class_set_name_nick       (NcmModelClass *model_class,
                                                         const gchar *name,
                                                         const gchar *nick);
void                ncm_model_class_set_property        (GObject *object,
                                                         guint prop_id,
                                                         const GValue *value,
                                                         GParamSpec *pspec);
void                ncm_model_class_set_sparam          (NcmModelClass *model_class,
                                                         guint sparam_id,
                                                         gchar *symbol,
                                                         gchar *name,
                                                         gdouble lower_bound,
                                                         gdouble upper_bound,
                                                         gdouble scale,
                                                         gdouble abstol,
                                                         gdouble default_value,
                                                         NcmParamType ppt);
void                ncm_model_class_set_vparam          (NcmModelClass *model_class,
                                                         guint vparam_id,
                                                         guint default_length,
                                                         gchar *symbol,
                                                         gchar *name,
                                                         gdouble lower_bound,
                                                         gdouble upper_bound,
                                                         gdouble scale,
                                                         gdouble abstol,
                                                         gdouble default_value,
                                                         NcmParamType ppt);
NcmModel *          ncm_model_copy                      (NcmModel *model);
void                ncm_model_copyto                    (NcmModel *model,
                                                         NcmModel *model_dest);
void                ncm_model_free                      (NcmModel *model);
NcmModelID          ncm_model_id                        (NcmModel *model);
gulong              ncm_model_impl                      (NcmModel *model);
gboolean            ncm_model_is_equal                  (NcmModel *model1,
                                                         NcmModel *model2);
guint               ncm_model_len                       (NcmModel *model);
const gchar *       ncm_model_name                      (NcmModel *model);
const gchar *       ncm_model_nick                      (NcmModel *model);
gdouble             ncm_model_orig_param_get            (NcmModel *model,
                                                         guint n);
void                ncm_model_orig_param_set            (NcmModel *model,
                                                         guint n,
                                                         gdouble val);
void                ncm_model_orig_params_update        (NcmModel *model);
gdouble             ncm_model_orig_vparam_get           (NcmModel *model,
                                                         guint n,
                                                         guint i);
NcmVector *         ncm_model_orig_vparam_get_vector    (NcmModel *model,
                                                         guint n);
void                ncm_model_orig_vparam_set           (NcmModel *model,
                                                         guint n,
                                                         guint i,
                                                         gdouble val);
void                ncm_model_orig_vparam_set_vector    (NcmModel *model,
                                                         guint n,
                                                         NcmVector *val);
gboolean            ncm_model_param_finite              (NcmModel *model,
                                                         guint i);
gdouble             ncm_model_param_get                 (NcmModel *model,
                                                         guint n);
gdouble             ncm_model_param_get_abstol          (NcmModel *model,
                                                         guint n);
NcmParamType        ncm_model_param_get_ftype           (NcmModel *model,
                                                         guint n);
gdouble             ncm_model_param_get_lower_bound     (NcmModel *model,
                                                         guint n);
gdouble             ncm_model_param_get_scale           (NcmModel *model,
                                                         guint n);
gdouble             ncm_model_param_get_upper_bound     (NcmModel *model,
                                                         guint n);
guint               ncm_model_param_index_from_name     (NcmModel *model,
                                                         gchar *param_name);
const gchar *       ncm_model_param_name                (NcmModel *model,
                                                         guint n);
void                ncm_model_param_set                 (NcmModel *model,
                                                         guint n,
                                                         gdouble val);
void                ncm_model_param_set_abstol          (NcmModel *model,
                                                         guint n,
                                                         const gdouble abstol);
void                ncm_model_param_set_default         (NcmModel *model,
                                                         guint n);
void                ncm_model_param_set_ftype           (NcmModel *model,
                                                         guint n,
                                                         const NcmParamType ptype);
void                ncm_model_param_set_lower_bound     (NcmModel *model,
                                                         guint n,
                                                         const gdouble lb);
void                ncm_model_param_set_scale           (NcmModel *model,
                                                         guint n,
                                                         const gdouble scale);
void                ncm_model_param_set_upper_bound     (NcmModel *model,
                                                         guint n,
                                                         const gdouble ub);
const gchar *       ncm_model_param_symbol              (NcmModel *model,
                                                         guint n);
void                ncm_model_params_copyto             (NcmModel *model,
                                                         NcmModel *model_dest);
gboolean            ncm_model_params_finite             (NcmModel *model);
NcmVector *         ncm_model_params_get_all            (NcmModel *model);
void                ncm_model_params_log_all            (NcmModel *model);
void                ncm_model_params_print_all          (NcmModel *model,
                                                         FILE *out);
void                ncm_model_params_save_as_default    (NcmModel *model);
void                ncm_model_params_set_all            (NcmModel *model,
                                                         ...);
void                ncm_model_params_set_all_data       (NcmModel *model,
                                                         gdouble *data);
void                ncm_model_params_set_default        (NcmModel *model);
void                ncm_model_params_set_model          (NcmModel *model,
                                                         NcmModel *model_src);
void                ncm_model_params_set_vector         (NcmModel *model,
                                                         NcmVector *v);
void                ncm_model_params_update             (NcmModel *model);
NcmReparam *        ncm_model_peek_reparam              (NcmModel *model);
NcmModel *          ncm_model_ref                       (NcmModel *model);
void                ncm_model_register_id               (NcmModelClass *model_class);
void                ncm_model_reparam_J                 (NcmModel *model,
                                                         NcmMatrix *fJ,
                                                         NcmMatrix *J);
void                ncm_model_reparam_df                (NcmModel *model,
                                                         NcmVector *fv,
                                                         NcmVector *v);
void                ncm_model_set_reparam               (NcmModel *model,
                                                         NcmReparam *reparam);
guint               ncm_model_sparam_len                (NcmModel *model);
guint               ncm_model_vparam_array_len          (NcmModel *model);
guint               ncm_model_vparam_index              (NcmModel *model,
                                                         guint n,
                                                         guint i);
guint               ncm_model_vparam_len                (NcmModel *model,
                                                         guint n);

Object Hierarchy

  GObject
   +----NcmModel
         +----NcClusterMass
         +----NcHICosmo

Properties

  "implementation"           gulong                : Read
  "name"                     gchar*                : Read
  "nick"                     gchar*                : Read
  "params"                   NcmVector*            : Read
  "params-types"             GArray*               : Read
  "reparam"                  NcmReparam*           : Read / Write
  "scalar-params-len"        guint                 : Read
  "vector-params-len"        guint                 : Read

Description

FIXME

Details

NCM_MODEL_FUNC0_IMPL()

#define             NCM_MODEL_FUNC0_IMPL(NS_NAME,NsName,ns_name,name)

NCM_MODEL_FUNC1_IMPL()

#define             NCM_MODEL_FUNC1_IMPL(NS_NAME,NsName,ns_name,name)

NCM_MODEL_SET_IMPL_FUNC()

#define             NCM_MODEL_SET_IMPL_FUNC(NS_NAME,NsName,ns_name,type,name)

struct NcmModel

struct NcmModel;

Base class for models.


struct NcmModelClass

struct NcmModelClass {
};

NcmModelFunc0 ()

gdouble             (*NcmModelFunc0)                    (NcmModel *model);

NcmModelFunc1 ()

gdouble             (*NcmModelFunc1)                    (NcmModel *model,
                                                         const gdouble x);

NcmModelID

typedef gint NcmModelID;

ncm_model_class_add_params ()

void                ncm_model_class_add_params          (NcmModelClass *model_class,
                                                         guint sparam_len,
                                                         guint vparam_len,
                                                         guint nonparam_prop_len);

FIXME

model_class :

a NcmModelClass.

sparam_len :

FIXME

vparam_len :

FIXME

nonparam_prop_len :

FIXME

ncm_model_class_check_params_info ()

void                ncm_model_class_check_params_info   (NcmModelClass *model_class);

FIXME

model_class :

a NcmModelClass.

ncm_model_class_get_property ()

void                ncm_model_class_get_property        (GObject *object,
                                                         guint prop_id,
                                                         GValue *value,
                                                         GParamSpec *pspec);

FIXME

object :

a NcmModelClass.

prop_id :

FIXME

value :

FIXME

pspec :

FIXME

ncm_model_class_set_name_nick ()

void                ncm_model_class_set_name_nick       (NcmModelClass *model_class,
                                                         const gchar *name,
                                                         const gchar *nick);

FIXME

model_class :

a NcmModelClass.

name :

FIXME

nick :

FIXME

ncm_model_class_set_property ()

void                ncm_model_class_set_property        (GObject *object,
                                                         guint prop_id,
                                                         const GValue *value,
                                                         GParamSpec *pspec);

FIXME

object :

a NcmModelClass.

prop_id :

FIXME

value :

FIXME

pspec :

FIXME

ncm_model_class_set_sparam ()

void                ncm_model_class_set_sparam          (NcmModelClass *model_class,
                                                         guint sparam_id,
                                                         gchar *symbol,
                                                         gchar *name,
                                                         gdouble lower_bound,
                                                         gdouble upper_bound,
                                                         gdouble scale,
                                                         gdouble abstol,
                                                         gdouble default_value,
                                                         NcmParamType ppt);

FIXME

model_class :

a NcmModelClass.

sparam_id :

FIXME

symbol :

FIXME

name :

FIXME

lower_bound :

FIXME

upper_bound :

FIXME

scale :

FIXME

abstol :

FIXME

default_value :

FIXME

ppt :

FIXME

ncm_model_class_set_vparam ()

void                ncm_model_class_set_vparam          (NcmModelClass *model_class,
                                                         guint vparam_id,
                                                         guint default_length,
                                                         gchar *symbol,
                                                         gchar *name,
                                                         gdouble lower_bound,
                                                         gdouble upper_bound,
                                                         gdouble scale,
                                                         gdouble abstol,
                                                         gdouble default_value,
                                                         NcmParamType ppt);

FIXME

model_class :

a NcmModelClass

vparam_id :

FIXME

default_length :

FIXME

symbol :

FIXME

name :

FIXME

lower_bound :

FIXME

upper_bound :

FIXME

scale :

FIXME

abstol :

FIXME

default_value :

FIXME

ppt :

FIXME

ncm_model_copy ()

NcmModel *          ncm_model_copy                      (NcmModel *model);

FIXME

model :

a NcmModel.

Returns :

FIXME

ncm_model_copyto ()

void                ncm_model_copyto                    (NcmModel *model,
                                                         NcmModel *model_dest);

FIXME

model :

a NcmModel.

model_dest :

a NcmModel.

ncm_model_free ()

void                ncm_model_free                      (NcmModel *model);

Atomically decrements the reference count of model by one. If the reference count drops to 0, all memory allocated by model is released.

model :

a NcmModel.

ncm_model_id ()

NcmModelID          ncm_model_id                        (NcmModel *model);

FIXME

model :

a NcmModel

Returns :

FIXME

ncm_model_impl ()

gulong              ncm_model_impl                      (NcmModel *model);

FIXME

model :

a NcmModel

Returns :

FIXME

ncm_model_is_equal ()

gboolean            ncm_model_is_equal                  (NcmModel *model1,
                                                         NcmModel *model2);

Compares if model1 and model2 are the same, with same dimension and reparametrization.

model1 :

a NcmModel.

model2 :

a NcmModel.

ncm_model_len ()

guint               ncm_model_len                       (NcmModel *model);

FIXME

model :

a NcmModel

Returns :

FIXME

ncm_model_name ()

const gchar *       ncm_model_name                      (NcmModel *model);

FIXME

model :

a NcmModel

Returns :

FIXME. [transfer none]

ncm_model_nick ()

const gchar *       ncm_model_nick                      (NcmModel *model);

FIXME

model :

a NcmModel

Returns :

FIXME. [transfer none]

ncm_model_orig_param_get ()

gdouble             ncm_model_orig_param_get            (NcmModel *model,
                                                         guint n);

FIXME

model :

a NcmModel

n :

FIXME

Returns :

FIXME

ncm_model_orig_param_set ()

void                ncm_model_orig_param_set            (NcmModel *model,
                                                         guint n,
                                                         gdouble val);

FIXME

model :

a NcmModel

n :

FIXME

val :

FIXME

ncm_model_orig_params_update ()

void                ncm_model_orig_params_update        (NcmModel *model);

Update the new parameters. It causes an error to call this function with a model without reparametrization.

model :

a NcmModel

ncm_model_orig_vparam_get ()

gdouble             ncm_model_orig_vparam_get           (NcmModel *model,
                                                         guint n,
                                                         guint i);

ncm_model_orig_vparam_get_vector ()

NcmVector *         ncm_model_orig_vparam_get_vector    (NcmModel *model,
                                                         guint n);

FIXME

model :

a NcmModel

n :

FIXME

Returns :

FIXME. [transfer full]

ncm_model_orig_vparam_set ()

void                ncm_model_orig_vparam_set           (NcmModel *model,
                                                         guint n,
                                                         guint i,
                                                         gdouble val);

ncm_model_orig_vparam_set_vector ()

void                ncm_model_orig_vparam_set_vector    (NcmModel *model,
                                                         guint n,
                                                         NcmVector *val);

FIXME

model :

a NcmModel

n :

FIXME

val :

FIXME

ncm_model_param_finite ()

gboolean            ncm_model_param_finite              (NcmModel *model,
                                                         guint i);

FIXME

model :

a NcmModel

i :

FIXME

Returns :

FIXME

ncm_model_param_get ()

gdouble             ncm_model_param_get                 (NcmModel *model,
                                                         guint n);

FIXME

model :

a NcmModel

n :

FIXME

Returns :

FIXME

ncm_model_param_get_abstol ()

gdouble             ncm_model_param_get_abstol          (NcmModel *model,
                                                         guint n);

FIXME

model :

a NcmModel

n :

FIXME

Returns :

FIXME

ncm_model_param_get_ftype ()

NcmParamType        ncm_model_param_get_ftype           (NcmModel *model,
                                                         guint n);

FIXME

model :

a NcmModel

n :

FIXME

Returns :

FIXME

ncm_model_param_get_lower_bound ()

gdouble             ncm_model_param_get_lower_bound     (NcmModel *model,
                                                         guint n);

FIXME

model :

a NcmModel

n :

FIXME

Returns :

FIXME

ncm_model_param_get_scale ()

gdouble             ncm_model_param_get_scale           (NcmModel *model,
                                                         guint n);

FIXME

model :

a NcmModel

n :

FIXME

Returns :

FIXME

ncm_model_param_get_upper_bound ()

gdouble             ncm_model_param_get_upper_bound     (NcmModel *model,
                                                         guint n);

FIXME

model :

a NcmModel

n :

FIXME

Returns :

FIXME

ncm_model_param_index_from_name ()

guint               ncm_model_param_index_from_name     (NcmModel *model,
                                                         gchar *param_name);

model :

FIXME

param_name :

FIXME

Returns :

FIXME

ncm_model_param_name ()

const gchar *       ncm_model_param_name                (NcmModel *model,
                                                         guint n);

ncm_model_param_set ()

void                ncm_model_param_set                 (NcmModel *model,
                                                         guint n,
                                                         gdouble val);

FIXME

model :

a NcmModel

n :

FIXME

val :

FIXME

ncm_model_param_set_abstol ()

void                ncm_model_param_set_abstol          (NcmModel *model,
                                                         guint n,
                                                         const gdouble abstol);

FIXME

model :

a NcmModel

n :

FIXME

abstol :

FIXME

ncm_model_param_set_default ()

void                ncm_model_param_set_default         (NcmModel *model,
                                                         guint n);

FIXME

model :

a NcmModel

n :

FIXME

ncm_model_param_set_ftype ()

void                ncm_model_param_set_ftype           (NcmModel *model,
                                                         guint n,
                                                         const NcmParamType ptype);

FIXME

model :

a NcmModel

n :

FIXME

ptype :

FIXME

ncm_model_param_set_lower_bound ()

void                ncm_model_param_set_lower_bound     (NcmModel *model,
                                                         guint n,
                                                         const gdouble lb);

FIXME

model :

a NcmModel

n :

FIXME

lb :

FIXME

ncm_model_param_set_scale ()

void                ncm_model_param_set_scale           (NcmModel *model,
                                                         guint n,
                                                         const gdouble scale);

FIXME

model :

a NcmModel

n :

FIXME

scale :

FIXME

ncm_model_param_set_upper_bound ()

void                ncm_model_param_set_upper_bound     (NcmModel *model,
                                                         guint n,
                                                         const gdouble ub);

FIXME

model :

a NcmModel

n :

FIXME

ub :

FIXME

ncm_model_param_symbol ()

const gchar *       ncm_model_param_symbol              (NcmModel *model,
                                                         guint n);

ncm_model_params_copyto ()

void                ncm_model_params_copyto             (NcmModel *model,
                                                         NcmModel *model_dest);

FIXME

model :

a NcmModel.

model_dest :

a NcmModel.

ncm_model_params_finite ()

gboolean            ncm_model_params_finite             (NcmModel *model);

FIXME

model :

a NcmModel

Returns :

FIXME

ncm_model_params_get_all ()

NcmVector *         ncm_model_params_get_all            (NcmModel *model);

FIXME

model :

a NcmModel

Returns :

FIXME. [transfer full]

ncm_model_params_log_all ()

void                ncm_model_params_log_all            (NcmModel *model);

FIXME

model :

a NcmModel

ncm_model_params_print_all ()

void                ncm_model_params_print_all          (NcmModel *model,
                                                         FILE *out);

FIXME

model :

a NcmModel

out :

FIXME

ncm_model_params_save_as_default ()

void                ncm_model_params_save_as_default    (NcmModel *model);

FIXME

model :

a NcmModel.

ncm_model_params_set_all ()

void                ncm_model_params_set_all            (NcmModel *model,
                                                         ...);

FIXME

model :

a NcmModel.

... :

FIXME

ncm_model_params_set_all_data ()

void                ncm_model_params_set_all_data       (NcmModel *model,
                                                         gdouble *data);

FIXME

model :

a NcmModel.

data :

FIXME

ncm_model_params_set_default ()

void                ncm_model_params_set_default        (NcmModel *model);

FIXME

model :

a NcmModel.

ncm_model_params_set_model ()

void                ncm_model_params_set_model          (NcmModel *model,
                                                         NcmModel *model_src);

FIXME

model :

a NcmModel.

model_src :

a NcmModel.

ncm_model_params_set_vector ()

void                ncm_model_params_set_vector         (NcmModel *model,
                                                         NcmVector *v);

FIXME

model :

a NcmModel.

v :

a NcmVector.

ncm_model_params_update ()

void                ncm_model_params_update             (NcmModel *model);

Force the parameters to the update its internal flags and update the original parameters if necessary.

model :

a NcmModel

ncm_model_peek_reparam ()

NcmReparam *        ncm_model_peek_reparam              (NcmModel *model);

FIXME

model :

a NcmModel

Returns :

FIXME. [transfer none]

ncm_model_ref ()

NcmModel *          ncm_model_ref                       (NcmModel *model);

FIXME

model :

a NcmModel

Returns :

FIXME. [transfer full]

ncm_model_register_id ()

void                ncm_model_register_id               (NcmModelClass *model_class);

ncm_model_reparam_J ()

void                ncm_model_reparam_J                 (NcmModel *model,
                                                         NcmMatrix *fJ,
                                                         NcmMatrix *J);

FIXME

model :

a NcmModel.

fJ :

a NcmMatrix.

J :

a NcmMatrix.

ncm_model_reparam_df ()

void                ncm_model_reparam_df                (NcmModel *model,
                                                         NcmVector *fv,
                                                         NcmVector *v);

FIXME

model :

a NcmModel.

fv :

a NcmVector.

v :

a NcmVector.

ncm_model_set_reparam ()

void                ncm_model_set_reparam               (NcmModel *model,
                                                         NcmReparam *reparam);

FIXME

model :

a NcmModel.

reparam :

a NcmReparam.

ncm_model_sparam_len ()

guint               ncm_model_sparam_len                (NcmModel *model);

FIXME

model :

a NcmModel

Returns :

FIXME

ncm_model_vparam_array_len ()

guint               ncm_model_vparam_array_len          (NcmModel *model);

FIXME

model :

a NcmModel

Returns :

FIXME

ncm_model_vparam_index ()

guint               ncm_model_vparam_index              (NcmModel *model,
                                                         guint n,
                                                         guint i);

FIXME

model :

a NcmModel

n :

vector index

i :

vector component index

Returns :

index of the i-th component of the n-th vector

ncm_model_vparam_len ()

guint               ncm_model_vparam_len                (NcmModel *model,
                                                         guint n);

FIXME

model :

a NcmModel

n :

vector index

Returns :

length of the n-th vector

Property Details

The "implementation" property

  "implementation"           gulong                : Read

Bitwise specification of functions implementation.


The "name" property

  "name"                     gchar*                : Read

Model's name.

Default value: NULL


The "nick" property

  "nick"                     gchar*                : Read

Model's nick.

Default value: NULL


The "params" property

  "params"                   NcmVector*            : Read

Parameters vector.


The "params-types" property

  "params-types"             GArray*               : Read

Parameters' types.


The "reparam" property

  "reparam"                  NcmReparam*           : Read / Write

Model reparametrization.


The "scalar-params-len" property

  "scalar-params-len"        guint                 : Read

Number of scalar parameters.

Default value: 0


The "vector-params-len" property

  "vector-params-len"        guint                 : Read

Number of vector parameters.

Default value: 0