Patterns in static

Apophenia

Data Structures | Macros | Typedefs
Settings

Data Structures

struct  apop_mle_settings
 
struct  apop_lm_settings
 
struct  apop_parts_wanted_settings
 
struct  apop_cdf_settings
 
struct  apop_pm_settings
 
struct  apop_kernel_density_settings
 
struct  apop_mcmc_settings
 
struct  apop_loess_settings
 
struct  apop_dconstrain_settings
 
struct  apop_mixture_settings
 

Macros

#define Apop_settings_get_group(m, type)
 
#define Apop_settings_rm_group(m, type)
 
#define Apop_settings_add_group(model, type,...)
 
#define apop_model_copy_set(model, type,...)
 
#define Apop_settings_get(model, type, setting)
 
#define Apop_settings_set(model, type, setting, data)
 

Typedefs

typedef struct apop_mcmc_settings apop_mcmc_settings
 

Detailed Description

Macro Definition Documentation

#define apop_model_copy_set (   model,
  type,
  ... 
)

Copy a model and add a settings group. Useful for models that require a settings group to function. See Apop_settings_add_group.

Returns
A pointer to the newly-prepped model.
#define Apop_settings_add_group (   model,
  type,
  ... 
)

Add a settings group. The first two arguments (the model you are attaching to and the settings group name) are mandatory, and then you can use the Designated initializers syntax to specify default values (if any).

Returns
A pointer to the newly-prepped group.
  • If a settings group of the given type is already attached to the model, the previous version is removed. Use Apop_settings_get to check whether a group of the given type is already attached to a model, and Apop_settings_set to modify an existing group.
#define Apop_settings_get (   model,
  type,
  setting 
)

Retrieves a setting from a model. See Apop_settings_get_group to pull the entire group.

#define Apop_settings_get_group (   m,
  type 
)

Retrieves a settings group from a model. See Apop_settings_get to just pull a single item from within the settings group.

If it isn't found, then it returns NULL, so you can easily put it in a conditional like

1 if (!apop_settings_get_group(m, "apop_ols")) ...
#define Apop_settings_rm_group (   m,
  type 
)

Removes a settings group from a model's list.

If the so-named group is not found, do nothing.

#define Apop_settings_set (   model,
  type,
  setting,
  data 
)

Modifies a single element of a settings group to the given value.

  • If model==NULL, fails silently.
  • If model!=NULL but the given settings group is not found attached to the model, set model->error='s'.

Typedef Documentation

Method settings for a model to be put through Bayesian updating.

Autogenerated by doxygen on Sun Oct 26 2014 (Debian 0.999b+ds3-2).