NcmMSetCatalog

NcmMSetCatalog — Ordered catalog of different NcmMSet parameter values.

Functions

NcmMSetCatalog * ncm_mset_catalog_new ()
NcmMSetCatalog * ncm_mset_catalog_new_array ()
NcmMSetCatalog * ncm_mset_catalog_new_from_file ()
NcmMSetCatalog * ncm_mset_catalog_new_from_file_ro ()
NcmMSetCatalog * ncm_mset_catalog_ref ()
void ncm_mset_catalog_free ()
void ncm_mset_catalog_clear ()
void ncm_mset_catalog_set_file ()
void ncm_mset_catalog_set_sync_mode ()
void ncm_mset_catalog_set_sync_interval ()
void ncm_mset_catalog_set_first_id ()
void ncm_mset_catalog_set_run_type ()
void ncm_mset_catalog_set_rng ()
void ncm_mset_catalog_sync ()
void ncm_mset_catalog_timed_sync ()
void ncm_mset_catalog_reset_stats ()
void ncm_mset_catalog_reset ()
void ncm_mset_catalog_erase_data ()
void ncm_mset_catalog_set_m2lnp_var ()
gint ncm_mset_catalog_get_m2lnp_var ()
const gchar * ncm_mset_catalog_peek_filename ()
NcmRNG * ncm_mset_catalog_get_rng ()
NcmRNG * ncm_mset_catalog_peek_rng ()
gboolean ncm_mset_catalog_is_empty ()
gdouble ncm_mset_catalog_largest_error ()
guint ncm_mset_catalog_len ()
guint ncm_mset_catalog_max_time ()
guint ncm_mset_catalog_nchains ()
guint ncm_mset_catalog_nadd_vals ()
gboolean ncm_mset_catalog_weighted ()
guint ncm_mset_catalog_get_row_from_time ()
gint ncm_mset_catalog_get_first_id ()
gint ncm_mset_catalog_get_cur_id ()
guint ncm_mset_catalog_ncols ()
const gchar * ncm_mset_catalog_col_name ()
const gchar * ncm_mset_catalog_col_full_name ()
const gchar * ncm_mset_catalog_col_symb ()
gboolean ncm_mset_catalog_col_by_name ()
void ncm_mset_catalog_set_burnin ()
glong ncm_mset_catalog_get_burnin ()
void ncm_mset_catalog_set_tau_method ()
NcmMSetCatalogTauMethod ncm_mset_catalog_get_tau_method ()
void ncm_mset_catalog_add_from_mset ()
void ncm_mset_catalog_add_from_mset_array ()
void ncm_mset_catalog_add_from_vector ()
void ncm_mset_catalog_add_from_vector_array ()
void ncm_mset_catalog_log_current_stats ()
void ncm_mset_catalog_log_current_chain_stats ()
NcmMSet * ncm_mset_catalog_get_mset ()
NcmMSet * ncm_mset_catalog_peek_mset ()
const gchar * ncm_mset_catalog_get_run_type ()
NcmStatsVec * ncm_mset_catalog_peek_pstats ()
NcmStatsVec * ncm_mset_catalog_peek_e_mean_stats ()
NcmStatsVec * ncm_mset_catalog_peek_chain_pstats ()
GArray * ncm_mset_catalog_peek_accept_ratio_array ()
NcmVector * ncm_mset_catalog_peek_row ()
NcmVector * ncm_mset_catalog_peek_current_row ()
NcmVector * ncm_mset_catalog_peek_current_e_mean ()
NcmVector * ncm_mset_catalog_peek_current_e_var ()
NcmVector * ncm_mset_catalog_peek_e_mean_t ()
NcmVector * ncm_mset_catalog_peek_e_var_t ()
gdouble ncm_mset_catalog_get_post_lnnorm ()
gdouble ncm_mset_catalog_get_post_lnvol ()
gdouble ncm_mset_catalog_get_nth_m2lnL_percentile ()
gdouble ncm_mset_catalog_get_bestfit_m2lnL ()
NcmVector * ncm_mset_catalog_get_bestfit_row ()
void ncm_mset_catalog_get_mean ()
void ncm_mset_catalog_get_covar ()
void ncm_mset_catalog_get_full_covar ()
void ncm_mset_catalog_log_full_covar ()
void ncm_mset_catalog_estimate_autocorrelation_tau ()
NcmVector * ncm_mset_catalog_peek_autocorrelation_tau ()
gdouble ncm_mset_catalog_get_param_shrink_factor ()
gdouble ncm_mset_catalog_get_shrink_factor ()
void ncm_mset_catalog_param_pdf ()
gdouble ncm_mset_catalog_param_pdf_pvalue ()
NcmMatrix * ncm_mset_catalog_calc_ci_direct ()
NcmMatrix * ncm_mset_catalog_calc_ci_interp ()
NcmMatrix * ncm_mset_catalog_calc_pvalue ()
NcmStatsDist1d * ncm_mset_catalog_calc_distrib ()
NcmStatsDist1d * ncm_mset_catalog_calc_param_distrib ()
NcmStatsDist1d * ncm_mset_catalog_calc_add_param_distrib ()
void ncm_mset_catalog_calc_param_ensemble_evol ()
void ncm_mset_catalog_calc_add_param_ensemble_evol ()
void ncm_mset_catalog_trim ()
void ncm_mset_catalog_trim_p ()
guint ncm_mset_catalog_trim_oob ()
void ncm_mset_catalog_remove_last_ensemble ()
guint ncm_mset_catalog_calc_max_ess_time ()
guint ncm_mset_catalog_calc_heidel_diag ()
guint ncm_mset_catalog_calc_const_break ()
void ncm_mset_catalog_trim_by_type ()
guint ncm_mset_catalog_max_ess_time_by_chain ()
guint ncm_mset_catalog_heidel_diag_by_chain ()

Properties

glong burnin Read / Write / Construct
char * filename Read / Write / Construct
int m2lnp-var Read / Write / Construct
NcmMSet * mset Read / Write / Construct Only
GStrv nadd-val-names Read / Write / Construct Only
GStrv nadd-val-symbols Read / Write / Construct Only
guint nadd-vals Read / Write / Construct Only
guint nchains Read / Write / Construct Only
gboolean read-only Read / Write / Construct Only
NcmRNG * rng Read / Write
char * run-type-string Read / Write / Construct
NcmMSetCatalogSync smode Read / Write / Construct
double sync-interval Read / Write / Construct
NcmMSetCatalogTauMethod tau-method Read / Write / Construct
gboolean weighted Read / Write / Construct Only

Types and Values

Object Hierarchy

    GEnum
    ├── NcmMSetCatalogPostNormMethod
    ├── NcmMSetCatalogSync
    ╰── NcmMSetCatalogTauMethod
    GFlags
    ╰── NcmMSetCatalogTrimType
    GObject
    ╰── NcmMSetCatalog

Description

This class defines a catalog type object. This object can automatically synchronize with a fits file (thought cfitsio).

