OscatsCovariates

OscatsCovariates — Covariates Container Class

Synopsis

struct              OscatsCovariates;
GQuark              oscats_covariates_from_string       (const gchar *name);
const gchar *       oscats_covariates_as_string         (GQuark name);
guint               oscats_covariates_num               (const OscatsCovariates *covariates);
GQuark *            oscats_covariates_list              (const OscatsCovariates *covariates);
void                oscats_covariates_set               (OscatsCovariates *covariates,
                                                         GQuark name,
                                                         gdouble value);
void                oscats_covariates_set_by_name       (OscatsCovariates *covariates,
                                                         const gchar *name,
                                                         gdouble value);
gdouble             oscats_covariates_get               (const OscatsCovariates *covariates,
                                                         GQuark name);
gdouble             oscats_covariates_get_by_name       (const OscatsCovariates *covariates,
                                                         const gchar *name);

Object Hierarchy

  GObject
   +----OscatsCovariates

Description

Details

struct OscatsCovariates

struct OscatsCovariates;


oscats_covariates_from_string ()

GQuark              oscats_covariates_from_string       (const gchar *name);

A wrapper of g_quark_from_string() for language bindings.

name :

the string name of the covariate

Returns :

the covariate name as a GQuark

oscats_covariates_as_string ()

const gchar *       oscats_covariates_as_string         (GQuark name);

A wrapper of g_quark_to_string() for language bindings.

name :

a GQuark covariate name

Returns :

the string form of characteristic

oscats_covariates_num ()

guint               oscats_covariates_num               (const OscatsCovariates *covariates);

covariates :

an OscatsCovariates

Returns :

the number of covariates in covariates

oscats_covariates_list ()

GQuark *            oscats_covariates_list              (const OscatsCovariates *covariates);

covariates :

an OscatsCovariates

Returns :

a list of the covariate GQuark names. [transfer full]

oscats_covariates_set ()

void                oscats_covariates_set               (OscatsCovariates *covariates,
                                                         GQuark name,
                                                         gdouble value);

Sets the covariate name to value.

covariates :

an OscatsCovariates object

name :

the covariate name (as a GQuark)

value :

the covariate value

oscats_covariates_set_by_name ()

void                oscats_covariates_set_by_name       (OscatsCovariates *covariates,
                                                         const gchar *name,
                                                         gdouble value);

Sets the covariate name to value. The GQuark version oscats_covariates_set() is faster.

covariates :

an OscatsCovariates object

name :

the covariate name

value :

the covariate value

oscats_covariates_get ()

gdouble             oscats_covariates_get               (const OscatsCovariates *covariates,
                                                         GQuark name);

covariates :

an OscatsCovariates object

name :

the covariate name (as a GQuark)

Returns :

the value of covariate name, or 0.

oscats_covariates_get_by_name ()

gdouble             oscats_covariates_get_by_name       (const OscatsCovariates *covariates,
                                                         const gchar *name);

The GQuark version oscats_covariates_get() is faster.

covariates :

an OscatsCovariates object

name :

the covariate name

Returns :

the value of covariate name, or 0.