NcmModelBuilder

NcmModelBuilder — A NcmModel builder

Properties

gchar * description Read / Write / Construct Only
gchar * name Read / Write / Construct Only
GType * parent-type Read / Write / Construct Only

Object Hierarchy

    GObject
    ╰── NcmModelBuilder

Description

This model can be used to create runtime NcmModels. It is particularly useful to create models in binded languages, e.g., python.

Functions

ncm_model_builder_new ()

NcmModelBuilder *
ncm_model_builder_new (GType ptype,
                       const gchar *name,
                       const gchar *desc);

Creates a new NcmModelBuilder object. This does not create the new class after defining all parameters one should call ncm_model_builder_create() to effectively define a new class.

Parameters

ptype

Parent's type

 

name

model's name

 

desc

model's description

 

Returns

a new NcmModelBuilder.

[transfer full]


ncm_model_builder_ref ()

NcmModelBuilder *
ncm_model_builder_ref (NcmModelBuilder *mb);

Increase reference count of mb by one.

Parameters

mb

a NcmModelBuilder

 

Returns

mb .

[transfer full]


ncm_model_builder_add_sparam_obj ()

void
ncm_model_builder_add_sparam_obj (NcmModelBuilder *mb,
                                  NcmSParam *sparam);

Adds the parameters described by sparam to mb .

Parameters

mb

a NcmModelBuilder

 

sparam

a NcmSParam

 

ncm_model_builder_add_vparam_obj ()

void
ncm_model_builder_add_vparam_obj (NcmModelBuilder *mb,
                                  NcmVParam *vparam);

Adds the parameters described by sparam to mb .

Parameters

mb

a NcmModelBuilder

 

vparam

a NcmVParam

 

ncm_model_builder_add_sparam ()

void
ncm_model_builder_add_sparam (NcmModelBuilder *mb,
                              const gchar *symbol,
                              const gchar *name,
                              gdouble lower_bound,
                              gdouble upper_bound,
                              gdouble scale,
                              gdouble abstol,
                              gdouble default_value,
                              NcmParamType ppt);

Creates a new NcmSParam from arguments and add it to mb .

Parameters

mb

a NcmModelBuilder

 

symbol

symbol of the scalar parameter

 

name

name of the sacalar parameter

 

lower_bound

lower-bound value

 

upper_bound

upper-bound value

 

scale

FIXME

 

abstol

FIXME

 

default_value

default value

 

ppt

a NcmParamType

 

ncm_model_builder_add_vparam ()

void
ncm_model_builder_add_vparam (NcmModelBuilder *mb,
                              guint default_length,
                              const gchar *symbol,
                              const gchar *name,
                              gdouble lower_bound,
                              gdouble upper_bound,
                              gdouble scale,
                              gdouble abstol,
                              gdouble default_value,
                              NcmParamType ppt);

Creates a new NcmVParam from arguments and add it to mb .

Parameters

mb

a NcmModelBuilder

 

default_length

default length of the vector parameter

 

symbol

symbol of the vector parameter

 

name

name of the vector parameter

 

lower_bound

FIXME

 

upper_bound

FIXME

 

scale

FIXME

 

abstol

FIXME

 

default_value

default value

 

ppt

a NcmParamType

 

ncm_model_builder_create ()

GType
ncm_model_builder_create (NcmModelBuilder *mb);

Creates a new object type using the scalar and vector parameters defined in mb .

Parameters

mb

a NcmModelBuilder

 

Types and Values

Property Details

The “description” property

  “description”              gchar *

Model's description.

Flags: Read / Write / Construct Only

Default value: "no-description"


The “name” property

  “name”                     gchar *

Model's name.

Flags: Read / Write / Construct Only

Default value: "no-name"


The “parent-type” property

  “parent-type”              GType *

Parent type.

Flags: Read / Write / Construct Only

Allowed values: NcmModel