For Mote Carlo studies, like resampling from a fiducial model or bootstrap, it is used to save the best-fitting values of each realization. Since the order of the resampling is important, due to the fact that we use the same pseudo-random number generator for all resamplings, this object also guarantees the order of the samples added.

For Markov Chain Monte Carlo (MCMC) this object saves the value of the same likelihood in different points of the parameter space.

For both applications this object keeps an interactive mean and variance of the parameters added, this allows a sample by sample analyses of the convergence. Some MCMC convergence diagnostic functions are also implemented here.

Functions

ncm_mset_catalog_new ()

NcmMSetCatalog *
ncm_mset_catalog_new (NcmMSet *mset,
                      guint nadd_vals,
                      guint nchains,
                      gboolean weighted,
                      ...);

Creates a new NcmMSetCatalog based on the NcmFit object fit . The catalog assumes that the fit object will remain with the same set of free parameters during its whole lifetime.

If nchains is larger than one, the catalog will keep track of the statistics of each chain separately.

Parameters

mset

a NcmMSet

 

nadd_vals

number of additional values

 

nchains

number of different chains in the catalog (>=1)

 

weighted

set to TRUE whenever the catalog is weighted

 

...

additional values name/symbol pairs

 

Returns

a new NcmMSetCatalog.

[transfer full]


ncm_mset_catalog_new_array ()

NcmMSetCatalog *
ncm_mset_catalog_new_array (NcmMSet *mset,
                            guint nadd_vals,
                            guint nchains,
                            gboolean weighted,
                            gchar **names,
                            gchar **symbols);

Creates a new NcmMSetCatalog based on the NcmFit object fit . The catalog assumes that the fit object will remain with the same set of free parameters during its whole lifetime.

If nchains is larger than one, the catalog will keep track of the statistics of each chain separately.

Parameters

mset

a NcmMSet

 

nadd_vals

number of additional values

 

nchains

number of different chains in the catalog (>=1)

 

weighted

set to TRUE whenever the catalog is weighted

 

names

additional values name NULL-terminated array.

[array zero-terminated=1]

symbols

additional values symbol NULL-terminated array.

[array zero-terminated=1]

Returns

a new NcmMSetCatalog.

[transfer full]


ncm_mset_catalog_new_from_file ()

NcmMSetCatalog *
ncm_mset_catalog_new_from_file (const gchar *filename,
                                glong burnin);

Creates a new NcmMSetCatalog from the catalog in the file file . It will use also the mset file (same name but with .mset extension).

Parameters

filename

filename of the catalog fits

 

burnin

Burn-in size

 

Returns

a new NcmMSetCatalog.

[transfer full]


ncm_mset_catalog_new_from_file_ro ()

NcmMSetCatalog *
ncm_mset_catalog_new_from_file_ro (const gchar *filename,
                                   glong burnin);

Creates a new NcmMSetCatalog from the catalog in the file file . The file is opened in a read-only fashion. It will use also the mset file (same name but with .mset extension).

Parameters

filename

filename of the catalog fits

 

burnin

Burn-in size

 

Returns

a new NcmMSetCatalog.

[transfer full]


ncm_mset_catalog_ref ()

NcmMSetCatalog *
ncm_mset_catalog_ref (NcmMSetCatalog *mcat);

Increases the reference count of mcat atomically.

Parameters

mcat

a NcmMSetCatalog

 

Returns

mcat .

[transfer full]


ncm_mset_catalog_free ()

void
ncm_mset_catalog_free (NcmMSetCatalog *mcat);

Decreases the reference count of mcat atomically.

Parameters

mcat

a NcmMSetCatalog

 

ncm_mset_catalog_clear ()

void
ncm_mset_catalog_clear (NcmMSetCatalog **mcat);

Decrese the reference count of *mcat atomically and sets the pointer *mcat to null.

Parameters

mcat

a NcmMSetCatalog

 

ncm_mset_catalog_set_file ()

void
ncm_mset_catalog_set_file (NcmMSetCatalog *mcat,
                           const gchar *filename);

Sets the data filename to be used to sync/save data.

Parameters

mcat

a NcmMSetCatalog

 

filename

a filename

 

ncm_mset_catalog_set_sync_mode ()

void
ncm_mset_catalog_set_sync_mode (NcmMSetCatalog *mcat,
                                NcmMSetCatalogSync smode);

Sets the sync mode to smode .

Parameters

mcat

a NcmMSetCatalog

 

smode

sync mode

 

ncm_mset_catalog_set_sync_interval ()

void
ncm_mset_catalog_set_sync_interval (NcmMSetCatalog *mcat,
                                    gdouble interval);

Sets the minimum time interval between syncs.

Parameters

mcat

a NcmMSetCatalog

 

interval

Minimum time interval between syncs

 

ncm_mset_catalog_set_first_id ()

void
ncm_mset_catalog_set_first_id (NcmMSetCatalog *mcat,
                               gint first_id);

Sets the first id of the catalog, mainly used to inform in which realization the catalog starts.

Parameters

mcat

a NcmMSetCatalog

 

first_id

the id of the first item in the sample

 

ncm_mset_catalog_set_run_type ()

void
ncm_mset_catalog_set_run_type (NcmMSetCatalog *mcat,
                               const gchar *rtype_str);

Sets the run type string.

Parameters

mcat

a NcmMSetCatalog

 

rtype_str

the run type string

 

ncm_mset_catalog_set_rng ()

void
ncm_mset_catalog_set_rng (NcmMSetCatalog *mcat,
                          NcmRNG *rng);

Sets the random number generator.

Parameters

mcat

a NcmMSetCatalog

 

rng

a NcmRNG

 

ncm_mset_catalog_sync ()

void
ncm_mset_catalog_sync (NcmMSetCatalog *mcat,
                       gboolean check);

Synchronize memory and data file. If no file was defined, it simply returns.

Parameters

mcat

a NcmMSetCatalog

 

check

whether to check consistence between file and memory data

 

ncm_mset_catalog_timed_sync ()

void
ncm_mset_catalog_timed_sync (NcmMSetCatalog *mcat,
                             gboolean check);

Synchronize memory and data file if enough time was passed after the last sync, see ncm_mset_catalog_set_sync_interval(). If no file was defined, it simply returns.

Parameters

mcat

a NcmMSetCatalog

 

check

whether to check consistence between file and memory data

 

ncm_mset_catalog_reset_stats ()

void
ncm_mset_catalog_reset_stats (NcmMSetCatalog *mcat);

Reset catalog statistical quantities.

Parameters

mcat

a NcmMSetCatalog

 

ncm_mset_catalog_reset ()

void
ncm_mset_catalog_reset (NcmMSetCatalog *mcat);

Clean all catalog data from memory and file. Otherwise it does not change any object's parameter.

Parameters

mcat

a NcmMSetCatalog

 

ncm_mset_catalog_erase_data ()

void
ncm_mset_catalog_erase_data (NcmMSetCatalog *mcat);

Erases all data from the fits file associated with the catalog.

Parameters

mcat

a NcmMSetCatalog

 

