NcmFitESMCMC

NcmFitESMCMC — Ensemble sampler Markov Chain Monte Carlo analysis.

Properties

gboolean auto-trim Read / Write / Construct
guint auto-trim-div Read / Write / Construct
gchar * data-file Read / Write
NcmFit * fit Read / Write / Construct Only
NcmObjArray * functions-array Read / Write / Construct Only
gdouble max-runs-time Read / Write / Construct
guint min-runs Read / Write / Construct
NcmFitRunMsgs mtype Read / Write
guint nthreads Read / Write
gint nwalkers Read / Write / Construct Only
NcmMSetTransKern * sampler Read / Write / Construct
NcmMSetCatalogTrimType trim-type Read / Write / Construct
NcmFitESMCMCWalker * walker Read / Write / Construct Only

Object Hierarchy

    GObject
    ╰── NcmFitESMCMC

Description

FIXME

Functions

ncm_fit_esmcmc_new ()

NcmFitESMCMC *
ncm_fit_esmcmc_new (NcmFit *fit,
                    gint nwalkers,
                    NcmMSetTransKern *sampler,
                    NcmFitESMCMCWalker *walker,
                    NcmFitRunMsgs mtype);

FIXME

Parameters

fit

a NcmFit

 

nwalkers

number of walkers

 

sampler

inital points sampler NcmMSetTransKern

 

walker

a NcmFitESMCMCWalker.

[allow-none]

mtype

FIXME

 

Returns

FIXME


ncm_fit_esmcmc_new_funcs_array ()

NcmFitESMCMC *
ncm_fit_esmcmc_new_funcs_array (NcmFit *fit,
                                gint nwalkers,
                                NcmMSetTransKern *sampler,
                                NcmFitESMCMCWalker *walker,
                                NcmFitRunMsgs mtype,
                                NcmObjArray *funcs_array);

FIXME

Parameters

fit

a NcmFit

 

nwalkers

number of walkers

 

sampler

inital points sampler NcmMSetTransKern

 

walker

a NcmFitESMCMCWalker.

[allow-none]

mtype

FIXME

 

funcs_array

a NcmObjArray of scalar functions to include in the catalog.

 

Returns

FIXME


ncm_fit_esmcmc_ref ()

NcmFitESMCMC *
ncm_fit_esmcmc_ref (NcmFitESMCMC *esmcmc);

FIXME

Parameters

esmcmc

a NcmFitESMCMC

 

Returns

FIXME.

[transfer full]


ncm_fit_esmcmc_free ()

void
ncm_fit_esmcmc_free (NcmFitESMCMC *esmcmc);

FIXME

Parameters

esmcmc

a NcmFitESMCMC

 

ncm_fit_esmcmc_clear ()

void
ncm_fit_esmcmc_clear (NcmFitESMCMC **esmcmc);

FIXME

Parameters

esmcmc

a NcmFitESMCMC

 

ncm_fit_esmcmc_set_data_file ()

void
ncm_fit_esmcmc_set_data_file (NcmFitESMCMC *esmcmc,
                              const gchar *filename);

FIXME

Parameters

esmcmc

a NcmFitESMCMC

 

filename

a filename.

 

ncm_fit_esmcmc_set_sampler ()

void
ncm_fit_esmcmc_set_sampler (NcmFitESMCMC *esmcmc,
                            NcmMSetTransKern *sampler);

ncm_fit_esmcmc_set_mtype ()

void
ncm_fit_esmcmc_set_mtype (NcmFitESMCMC *esmcmc,
                          NcmFitRunMsgs mtype);

FIXME

Parameters

esmcmc

a NcmFitESMCMC

 

mtype

FIXME

 

ncm_fit_esmcmc_set_nthreads ()

void
ncm_fit_esmcmc_set_nthreads (NcmFitESMCMC *esmcmc,
                             guint nthreads);

If nthreads is larger than nwalkers / 2, it will be set to nwalkers / 2.

Parameters

esmcmc

a NcmFitESMCMC

 

nthreads

numbers of simultaneous walkers updates.

 

ncm_fit_esmcmc_set_rng ()

void
ncm_fit_esmcmc_set_rng (NcmFitESMCMC *esmcmc,
                        NcmRNG *rng);

FIXME

Parameters

esmcmc

a NcmFitESMCMC

 

rng

FIXME

 

ncm_fit_esmcmc_set_auto_trim ()

void
ncm_fit_esmcmc_set_auto_trim (NcmFitESMCMC *esmcmc,
                              gboolean enable);

If enable is TRUE turns on the auto-trimming when performing a run_lre.

Parameters

esmcmc

a NcmFitESMCMC

 

enable

a boolean

 

ncm_fit_esmcmc_set_auto_trim_div ()

void
ncm_fit_esmcmc_set_auto_trim_div (NcmFitESMCMC *esmcmc,
                                  guint div);

Sets the divisor for the auto trim tests.

Parameters

esmcmc

a NcmFitESMCMC

 

div

a unsigned integer

 

ncm_fit_esmcmc_set_min_runs ()

void
ncm_fit_esmcmc_set_min_runs (NcmFitESMCMC *esmcmc,
                             guint min_runs);

Sets the minimum number of runs between tests.

Parameters

esmcmc

a NcmFitESMCMC

 

min_runs

a unsigned integer

 

ncm_fit_esmcmc_set_max_runs_time ()

void
ncm_fit_esmcmc_set_max_runs_time (NcmFitESMCMC *esmcmc,
                                  gdouble max_runs_time);

Sets the maximum time for the runs between tests.

Parameters

esmcmc

a NcmFitESMCMC

 

max_runs_time

a unsigned integer

 

ncm_fit_esmcmc_has_rng ()

gboolean
ncm_fit_esmcmc_has_rng (NcmFitESMCMC *esmcmc);

