Class

NumCosmoMathFitESMCMC

Description [src]

final class NumCosmoMath.FitESMCMC : GObject.Object
{
  /* No available fields */
}

Ensemble sampler Markov Chain Monte Carlo analysis.

NcmFitESMCMC is a class that implements the Ensemble sampler Markov Chain Monte Carlo analysis. The object requires a NcmFit object to be set before running the analysis. The initial points are sampled from a NcmMSetTransKern object. The walkers are defined by a NcmFitESMCMCWalker object.

The NcmFitESMCMC object can be run in parallel using MPI.

Ancestors

Constructors

ncm_fit_esmcmc_new

Creates a new NcmFitESMCMC object using the given parameters.

ncm_fit_esmcmc_new_funcs_array

Creates a new NcmFitESMCMC object using the given parameters. The funcs_array is used to compute extra columns in the catalog. The functions must be scalar and constant.

Functions

ncm_fit_esmcmc_clear

Decreases the reference count of esmcmc by one. If the reference count reaches zero, all memory allocated by the object is released. The esmcmc pointer is set to NULL.

Instance methods

ncm_fit_esmcmc_end_run

Terminates the run. This method should be called after all run related methods.

ncm_fit_esmcmc_free

Decreases the reference count of esmcmc by one. If the reference count reaches zero, all memory allocated by the object is released.

ncm_fit_esmcmc_get_accept_ratio

The acceptance ratio is the ratio of accepted proposals over the total number of proposals.

ncm_fit_esmcmc_get_accept_ratio_last_update

The acceptance ratio is the ratio of accepted proposals over the total number of proposals during the last update.

ncm_fit_esmcmc_get_catalog

Gets the generated catalog of esmcmc.

ncm_fit_esmcmc_get_offboard_ratio

The offboard ratio is the ratio of offboard proposals over the total number of proposals.

ncm_fit_esmcmc_get_offboard_ratio_last_update

The offboard ratio is the ratio of offboard proposals over the total number of proposals during the last update.

ncm_fit_esmcmc_get_skip_check

Get whether to skip the check of the last ensemble in the catalog when continuing a run.

ncm_fit_esmcmc_has_rng
No description available.

ncm_fit_esmcmc_mean_covar

Calculates the mean and covariance of the generated catalog.

ncm_fit_esmcmc_peek_catalog

Gets the generated catalog of esmcmc.

ncm_fit_esmcmc_peek_fit

Gets the NcmFit object used by the sampler.

ncm_fit_esmcmc_peek_ser

Peeks the internal NcmSerialize object from esmcmc.

ncm_fit_esmcmc_peek_walker
No description available.

ncm_fit_esmcmc_ref

Increases the reference count of esmcmc by one.

ncm_fit_esmcmc_reset

Resets the run.

ncm_fit_esmcmc_run

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.

ncm_fit_esmcmc_run_burnin

Runs the ESMCMC algorithm until the prerun-th iterations are reached. Then it runs ntimes times the estimated constant break.

ncm_fit_esmcmc_run_lre

Runs the ESMCMC algorithm until the least relative error is less than lre. It runs at least prerun pre-runs before starting the algorithm.

ncm_fit_esmcmc_set_auto_trim

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

ncm_fit_esmcmc_set_auto_trim_div

Sets the divisor for the auto trim tests.

ncm_fit_esmcmc_set_auto_trim_type

Sets the trim type.

ncm_fit_esmcmc_set_data_file

Sets the data file to use for the chains catalog.

ncm_fit_esmcmc_set_max_runs_time

Sets the maximum time for the runs between tests.

ncm_fit_esmcmc_set_min_runs

Sets the minimum number of runs between tests.

ncm_fit_esmcmc_set_mtype

Sets the type of messages to use when running.

ncm_fit_esmcmc_set_nthreads

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

ncm_fit_esmcmc_set_rng

Sets the random number generator to use.

ncm_fit_esmcmc_set_sampler
No description available.

ncm_fit_esmcmc_set_skip_check

Set whether to skip the check of the last ensemble in the catalog when continuing a run.

ncm_fit_esmcmc_start_run

Starts the run. This method should be called before any other run related method.

ncm_fit_esmcmc_use_mpi

If use_mpi is TRUE then the parallelization will be accomplished using MPI if any slaves are available. If no slaves are available then it falls back to threads.

ncm_fit_esmcmc_validate

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 occurred during a multithread evaluation of the likelihood.

Methods inherited from GObject (43)

Please see GObject for a full list of methods.

Properties

NumCosmoMath.FitESMCMC:auto-trim
No description available.

NumCosmoMath.FitESMCMC:auto-trim-div
No description available.

NumCosmoMath.FitESMCMC:data-file
No description available.

NumCosmoMath.FitESMCMC:fit
No description available.

NumCosmoMath.FitESMCMC:function-array
No description available.

NumCosmoMath.FitESMCMC:intermediary-log
No description available.

NumCosmoMath.FitESMCMC:log-time-interval
No description available.

NumCosmoMath.FitESMCMC:lre-step
No description available.

NumCosmoMath.FitESMCMC:max-runs-time
No description available.

NumCosmoMath.FitESMCMC:min-runs
No description available.

NumCosmoMath.FitESMCMC:mtype
No description available.

NumCosmoMath.FitESMCMC:nthreads
No description available.

NumCosmoMath.FitESMCMC:nwalkers
No description available.

NumCosmoMath.FitESMCMC:sampler
No description available.

NumCosmoMath.FitESMCMC:skip-check
No description available.

NumCosmoMath.FitESMCMC:trim-type
No description available.

NumCosmoMath.FitESMCMC:use-mpi
No description available.

NumCosmoMath.FitESMCMC:walker
No description available.

Signals

Signals inherited from GObject (1)
GObject::notify

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

Class structure

struct NumCosmoMathFitESMCMCClass {
  GObjectClass parent_class;
  
}

No description available.

Class members
parent_class: GObjectClass

No description available.