ncm_mset_catalog_set_m2lnp_var ()

void
ncm_mset_catalog_set_m2lnp_var (NcmMSetCatalog *mcat,
                                const gint p);

Sets p as the $-2\ln(p)$ parameter index.

Parameters

mcat

a NcmMSetCatalog

 

p

$-2\ln(p)$ parameter index

 

ncm_mset_catalog_get_m2lnp_var ()

gint
ncm_mset_catalog_get_m2lnp_var (NcmMSetCatalog *mcat);

Gets the $-2\ln(p)$ parameter index.

Parameters

mcat

a NcmMSetCatalog

 

Returns

the $-2\ln(p)$ parameter index, -1 if unset.


ncm_mset_catalog_peek_filename ()

const gchar *
ncm_mset_catalog_peek_filename (NcmMSetCatalog *mcat);

Gets the filename associated with mcat .

Parameters

mcat

a NcmMSetCatalog

 

Returns

filename or NULL.

[transfer none]


ncm_mset_catalog_get_rng ()

NcmRNG *
ncm_mset_catalog_get_rng (NcmMSetCatalog *mcat);

This function checks if any pseudo random number generator (RNG) is registred in the catalog. If so, it returns it or NULL.

Parameters

mcat

a NcmMSetCatalog

 

Returns

the registered NcmRNG in the catalog or NULL.

[transfer full][allow-none]


ncm_mset_catalog_peek_rng ()

NcmRNG *
ncm_mset_catalog_peek_rng (NcmMSetCatalog *mcat);

This function checks if any pseudo random number generator (RNG) is registred in the catalog. If so, it returns it or NULL.

Parameters

mcat

a NcmMSetCatalog

 

Returns

the registered NcmRNG in the catalog or NULL.

[transfer none][allow-none]


ncm_mset_catalog_is_empty ()

gboolean
ncm_mset_catalog_is_empty (NcmMSetCatalog *mcat);

Parameters

mcat

a NcmMSetCatalog

 

Returns

TRUE when the catalog is empty.


ncm_mset_catalog_largest_error ()

gdouble
ncm_mset_catalog_largest_error (NcmMSetCatalog *mcat);

This function calculates the largest proportional error of the parameters included, i.e., $\text{lre} = \sigma_{\hat{p}}/(|\hat{p}|\sqrt{n})$ where $n$ represents the number of samples in the catalog, $\hat{p}$ is the estimated mean of the parameter $p$ and $\sigma_{\hat{p}}$ its standard deviation.

It tries to guess when $p = 0$. In this case $\sigma_{\hat{p}} \approx |\hat{p}|\sqrt{n}$. Therefore, for $n > 10$, it tests if $\text{lre} \approx 1$ and, if it is the case, it returns $\text{lre} = \sigma_{\hat{p}}/\sqrt{n}$ instead.

Parameters

mcat

a NcmMSetCatalog

 

Returns

the largest proportional error $\text{lre}$.


ncm_mset_catalog_len ()

guint
ncm_mset_catalog_len (NcmMSetCatalog *mcat);

Number of itens in the catalog.

Parameters

mcat

a NcmMSetCatalog

 

Returns

number of itens in the catalog.


ncm_mset_catalog_max_time ()

guint
ncm_mset_catalog_max_time (NcmMSetCatalog *mcat);

Number of itens in the catalog divided by the number of chains.

Parameters

mcat

a NcmMSetCatalog

 

Returns

number of ensembles in the catalog.


ncm_mset_catalog_nchains ()

guint
ncm_mset_catalog_nchains (NcmMSetCatalog *mcat);

Number of chains in the catalog.

Parameters

mcat

a NcmMSetCatalog

 

Returns

number of chains in the catalog.


ncm_mset_catalog_nadd_vals ()

guint
ncm_mset_catalog_nadd_vals (NcmMSetCatalog *mcat);

Number of additional variables in the catalog.

Parameters

mcat

a NcmMSetCatalog

 

Returns

number of additional variables in the catalog.


ncm_mset_catalog_weighted ()

gboolean
ncm_mset_catalog_weighted (NcmMSetCatalog *mcat);

Whether the catalog has weights.

Parameters

mcat

a NcmMSetCatalog

 

Returns

whether the catalog has weights.


ncm_mset_catalog_get_row_from_time ()

guint
ncm_mset_catalog_get_row_from_time (NcmMSetCatalog *mcat,
                                    gint t);

Parameters

mcat

a NcmMSetCatalog

 

t

time $t$

 

Returns

row number of time $t$ step.


ncm_mset_catalog_get_first_id ()

gint
ncm_mset_catalog_get_first_id (NcmMSetCatalog *mcat);

Parameters

mcat

a NcmMSetCatalog

 

Returns

the id of the first row in this catalog.


ncm_mset_catalog_get_cur_id ()

gint
ncm_mset_catalog_get_cur_id (NcmMSetCatalog *mcat);

Parameters

mcat

a NcmMSetCatalog

 

Returns

the id of the last row added (-1 if empty).


ncm_mset_catalog_ncols ()

guint
ncm_mset_catalog_ncols (NcmMSetCatalog *mcat);

Parameters

mcat

a NcmMSetCatalog

 

Returns

total number of columns in the catalog.


ncm_mset_catalog_col_name ()

const gchar *
ncm_mset_catalog_col_name (NcmMSetCatalog *mcat,
                           guint i);

Parameters

mcat

a NcmMSetCatalog

 

i

column index

 

Returns

the name of the i -th column.

[transfer none]


ncm_mset_catalog_col_full_name ()

const gchar *
ncm_mset_catalog_col_full_name (NcmMSetCatalog *mcat,
                                guint i);

Parameters

mcat

a NcmMSetCatalog

 

i

column index

 

Returns

the full name of the i -th column.

[transfer none]


ncm_mset_catalog_col_symb ()

const gchar *
ncm_mset_catalog_col_symb (NcmMSetCatalog *mcat,
                           guint i);

Parameters

mcat

a NcmMSetCatalog

 

i

column index

 

Returns

the symbol of the i -th column.

[transfer none]


ncm_mset_catalog_col_by_name ()

gboolean
ncm_mset_catalog_col_by_name (NcmMSetCatalog *mcat,
                              const gchar *name,
                              guint *col_index);

Finds the column name in the catalog mcat .

Parameters

mcat

a NcmMSetCatalog

 

name

column name

 

col_index

column index.

[out]

Returns

whether if name was found in catalog.


ncm_mset_catalog_set_burnin ()

void
ncm_mset_catalog_set_burnin (NcmMSetCatalog *mcat,
                             glong burnin);

Sets the number of elements to ignore when reading from a catalogue, it must be set before loading data from a file.

It will not affect a catalogue in any other context, only when reading data from a file. It is recommended to be used only when analysing a catalogue.

Parameters

mcat

a NcmMSetCatalog

 

burnin

number of elements to ignore

 

ncm_mset_catalog_get_burnin ()

glong
ncm_mset_catalog_get_burnin (NcmMSetCatalog *mcat);