FIXME

Parameters

esmcmc

a NcmFitESMCMC

 

Returns

whether there is a NcmRNG set.


ncm_fit_esmcmc_get_accept_ratio ()

gdouble
ncm_fit_esmcmc_get_accept_ratio (NcmFitESMCMC *esmcmc);

FIXME

Parameters

esmcmc

a NcmFitESMCMC

 

Returns

FIXME


ncm_fit_esmcmc_get_offboard_ratio ()

gdouble
ncm_fit_esmcmc_get_offboard_ratio (NcmFitESMCMC *esmcmc);

FIXME

Parameters

esmcmc

a NcmFitESMCMC

 

Returns

FIXME


ncm_fit_esmcmc_start_run ()

void
ncm_fit_esmcmc_start_run (NcmFitESMCMC *esmcmc);

FIXME

Parameters

esmcmc

a NcmFitESMCMC

 

ncm_fit_esmcmc_end_run ()

void
ncm_fit_esmcmc_end_run (NcmFitESMCMC *esmcmc);

FIXME

Parameters

esmcmc

a NcmFitESMCMC

 

ncm_fit_esmcmc_reset ()

void
ncm_fit_esmcmc_reset (NcmFitESMCMC *esmcmc);

FIXME

Parameters

esmcmc

a NcmFitESMCMC

 

ncm_fit_esmcmc_run ()

void
ncm_fit_esmcmc_run (NcmFitESMCMC *esmcmc,
                    guint n);

Runs the Monte Carlo until it reaches the n -th realization. Note that if the first_id is non-zero it will run n - first_id realizations.

Parameters

esmcmc

a NcmFitESMCMC

 

n

total number of realizations to run

 

ncm_fit_esmcmc_run_lre ()

void
ncm_fit_esmcmc_run_lre (NcmFitESMCMC *esmcmc,
                        guint prerun,
                        gdouble lre);

FIXME

Parameters

esmcmc

a NcmFitESMCMC

 

prerun

FIXME

 

lre

FIXME

 

ncm_fit_esmcmc_mean_covar ()

void
ncm_fit_esmcmc_mean_covar (NcmFitESMCMC *esmcmc);

FIXME

Parameters

esmcmc

a NcmFitESMCMC

 

ncm_fit_esmcmc_peek_ser ()

NcmSerialize *
ncm_fit_esmcmc_peek_ser (NcmFitESMCMC *esmcmc);

Peeks the internal NcmSerialize object from esmcmc .

Parameters

esmcmc

a NcmFitESMCMC

 

Returns

the internal NcmSerialize object.

[transfer none]


ncm_fit_esmcmc_get_catalog ()

NcmMSetCatalog *
ncm_fit_esmcmc_get_catalog (NcmFitESMCMC *esmcmc);

Gets the generated catalog of esmcmc .

Parameters

esmcmc

a NcmFitESMCMC

 

Returns

the generated catalog.

[transfer full]


ncm_fit_esmcmc_validate ()

gboolean
ncm_fit_esmcmc_validate (NcmFitESMCMC *esmcmc,
                         gulong pi,
                         gulong pf);

Recalculates the value of $-2\ln(L)$ and compares with the values found in the catalog. This function is particularly useful to check if any problem occured during a multithread evaluation of the likelihood.

Choosing pf == 0 performs the validation from pi to the end.

Parameters

esmcmc

a NcmFitESMCMC

 

pi

initial position

 

pf

final position

 

Returns

Whether the validation was TRUE or FALSE.

Types and Values

NCM_FIT_ESMCMC_MIN_SYNC_INTERVAL

#define NCM_FIT_ESMCMC_MIN_SYNC_INTERVAL (10.0)

NCM_FIT_ESMCMC_M2LNL_ID

#define NCM_FIT_ESMCMC_M2LNL_ID (0)

Property Details

The “auto-trim” property

  “auto-trim”                gboolean

Whether to automatically trim the catalog.

Flags: Read / Write / Construct

Default value: FALSE


The “auto-trim-div” property

  “auto-trim-div”            guint

Automatically trim divisor.

Flags: Read / Write / Construct

Allowed values: >= 1

Default value: 100


The “data-file” property

  “data-file”                gchar *

Data filename.

Flags: Read / Write

Default value: NULL


The “fit” property

  “fit”                      NcmFit *

Fit object.

Flags: Read / Write / Construct Only


The “functions-array” property

  “functions-array”          NcmObjArray *

Functions array.

Flags: Read / Write / Construct Only


The “max-runs-time” property

  “max-runs-time”            gdouble

Maximum time between runs.

Flags: Read / Write / Construct

Allowed values: >= 1

Default value: 7200


The “min-runs” property

  “min-runs”                 guint

Minumum number of runs.

Flags: Read / Write / Construct

Allowed values: >= 1

Default value: 10


The “mtype” property

  “mtype”                    NcmFitRunMsgs

Run messages type.

Flags: Read / Write

Default value: NCM_FIT_RUN_MSGS_SIMPLE


The “nthreads” property

  “nthreads”                 guint

Number of threads to run.

Flags: Read / Write

Default value: 0


The “nwalkers” property

  “nwalkers”                 gint

Number of walkers.

Flags: Read / Write / Construct Only

Allowed values: >= 1

Default value: 1


The “sampler” property

  “sampler”                  NcmMSetTransKern *

Initial points sampler.

Flags: Read / Write / Construct


The “trim-type” property

  “trim-type”                NcmMSetCatalogTrimType

Trimming tests to apply.

Flags: Read / Write / Construct

Default value: NCM_MSET_CATALOG_TRIM_TYPE_ESS


The “walker” property

  “walker”                   NcmFitESMCMCWalker *

Walker object.

Flags: Read / Write / Construct Only