NLopt Interface Object: NumCosmo Reference Manual

NLopt Interface Object

NLopt Interface Object — Interface for NLopt optmization library

Functions

NcmFit *	ncm_fit_nlopt_new ()
NcmFit *	ncm_fit_nlopt_local_new ()
void	ncm_fit_nlopt_set_algo ()
void	ncm_fit_nlopt_set_local_algo ()
NcmFit *	ncm_fit_nlopt_new_by_name ()
NcmFit *	ncm_fit_nlopt_new_default ()

Properties

NcmFitNloptAlgorithm	algorithm	Read / Write / Construct
NcmFitNloptAlgorithm	local-algorithm	Read / Write

Types and Values

#define	NCM_TYPE_FIT_NLOPT
	NcmFitNLOpt

Object Hierarchy

    GObject
    ╰── NcmFit
        ╰── NcmFitNLOpt

Description

A subclass of NcmFit that uses the NLopt library to perform the optimization.

Functions

ncm_fit_nlopt_new ()

NcmFit *
ncm_fit_nlopt_new (NcmLikelihood *lh,
                   NcmMSet *mset,
                   NcmFitGradType gtype,
                   NcmFitNloptAlgorithm algo);

Creates a new NcmFitNLOpt object using the specified algo .

Parameters

lh	a NcmLikelihood
mset	a NcmMSet
gtype	a NcmFitGradType
algo	a NcmFitNloptAlgorithm

Returns

a new NcmFitNLOpt object.

[transfer full]

ncm_fit_nlopt_local_new ()

NcmFit *
ncm_fit_nlopt_local_new (NcmLikelihood *lh,
                         NcmMSet *mset,
                         NcmFitGradType gtype,
                         NcmFitNloptAlgorithm algo,
                         NcmFitNloptAlgorithm local_algo);

Creates a new NcmFitNLOpt object using the specified algo and local_algo . The local_algo is used to refine the solution found by algo .

Parameters

lh	a NcmLikelihood
mset	a NcmMSet
gtype	a NcmFitGradType
algo	a NcmFitNloptAlgorithm
local_algo	a NcmFitNloptAlgorithm

Returns

a new NcmFitNLOpt object.

[transfer full]

ncm_fit_nlopt_set_algo ()

void
ncm_fit_nlopt_set_algo (NcmFitNLOpt *fit_nlopt,
                        NcmFitNloptAlgorithm algo);

Sets the algorithm to be used by fit_nlopt .

Parameters

fit_nlopt	a NcmFitNLOpt.
algo	a NcmFitNloptAlgorithm.

ncm_fit_nlopt_set_local_algo ()

void
ncm_fit_nlopt_set_local_algo (NcmFitNLOpt *fit_nlopt,
                              NcmFitNloptAlgorithm algo);

Sets the local algorithm to be used by fit_nlopt . This algorithm is used to refine the solution found by the main algorithm.

Parameters

fit_nlopt	a NcmFitNLOpt.
algo	a NcmFitNloptAlgorithm.

ncm_fit_nlopt_new_by_name ()

NcmFit *
ncm_fit_nlopt_new_by_name (NcmLikelihood *lh,
                           NcmMSet *mset,
                           NcmFitGradType gtype,
                           gchar *algo_name);

Creates a new NcmFitNLOpt object using the specified algo_name .

Parameters

lh	a NcmLikelihood
mset	a NcmMSet
gtype	a NcmFitGradType
algo_name	a string containing the name of the algorithm to be used

Returns

a new NcmFitNLOpt object.

[transfer full]

ncm_fit_nlopt_new_default ()

NcmFit *
ncm_fit_nlopt_new_default (NcmLikelihood *lh,
                           NcmMSet *mset,
                           NcmFitGradType gtype);

Creates a new NcmFitNLOpt object using the default algorithm.

Parameters

lh	a NcmLikelihood
mset	a NcmMSet
gtype	a NcmFitGradType

Returns

a new NcmFitNLOpt object.

[transfer full]

Types and Values

NCM_TYPE_FIT_NLOPT

#define NCM_TYPE_FIT_NLOPT (ncm_fit_nlopt_get_type ())

NcmFitNLOpt

typedef struct _NcmFitNLOpt NcmFitNLOpt;

Property Details

The `“algorithm”` property

  “algorithm”                NcmFitNloptAlgorithm

NLOpt algorithm.

Owner: NcmFitNLOpt

Flags: Read / Write / Construct

Default value: NLOPT_LN_NELDERMEAD

The `“local-algorithm”` property

  “local-algorithm”          NcmFitNloptAlgorithm

NLOpt local algorithm.

Owner: NcmFitNLOpt

Flags: Read / Write

Default value: NLOPT_LN_NELDERMEAD