Gets the burn-in size, see ncm_mset_catalog_set_burnin().

Parameters

mcat

a NcmMSetCatalog

 

Returns

the burn-in.


ncm_mset_catalog_set_tau_method ()

void
ncm_mset_catalog_set_tau_method (NcmMSetCatalog *mcat,
                                 NcmMSetCatalogTauMethod tau_method);

Sets the autocorrelation time method to tau_method .

Parameters

mcat

a NcmMSetCatalog

 

tau_method

a NcmMSetCatalogTauMethod

 

ncm_mset_catalog_get_tau_method ()

NcmMSetCatalogTauMethod
ncm_mset_catalog_get_tau_method (NcmMSetCatalog *mcat);

Parameters

mcat

a NcmMSetCatalog

 

Returns

the autocorrelation time method used by mcat .


ncm_mset_catalog_add_from_mset ()

void
ncm_mset_catalog_add_from_mset (NcmMSetCatalog *mcat,
                                NcmMSet *mset,
                                ...);

This function adds a new element to the catalog using the parameters from mset . It assumes that mset is compatible with the catalog and expect the right number of additional values.

Parameters

mcat

a NcmMSetCatalog

 

mset

a NcmMSet

 

...

additional values

 

ncm_mset_catalog_add_from_mset_array ()

void
ncm_mset_catalog_add_from_mset_array (NcmMSetCatalog *mcat,
                                      NcmMSet *mset,
                                      gdouble *ax);

This funtion adds a new element to the catalog using the parameters from mset . It assumes that mset is compatible with the catalog and expect the right number of additional values in the array ax .

Parameters

mcat

a NcmMSetCatalog

 

mset

a NcmMSet

 

ax

additional values array.

[array][element-type double]

ncm_mset_catalog_add_from_vector ()

void
ncm_mset_catalog_add_from_vector (NcmMSetCatalog *mcat,
                                  NcmVector *vals);

Adds a new element to the catalog using the values from the vector vals .

Parameters

mcat

a NcmMSetCatalog

 

vals

a NcmVector

 

ncm_mset_catalog_add_from_vector_array ()

void
ncm_mset_catalog_add_from_vector_array
                               (NcmMSetCatalog *mcat,
                                NcmVector *vals,
                                gdouble *ax);

Adds a new element to the catalog using the parameter values from the vector vals and additional parameters from array ax .

Parameters

mcat

a NcmMSetCatalog

 

vals

a NcmVector

 

ax

additional values array.

[array][element-type double]

ncm_mset_catalog_log_current_stats ()

void
ncm_mset_catalog_log_current_stats (NcmMSetCatalog *mcat);

Logs the current means and standard deviations of the catalog's parameters.

Parameters

mcat

a NcmMSetCatalog

 

ncm_mset_catalog_log_current_chain_stats ()

void
ncm_mset_catalog_log_current_chain_stats
                               (NcmMSetCatalog *mcat);

Logs the current means and standard deviations of the catalog's parameters for each chain.

Parameters

mcat

a NcmMSetCatalog

 

ncm_mset_catalog_get_mset ()

NcmMSet *
ncm_mset_catalog_get_mset (NcmMSetCatalog *mcat);

Gets the NcmMSet catalog from mcat .

Parameters

mcat

a NcmMSetCatalog

 

Returns

a reference to the used NcmMSet object.

[transfer full]


ncm_mset_catalog_peek_mset ()

NcmMSet *
ncm_mset_catalog_peek_mset (NcmMSetCatalog *mcat);

Gets the NcmMSet catalog from mcat .

Parameters

mcat

a NcmMSetCatalog

 

Returns

the used NcmMSet object.

[transfer none]


ncm_mset_catalog_get_run_type ()

const gchar *
ncm_mset_catalog_get_run_type (NcmMSetCatalog *mcat);

Gets the run type string from mcat .

Parameters

mcat

a NcmMSetCatalog

 

Returns

the run type string.

[transfer none]


ncm_mset_catalog_peek_pstats ()

NcmStatsVec *
ncm_mset_catalog_peek_pstats (NcmMSetCatalog *mcat);

Peeks the parameters NcmStatsVec object.

Parameters

mcat

a NcmMSetCatalog

 

Returns

the NcmStatsVec object.

[transfer none]


ncm_mset_catalog_peek_e_mean_stats ()

NcmStatsVec *
ncm_mset_catalog_peek_e_mean_stats (NcmMSetCatalog *mcat);

Peeks the ensemble NcmStatsVec object.

Parameters

mcat

a NcmMSetCatalog

 

Returns

the NcmStatsVec object.

[transfer none]


ncm_mset_catalog_peek_chain_pstats ()

NcmStatsVec *
ncm_mset_catalog_peek_chain_pstats (NcmMSetCatalog *mcat,
                                    const guint i);

Peeks the chain NcmStatsVec object.

Parameters

mcat

a NcmMSetCatalog

 

i

chain index

 

Returns

the NcmStatsVec object.

[transfer none]


ncm_mset_catalog_peek_accept_ratio_array ()

GArray *
ncm_mset_catalog_peek_accept_ratio_array
                               (NcmMSetCatalog *mcat);

Peeks the acceptance ratio array.

Parameters

mcat

a NcmMSetCatalog

 

Returns

the acceptance ratio array.

[transfer none][element-type gdouble]


ncm_mset_catalog_peek_row ()

NcmVector *
ncm_mset_catalog_peek_row (NcmMSetCatalog *mcat,
                           guint i);

Gets the i -th row.

Parameters

mcat

a NcmMSetCatalog

 

i

the row index

 

Returns

the row with index i or NULL if not available.

[transfer none]


ncm_mset_catalog_peek_current_row ()

NcmVector *
ncm_mset_catalog_peek_current_row (NcmMSetCatalog *mcat);

Gets the last added row.

Parameters

mcat

a NcmMSetCatalog

 

Returns

last added row or NULL if empty.

[transfer none]


ncm_mset_catalog_peek_current_e_mean ()

NcmVector *
ncm_mset_catalog_peek_current_e_mean (NcmMSetCatalog *mcat);

Gets the last ensemble mean.

Parameters

mcat

a NcmMSetCatalog

 

Returns

last added ensemble mean or NULL if empty.

[transfer none]


ncm_mset_catalog_peek_current_e_var ()

NcmVector *
ncm_mset_catalog_peek_current_e_var (NcmMSetCatalog *mcat);

Gets the last ensemble variance.

Parameters

mcat

a NcmMSetCatalog

 

Returns

last added ensemble variance or NULL if empty.

[transfer none]


ncm_mset_catalog_peek_e_mean_t ()

NcmVector *
ncm_mset_catalog_peek_e_mean_t (NcmMSetCatalog *mcat,
                                guint t);

Gets the mean of the t -th ensemble.

Parameters

mcat

a NcmMSetCatalog

 

t

time

 

Returns

t -th ensemble mean.

[transfer none]


ncm_mset_catalog_peek_e_var_t ()

NcmVector *
ncm_mset_catalog_peek_e_var_t (NcmMSetCatalog *mcat,
                               guint t);

Gets the variance of the t -th ensemble.

Parameters

mcat

a NcmMSetCatalog

 

t

MCMC time

 

Returns

t -th ensemble variance.

[transfer none]


ncm_mset_catalog_get_post_lnnorm ()

gdouble
ncm_mset_catalog_get_post_lnnorm (NcmMSetCatalog *mcat,
                                  gdouble *post_lnnorm_sd);

Computes, if necessary, the posterior normalization.

Parameters

mcat

a NcmMSetCatalog

 

post_lnnorm_sd

error on the estimate of the posterior normalization.

[out]

Returns

the current the posterior normalization logarithm.


ncm_mset_catalog_get_post_lnvol ()

gdouble
ncm_mset_catalog_get_post_lnvol (NcmMSetCatalog *mcat,
                                 const gdouble level,
                                 gdouble *glnvol);

Computes the volume of the level region of the posterior. Sets into glnvol the log volume of the Gaussian approximation of the posterior.

Parameters

mcat

a NcmMSetCatalog

 

level

percentage of the posterior

 

glnvol

the log volume of the Gaussian approximation.

[out][nullable]

Returns

the current the posterior level volume logarithm.


ncm_mset_catalog_get_nth_m2lnL_percentile ()

gdouble
ncm_mset_catalog_get_nth_m2lnL_percentile
                               (NcmMSetCatalog *mcat,
                                const gdouble p,
                                guint *nth);

Computes the p percentile of the likelihood.

Parameters

mcat

a NcmMSetCatalog

 

p

percentile

 

nth

the p percentile of the likelihood.

[out][allow-none]

Returns

the p percentile of the likelihood.


ncm_mset_catalog_get_bestfit_m2lnL ()

gdouble
ncm_mset_catalog_get_bestfit_m2lnL (NcmMSetCatalog *mcat);

Parameters

mcat

a NcmMSetCatalog

 

Returns

the current bestfit $-2\ln(L)$ value.


ncm_mset_catalog_get_bestfit_row ()

NcmVector *
ncm_mset_catalog_get_bestfit_row (NcmMSetCatalog *mcat);

Parameters

mcat

a NcmMSetCatalog

 

Returns

the current bestfit parameters.

[transfer full]


ncm_mset_catalog_get_mean ()

void
ncm_mset_catalog_get_mean (NcmMSetCatalog *mcat,
                           NcmVector **mean);

Gets the current mean vector.

Parameters

mcat

a NcmMSetCatalog

 

mean

a NcmVector.

[inout][allow-none][transfer full]

ncm_mset_catalog_get_covar ()

void
ncm_mset_catalog_get_covar (NcmMSetCatalog *mcat,
                            NcmMatrix **cov);

Gets the current covariance matrix.

Parameters

mcat

a NcmMSetCatalog

 

cov

a NcmMatrix.

[inout][allow-none][transfer full]

ncm_mset_catalog_get_full_covar ()

void
ncm_mset_catalog_get_full_covar (NcmMSetCatalog *mcat,
                                 NcmMatrix **cov);

Gets the current full (including additional values) covariance matrix.

Parameters

mcat

a NcmMSetCatalog

 

cov

a NcmMatrix.

[inout][allow-none][transfer full]

ncm_mset_catalog_log_full_covar ()

void
ncm_mset_catalog_log_full_covar (NcmMSetCatalog *mcat);

Logs the current full (including additional values) covariance matrix.

Parameters

mcat

a NcmMSetCatalog

 

ncm_mset_catalog_estimate_autocorrelation_tau ()

void
ncm_mset_catalog_estimate_autocorrelation_tau
                               (NcmMSetCatalog *mcat,
                                gboolean force_single_chain);

Updates the internal estimates of the integrate autocorrelation time.

Parameters

mcat

a NcmMSetCatalog

 

force_single_chain

whether to force the catalog to be treated as a single chain

 

ncm_mset_catalog_peek_autocorrelation_tau ()

NcmVector *
ncm_mset_catalog_peek_autocorrelation_tau
                               (NcmMSetCatalog *mcat);

Gets the last estimate of the autocorrelation tau calculated in the last call of ncm_mset_catalog_estimate_autocorrelation_tau().

Parameters

mcat

a NcmMSetCatalog

 

Returns

the last estimate of the autocorrelation tau.

[transfer none]


ncm_mset_catalog_get_param_shrink_factor ()

gdouble
ncm_mset_catalog_get_param_shrink_factor
                               (NcmMSetCatalog *mcat,
                                guint p);

Gets the current shrink factor of parameter p .

Parameters

mcat

a NcmMSetCatalog

 

p

parameter id.

 

Returns

the shrink factor of p .


ncm_mset_catalog_get_shrink_factor ()

gdouble
ncm_mset_catalog_get_shrink_factor (NcmMSetCatalog *mcat);

Gets the current shrink factor which is the multivatiate potential scale reduction factor (MPSRF), namely, $$\hat{R}^p = \sqrt{\frac{n - 1}{n} + \left( \frac{m + 1}{m} \right) \lambda_1},$$ where $n$ is the number of points of one chain, $m$ is the number of chains and $\lambda_1$ is the largest eigenvalue of the positive definite matrix $W^{-1}B/n$.

$W$ is the within-chain covariance: $$W = $$ arithmetical mean of the covariance matrices of each chain.

$B$ is the between-chain covariance: $$B = $$ covariance between the means of each chain.

Refined version: $$\hat{R}^p = \sqrt{\frac{\hat{d} + 3}{\hat{d} + 1} \left(\frac{n - 1}{n} + \left( \frac{m + 1}{m} \right) \lambda_1\right)},$$ where $\hat{d} = 2 \hat{V}^2 / \widehat{Var}(\hat{V})$, $$\hat{V} = \frac{n -1}{n}W + \frac{m + 1}{m} \frac{B}{n}.$$

Some references for this MCMC convergence diagnostic: Brooks and Gelman (1998), Gelman and Rubin (1992), SAS/STAT.

Parameters

mcat

a NcmMSetCatalog

 

Returns

the shrink factor $\hat{R}^p$


ncm_mset_catalog_param_pdf ()

void
ncm_mset_catalog_param_pdf (NcmMSetCatalog *mcat,
                            guint i);

Bins and calculates the pdf associated with the parameter i .

Parameters

mcat

a NcmMSetCatalog

 

i

parameter index.

 

ncm_mset_catalog_param_pdf_pvalue ()

gdouble
ncm_mset_catalog_param_pdf_pvalue (NcmMSetCatalog *mcat,
                                   gdouble pvalue,
                                   gboolean both);

Calculates the p-value associated with the parameter value pvalue .

Parameters

mcat

a NcmMSetCatalog

 

pvalue

parameter value

 

both

one or both sides p-value

 

Returns

the p-value.


ncm_mset_catalog_calc_ci_direct ()

NcmMatrix *
ncm_mset_catalog_calc_ci_direct (NcmMSetCatalog *mcat,
                                 NcmMSetFunc *func,
                                 NcmVector *x_v,
                                 GArray *p_val);

Calculates the mean and the confidence interval (CI) for the value of func for each p-value in p_val . It stores the results in a NcmVector, where the first element contains the mean and the following contain the lower and upper bounds for each p-value in p_val .

This function calculates the quantiles directly using: gsl_stats_quantile_from_sorted_data for this reason it must allocates the catalog size times the number of elements in x , for a less memory intensive version use ncm_mset_catalog_calc_ci_interp().

The NcmMSetFunc func must be of dimension one.

Example:

If p_val contains two values ($1\sigma$) 0.6827 and ($\sigma$) 0.9545, the first element will contain the mean, the second and third, the lower and upper bounds, respectively. Then, the fourth and fifth elements the lower and upper bounds of $2\sigma$ CI.

Parameters

mcat

a NcmMSetCatalog

 

func

a NcmMSetFunc of type n-n

 

x_v

NcmVector of arguments of func

 

p_val

p-values for the confidence intervals.

[element-type double]

Returns

a NcmVector containing the mean and lower/upper bound of the confidence interval for func .

[transfer full]


ncm_mset_catalog_calc_ci_interp ()

NcmMatrix *
ncm_mset_catalog_calc_ci_interp (NcmMSetCatalog *mcat,
                                 NcmMSetFunc *func,
                                 NcmVector *x_v,
                                 GArray *p_val,
                                 guint nodes,
                                 NcmFitRunMsgs mtype);

Calculates the mean and the confidence interval (CI) for the value of func for each p-value in p_val . It stores the results in a NcmMatrix, where the first element contains the mean and the following contain the lower and upper bounds for each p-value in p_val .

This function creates an approximation of the distribution for each value of the function func and calculates the quantiles from this approximation.

The NcmMSetFunc func must be of dimension one.

Example:

If p_val contains two values ($1\sigma$) 0.6827 and ($\sigma$) 0.9545, the first element will contain the mean, the second and third, the lower and upper bounds, respectively. Then, the fourth and fifth elements the lower and upper bounds of $2\sigma$ CI.

Parameters

mcat

a NcmMSetCatalog

 

func

a NcmMSetFunc of type n-n

 

x_v

NcmVector of arguments of func

 

p_val

p-values for the confidence intervals.

[element-type double]

nodes

number of nodes in the distribution approximations

 

mtype

NcmFitRunMsgs log level

 

Returns

a NcmMatrix containing the mean and lower/upper bound of the confidence interval for func .

[transfer full]


ncm_mset_catalog_calc_pvalue ()

NcmMatrix *
ncm_mset_catalog_calc_pvalue (NcmMSetCatalog *mcat,
                              NcmMSetFunc *func,
                              NcmVector *x_v,
                              GArray *lim,
                              guint nodes,
                              NcmFitRunMsgs mtype);

Calculates the p-values for the value of func for each limit in lim , integrating the probability distribution function from the left tail to lim . It stores the results in a NcmMatrix, where the first element contains the p-value with respect to the first lim , and so on.

The NcmMSetFunc func must be of dimension one.

Example:

Parameters

mcat

a NcmMSetCatalog

 

func

a NcmMSetFunc of type n-n

 

x_v

NcmVector of arguments of func

 

lim

integration limits to compute the p-value.

[element-type double]

nodes

number of nodes in the distribution approximations

 

mtype

NcmFitRunMsgs log level

 

Returns

a NcmMatrix containing the p-values for func .

[transfer full]


ncm_mset_catalog_calc_distrib ()

NcmStatsDist1d *
ncm_mset_catalog_calc_distrib (NcmMSetCatalog *mcat,
                               NcmMSetFunc *func,
                               NcmFitRunMsgs mtype);

Calculates the distribution of func .

This function creates an approximation of the distribution for each value of the function func calculated in each model in mcat .

Parameters

mcat

a NcmMSetCatalog

 

func

a NcmMSetFunc of type 0-1

 

mtype

NcmFitRunMsgs log level

 

Returns

a NcmStatsDist1d describing the distribution.

[transfer full]


ncm_mset_catalog_calc_param_distrib ()

NcmStatsDist1d *
ncm_mset_catalog_calc_param_distrib (NcmMSetCatalog *mcat,
                                     const NcmMSetPIndex *pi,
                                     NcmFitRunMsgs mtype);

Calculates the distribution of parameter pi .

This function creates an approximation of the distribution for each value of the parameter pi in mcat .

Parameters

mcat

a NcmMSetCatalog

 

pi

a NcmMSetPIndex

 

mtype

NcmFitRunMsgs log level

 

Returns

a NcmStatsDist1d describing the distribution.

[transfer full]


ncm_mset_catalog_calc_add_param_distrib ()

NcmStatsDist1d *
ncm_mset_catalog_calc_add_param_distrib
                               (NcmMSetCatalog *mcat,
                                guint add_param,
                                NcmFitRunMsgs mtype);

Calculates the distribution of parameter pi .

This function creates an approximation of the distribution for each value of the parameter pi in mcat .

Parameters

mcat

a NcmMSetCatalog

 

add_param

additional parameter index

 

mtype

NcmFitRunMsgs log level

 

Returns

a NcmStatsDist1d describing the distribution.

[transfer full]


ncm_mset_catalog_calc_param_ensemble_evol ()

void
ncm_mset_catalog_calc_param_ensemble_evol
                               (NcmMSetCatalog *mcat,
                                const NcmMSetPIndex *pi,
                                guint nsteps,
                                NcmFitRunMsgs mtype,
                                NcmVector **pval,
                                NcmMatrix **t_evol);

Calculates the time evolution of the parameter pi distribution.

Parameters

mcat

a NcmMSetCatalog

 

pi

a NcmMSetPIndex

 

nsteps

number of steps to calculate the distribution

 

mtype

NcmFitRunMsgs log level

 

pval

output NcmVector containing parameter values.

[out callee-allocates]

t_evol

output NcmMatrix containing probability distribution evolution.

[out callee-allocates]

ncm_mset_catalog_calc_add_param_ensemble_evol ()

void
ncm_mset_catalog_calc_add_param_ensemble_evol
                               (NcmMSetCatalog *mcat,
                                guint add_param,
                                guint nsteps,
                                NcmFitRunMsgs mtype,
                                NcmVector **pval,
                                NcmMatrix **t_evol);

Calculates the time evolution of the parameter pi distribution.

Parameters

mcat

a NcmMSetCatalog

 

add_param

additional parameter index

 

nsteps

number of steps to calculate the distribution

 

mtype

NcmFitRunMsgs log level

 

pval

output NcmVector containing parameter values.

[out callee-allocates]

t_evol

output NcmMatrix containing probability distribution evolution.

[out callee-allocates]

ncm_mset_catalog_trim ()

void
ncm_mset_catalog_trim (NcmMSetCatalog *mcat,
                       const guint tc,
                       const guint thin);

Drops all points in the catalog such that $t < t_c$ and skips every thin -1 rows, creating a thinner catalog. This function trims the first $t_c \times n_\mathrm{chains}$ points from the catalog. Creates a backup of the original file.

Parameters

mcat

a NcmMSetCatalog

 

tc

time divisor $t_c$

 

thin

thinning factor

 

ncm_mset_catalog_trim_p ()

void
ncm_mset_catalog_trim_p (NcmMSetCatalog *mcat,
                         const gdouble p);

Drops all points in the catalog such that the first p percent of the catalog is dropped.

Parameters

mcat

a NcmMSetCatalog

 

p

percentage of the trim

 

ncm_mset_catalog_trim_oob ()

guint
ncm_mset_catalog_trim_oob (NcmMSetCatalog *mcat,
                           const gchar *out_file);

Remove all points that are outside the bounds defined by the catalog mset file. The catalog will always have a single chain after the trimming. The result is saved to out_file .

Parameters

mcat

a NcmMSetCatalog

 

out_file

output filename

 

ncm_mset_catalog_remove_last_ensemble ()

void
ncm_mset_catalog_remove_last_ensemble (NcmMSetCatalog *mcat);

Removes the last ensemble point in the catalog, i.e., removes the last 'number of chains' points of the catalog. Creates a backup of the original file.

Parameters

mcat

a NcmMSetCatalog

 

ncm_mset_catalog_calc_max_ess_time ()

guint
ncm_mset_catalog_calc_max_ess_time (NcmMSetCatalog *mcat,
                                    const guint ntests,
                                    gdouble *max_ess,
                                    NcmFitRunMsgs mtype);

Calculates the time $t_m$ that maximizes the ESS for all elements of the catalog. If the number of chains in the catalog is larger than one, it considers the whole catalog otherwise it considers the ensemble means. The variable ntests control the number of divisions where the ESS will be calculated, if it is zero the default 10 tests will be used.

Parameters

mcat

a NcmMSetCatalog

 

ntests

number of tests

 

max_ess

the maximum effective sample size (ESS).

[out]

mtype

NcmFitRunMsgs log level

 

Returns

The lowest time $t_m$.


ncm_mset_catalog_calc_heidel_diag ()

guint
ncm_mset_catalog_calc_heidel_diag (NcmMSetCatalog *mcat,
                                   const guint ntests,
                                   const gdouble pvalue,
                                   NcmFitRunMsgs mtype);

Applies the Heidelberger and Welch's convergence diagnostic to the catalog, see ncm_stats_vec_heidel_diag() for mode details. If the number of chains in the catalog is larger than one, it considers the whole catalog otherwise it considers the ensemble means. The variable ntests control the number of divisions where the test will be applied, if it is zero the default 10 tests will be used.

Parameters

mcat

a NcmMSetCatalog

 

ntests

number of tests

 

pvalue

the required Schruben test p-value

 

mtype

NcmFitRunMsgs log level

 

Returns

The lowest time $t_m$ where all parameters pass the test with pvalue or zero if all tests fail.


ncm_mset_catalog_calc_const_break ()

guint
ncm_mset_catalog_calc_const_break (NcmMSetCatalog *mcat,
                                   guint p,
                                   NcmFitRunMsgs mtype);

Fits the model: $$f(t) = c_0 + \theta_r(t-t_0)\left[c_1(t-t_0) + c_2\frac{(t-t_0)^2}{2}\right].$$ to estimate the time $t_0$ where the chain stops evolving.

Parameters

mcat

a NcmMSetCatalog

 

p

param id

 

mtype

NcmFitRunMsgs log level

 

Returns

$t_0$.


ncm_mset_catalog_trim_by_type ()

void
ncm_mset_catalog_trim_by_type (NcmMSetCatalog *mcat,
                               guint ntests,
                               NcmMSetCatalogTrimType trim_type,
                               NcmFitRunMsgs mtype);

Calculates the time $t_m$ that satisfies all trimming options in trim_type . Then drops all elements of the catalog and drops all points $t < t_m$.

Parameters

mcat

a NcmMSetCatalog

 

ntests

number of tests

 

trim_type

the trimming type to apply NcmMSetCatalogTrimType

 

mtype

NcmFitRunMsgs log level

 

ncm_mset_catalog_max_ess_time_by_chain ()

guint
ncm_mset_catalog_max_ess_time_by_chain
                               (NcmMSetCatalog *mcat,
                                const guint ntests,
                                gdouble *max_ess,
                                NcmFitRunMsgs mtype);

Calculates the time $t_m$ that maximizes the ESS for each chain of the catalog. The variable ntests control the number of divisions where the ESS will be calculated, if it is zero the default 10 tests will be used.

Parameters

mcat

a NcmMSetCatalog

 

ntests

number of tests

 

max_ess

the maximum effective sample size (ESS).

[out]

mtype

NcmFitRunMsgs log level

 

Returns

The lowest time $t_m$.


ncm_mset_catalog_heidel_diag_by_chain ()

guint
ncm_mset_catalog_heidel_diag_by_chain (NcmMSetCatalog *mcat,
                                       const guint ntests,
                                       const gdouble pvalue,
                                       gdouble *wp_pvalue,
                                       NcmFitRunMsgs mtype);

Calculates the lowest time $t_m$ where all chains satisfy the Heidelberger and Welch's convergence diagnostic. The variable ntests control the number of divisions where the test will be calculated, if it is zero the default 10 tests will be used.

Parameters

mcat

a NcmMSetCatalog

 

ntests

number of tests

 

pvalue

required p-value

 

wp_pvalue

worst parameter p-value.

[out]

mtype

NcmFitRunMsgs log level

 

Returns

The lowest time $t_m$.

Types and Values

NCM_TYPE_MSET_CATALOG

#define NCM_TYPE_MSET_CATALOG (ncm_mset_catalog_get_type ())

enum NcmMSetCatalogSync

Catalog sync modes.

Members

NCM_MSET_CATALOG_SYNC_DISABLE

Catalog will be synchronized only when closing the file or with an explicit call of ncm_mset_catalog_sync().

 

NCM_MSET_CATALOG_SYNC_AUTO

Catalog will be synchronized in every catalog addition.

 

NCM_MSET_CATALOG_SYNC_TIMED

Catalog will be synchronized with a minimum time interval between syncs.

 

enum NcmMSetCatalogTrimType

See ncm_mset_catalog_calc_max_ess_time() and ncm_mset_catalog_calc_heidel_diag().

Members

NCM_MSET_CATALOG_TRIM_TYPE_ESS

trim the catalog using the maximum ess criterium.

 

NCM_MSET_CATALOG_TRIM_TYPE_HEIDEL

trim the catalog using the Heidelberger and Welch’s convergence diagnostic.

 

NCM_MSET_CATALOG_TRIM_TYPE_CK

trim the catalog using the estimate of the time where $-2\ln(L)$ stops evolving.

 

NCM_MSET_CATALOG_TRIM_TYPE_ALL

trim the catalog using all tests above.

 

enum NcmMSetCatalogPostNormMethod

See ncm_mset_catalog_calc_max_ess_time() and ncm_mset_catalog_calc_heidel_diag().

Members

NCM_MSET_CATALOG_POST_LNNORM_METHOD_HYPERBOX

Uses a MVND limited in a hyperbox.

 

NCM_MSET_CATALOG_POST_LNNORM_METHOD_HYPERBOX_BS

Uses a MVND limited in a hyperbox and bootstrap to estimate error.

 

NCM_MSET_CATALOG_POST_LNNORM_METHOD_ELIPSOID

Uses a MVND limited in elipsoids.

 

enum NcmMSetCatalogTauMethod

Method used to estimate the autocorrelation time $\tau$.

Members

NCM_MSET_CATALOG_TAU_METHOD_ACOR

uses the autocorrelation to estimate $\tau$.

 

NCM_MSET_CATALOG_TAU_METHOD_AR_MODEL

uses an autoregressive model fitting to estimate $\tau$.

 

NCM_MSET_CATALOG_EXTNAME

#define NCM_MSET_CATALOG_EXTNAME "NcmMSetCatalog:DATA"

NCM_MSET_CATALOG_M2LNL_COLNAME

#define NCM_MSET_CATALOG_M2LNL_COLNAME "NcmFit:m2lnL"

NCM_MSET_CATALOG_M2LNL_SYMBOL

#define NCM_MSET_CATALOG_M2LNL_SYMBOL "-2\\ln(L)"

NCM_MSET_CATALOG_FIRST_ID_LABEL

#define NCM_MSET_CATALOG_FIRST_ID_LABEL "FIRST_ID"

NCM_MSET_CATALOG_M2LNP_ID_LABEL

#define NCM_MSET_CATALOG_M2LNP_ID_LABEL "M2LNP_ID"

NCM_MSET_CATALOG_RNG_ALGO_LABEL

#define NCM_MSET_CATALOG_RNG_ALGO_LABEL "RNG_ALGO"

NCM_MSET_CATALOG_RNG_SEED_LABEL

#define NCM_MSET_CATALOG_RNG_SEED_LABEL "RNG_SEED"

NCM_MSET_CATALOG_RNG_STAT_LABEL

#define NCM_MSET_CATALOG_RNG_STAT_LABEL "RNG_STAT"

NCM_MSET_CATALOG_RNG_INIS_LABEL

#define NCM_MSET_CATALOG_RNG_INIS_LABEL "RNG_INIS"

NCM_MSET_CATALOG_NROWS_LABEL

#define NCM_MSET_CATALOG_NROWS_LABEL "NAXIS2"

NCM_MSET_CATALOG_RTYPE_LABEL

#define NCM_MSET_CATALOG_RTYPE_LABEL "RTYPE"

NCM_MSET_CATALOG_NCHAINS_LABEL

#define NCM_MSET_CATALOG_NCHAINS_LABEL "NCHAINS"

NCM_MSET_CATALOG_NADDVAL_LABEL

#define NCM_MSET_CATALOG_NADDVAL_LABEL "NADDVAL"

NCM_MSET_CATALOG_WEIGHTED_LABEL

#define NCM_MSET_CATALOG_WEIGHTED_LABEL "WEIGHTED"

NCM_MSET_CATALOG_RTYPE_BSTRAP_MEAN

#define NCM_MSET_CATALOG_RTYPE_BSTRAP_MEAN "bootstrap-mean"

NCM_MSET_CATALOG_RTYPE_UNDEFINED

#define NCM_MSET_CATALOG_RTYPE_UNDEFINED "undefined-run"

NCM_MSET_CATALOG_FSYMB_LABEL

#define NCM_MSET_CATALOG_FSYMB_LABEL "FSYMB"

NCM_MSET_CATALOG_ASYMB_LABEL

#define NCM_MSET_CATALOG_ASYMB_LABEL "ASYMB"

NCM_MSET_CATALOG_DIST_EST_SD_SCALE

#define NCM_MSET_CATALOG_DIST_EST_SD_SCALE (1.0e-3)

NcmMSetCatalog

typedef struct _NcmMSetCatalog NcmMSetCatalog;

Property Details

The “burnin” property

  “burnin”                   glong

Burn-in size.

Owner: NcmMSetCatalog

Flags: Read / Write / Construct

Allowed values: >= 0

Default value: 0


The “filename” property

  “filename”                 char *

Catalog filename.

Owner: NcmMSetCatalog

Flags: Read / Write / Construct

Default value: NULL


The “m2lnp-var” property

  “m2lnp-var”                int

Index of the variable representing m2lnp.

Owner: NcmMSetCatalog

Flags: Read / Write / Construct

Allowed values: >= -1

Default value: -1


The “mset” property

  “mset”                     NcmMSet *

NcmMSet object.

Owner: NcmMSetCatalog

Flags: Read / Write / Construct Only


The “nadd-val-names” property

  “nadd-val-names”           GStrv

Additional value names.

Owner: NcmMSetCatalog

Flags: Read / Write / Construct Only


The “nadd-val-symbols” property

  “nadd-val-symbols”         GStrv

Additional value symbols.

Owner: NcmMSetCatalog

Flags: Read / Write / Construct Only


The “nadd-vals” property

  “nadd-vals”                guint

Number of additional values.

Owner: NcmMSetCatalog

Flags: Read / Write / Construct Only

Default value: 0


The “nchains” property

  “nchains”                  guint

Number of different chains in the catalog.

Owner: NcmMSetCatalog

Flags: Read / Write / Construct Only

Allowed values: >= 1

Default value: 1


The “read-only” property

  “read-only”                gboolean

If the fits catalogue must be open in the readonly mode.

Owner: NcmMSetCatalog

Flags: Read / Write / Construct Only

Default value: FALSE


The “rng” property

  “rng”                      NcmRNG *

Random number generator object.

Owner: NcmMSetCatalog

Flags: Read / Write


The “run-type-string” property

  “run-type-string”          char *

Run type string.

Owner: NcmMSetCatalog

Flags: Read / Write / Construct

Default value: "undefined-run"


The “smode” property

  “smode”                    NcmMSetCatalogSync

Catalog sync mode.

Owner: NcmMSetCatalog

Flags: Read / Write / Construct

Default value: NCM_MSET_CATALOG_SYNC_AUTO


The “sync-interval” property

  “sync-interval”            double

Data sync interval.

Owner: NcmMSetCatalog

Flags: Read / Write / Construct

Allowed values: [0,1000]

Default value: 10


The “tau-method” property

  “tau-method”               NcmMSetCatalogTauMethod

Method used to calculate the autocorrelation time.

Owner: NcmMSetCatalog

Flags: Read / Write / Construct

Default value: NCM_MSET_CATALOG_TAU_METHOD_AR_MODEL


The “weighted” property

  “weighted”                 gboolean

Catalog with weighted rows.

Owner: NcmMSetCatalog

Flags: Read / Write / Construct Only

Default value: FALSE