NcmCfg

NcmCfg — Library configuration and helper functions.

Types and Values

Description

FIXME

Functions

ncm_cfg_init ()

void
ncm_cfg_init (void);

Main library configuration function. Must be called before any other function of NumCosmo.

Initializes internal variables and sets all other library number of threads to one.

See also: ncm_cfg_init_full() ncm_cfg_init_full_ptr().


ncm_cfg_init_full_ptr ()

void
ncm_cfg_init_full_ptr (gint *argc,
                       gchar ***argv);

Main library configuration function. Must be called before any other function of NumCosmo.

Initializes internal variables and sets all other library number of threads to one. This function passes the arguments to other libraries, e.g, MPI. If that is not necessary ncm_cfg_init() should be used. This version should be used from C applications passing argc and argv pointers from main.

See also: ncm_cfg_init() ncm_cfg_init_full().

Parameters

argc

a pointer to argc

 

argv

a pointer to argv.

[array length=argc]

ncm_cfg_init_full ()

gchar **
ncm_cfg_init_full (gint argc,
                   gchar **argv);

Main library configuration function. Must be called before any other function of NumCosmo.

Initializes internal variables and sets all other library number of threads to one. This function passes the arguments to other libraries, e.g, MPI. If that is not necessary ncm_cfg_init() should be used. This version is compatible with bindings and can be safely called from other languages.

See also: ncm_cfg_init() ncm_cfg_init_full_ptr().

Parameters

argc

a pointer to argc

 

argv

a pointer to argv.

[array length=argc]

Returns

the possibly modified argv.

[transfer full][array zero-terminated=1]


ncm_cfg_enable_gsl_err_handler ()

void
ncm_cfg_enable_gsl_err_handler (void);

FIXME


ncm_cfg_register_obj ()

void
ncm_cfg_register_obj (GType obj);

FIXME

Parameters

obj

FIXME

 

ncm_cfg_mpi_nslaves ()

guint
ncm_cfg_mpi_nslaves (void);

Returns

the total number of available slaves.


ncm_cfg_get_fullpath ()

gchar *
ncm_cfg_get_fullpath (const gchar *filename,
                      ...);

FIXME

Parameters

filename

FIXME

 

...

FIXME

 

Returns

FIXME


ncm_cfg_keyfile_to_arg ()

void
ncm_cfg_keyfile_to_arg (GKeyFile *kfile,
                        const gchar *group_name,
                        GOptionEntry *entries,
                        gchar **argv,
                        gint *argc);

FIXME

Parameters

kfile

FIXME

 

group_name

FIXME

 

entries

FIXME

 

argv

FIXME

 

argc

FIXME

 

ncm_cfg_entries_to_keyfile ()

void
ncm_cfg_entries_to_keyfile (GKeyFile *kfile,
                            const gchar *group_name,
                            GOptionEntry *entries);

FIXME

Parameters

kfile

FIXME

 

group_name

FIXME

 

entries

FIXME

 

ncm_cfg_string_to_comment ()

gchar *
ncm_cfg_string_to_comment (const gchar *str);

FIXME

Parameters

str

FIXME

 

Returns

FIXME.

[transfer full]


ncm_cfg_get_enum_by_id_name_nick ()

const GEnumValue *
ncm_cfg_get_enum_by_id_name_nick (GType enum_type,
                                  const gchar *id_name_nick);

FIXME

Parameters

enum_type

FIXME

 

id_name_nick

FIXME

 

Returns

FIXME


ncm_cfg_enum_get_value ()

const GEnumValue *
ncm_cfg_enum_get_value (GType enum_type,
                        guint n);

FIXME

Parameters

enum_type

FIXME

 

n

FIXME

 

Returns

.

[transfer none]


ncm_cfg_enum_print_all ()

void
ncm_cfg_enum_print_all (GType enum_type,
                        const gchar *header);

FIXME

Parameters

enum_type

FIXME

 

header

FIXME

 

ncm_cfg_lock_plan_fftw ()

void
ncm_cfg_lock_plan_fftw (void);

FIXME


ncm_cfg_unlock_plan_fftw ()

void
ncm_cfg_unlock_plan_fftw (void);

FIXME


ncm_cfg_load_fftw_wisdom ()

gboolean
ncm_cfg_load_fftw_wisdom (const gchar *filename,
                          ...);

FIXME

Parameters

filename

FIXME

 

...

FIXME

 

Returns

FIXME


ncm_cfg_save_fftw_wisdom ()

gboolean
ncm_cfg_save_fftw_wisdom (const gchar *filename,
                          ...);

FIXME

Parameters

filename

FIXME

 

...

FIXME

 

Returns

FIXME


ncm_cfg_exists ()

gboolean
ncm_cfg_exists (const gchar *filename,
                ...);

FIXME

Parameters

filename

FIXME

 

...

FIXME

 

Returns

FIXME


ncm_cfg_set_logfile ()

void
ncm_cfg_set_logfile (gchar *filename);

FIXME

Parameters

filename

FIXME

 

ncm_cfg_logfile ()

void
ncm_cfg_logfile (gboolean on);

FIXME

Parameters

on

FIXME

 

ncm_cfg_logfile_flush ()

void
ncm_cfg_logfile_flush (gboolean on);

FIXME

Parameters

on

FIXME

 

ncm_cfg_logfile_flush_now ()

void
ncm_cfg_logfile_flush_now (void);

FIXME


ncm_message ()

void
ncm_message (const gchar *msg,
             ...);

ncm_string_ww ()

gchar *
ncm_string_ww (const gchar *msg,
               const gchar *first,
               const gchar *rest,
               guint ncols);

FIXME

Parameters

msg

FIXME

 

first

FIXME

 

rest

FIXME

 

ncols

FIXME

 

Returns

word wraped string msg .

[transfer full]


ncm_message_ww ()

void
ncm_message_ww (const gchar *msg,
                const gchar *first,
                const gchar *rest,
                guint ncols);

FIXME

Parameters

msg

FIXME

 

first

FIXME

 

rest

FIXME

 

ncols

FIXME

 

ncm_cfg_msg_sepa ()

void
ncm_cfg_msg_sepa (void);

Log a message separator.


ncm_cfg_fopen ()

FILE *
ncm_cfg_fopen (const gchar *filename,
               const gchar *mode,
               ...);

FIXME

Parameters

filename

FIXME

 

mode

FIXME

 

...

FIXME

 

Returns

FIXME


ncm_cfg_vfopen ()

FILE *
ncm_cfg_vfopen (const gchar *filename,
                const gchar *mode,
                va_list ap);

FIXME

[skip]

Parameters

filename

FIXME

 

mode

FIXME

 

ap

FIXME

 

Returns

FIXME


ncm_cfg_load_spline ()

gboolean
ncm_cfg_load_spline (const gchar *filename,
                     const gsl_interp_type *stype,
                     NcmSpline **s,
                     ...);

FIXME

[skip]

Parameters

filename

FIXME

 

stype

FIXME

 

s

FIXME

 

...

FIXME

 

Returns

FIXME


ncm_cfg_save_spline ()

gboolean
ncm_cfg_save_spline (const gchar *filename,
                     NcmSpline *s,
                     ...);

FIXME

Parameters

filename

FIXME

 

s

FIXME

 

...

FIXME

 

Returns

FIXME


ncm_cfg_get_data_filename ()

gchar *
ncm_cfg_get_data_filename (const gchar *filename,
                           gboolean must_exist);

Looks for filename in the data path and returns the full path if found.

Parameters

filename

filename to search in the data path.

 

must_exist

raises an error if filename is not found.

 

Returns

Full path for filename .

[transfer full]


ncm_cfg_command_line ()

gchar *
ncm_cfg_command_line (gchar *argv[],
                      gint argc);

FIXME

Parameters

argv

FIXME

 

argc

FIXME

 

Returns

FIXME


ncm_cfg_variant_to_array ()

GArray *
ncm_cfg_variant_to_array (GVariant *var,
                          gsize esize);

FIXME

[skip]

Parameters

var

a variant of array type.

 

esize

element size.

 

Returns

FIXME.

[transfer full]


ncm_cfg_array_set_variant ()

void
ncm_cfg_array_set_variant (GArray *a,
                           GVariant *var);

FIXME

[skip]

Parameters

a

a GArray.

 

var

a variant of array type.

 

ncm_cfg_array_to_variant ()

GVariant *
ncm_cfg_array_to_variant (GArray *a,
                          const GVariantType *etype);

FIXME

[skip]

Parameters

a

a GArray.

 

etype

element type.

 

Returns

FIXME.

[transfer full]


ncm_cfg_set_fftw_default_flag ()

void
ncm_cfg_set_fftw_default_flag (guint flag,
                               const gdouble timeout);

Sets the default FFTW flag (FFTW_ESTIMATE, FFTW_MEASURE, FFTW_PATIENT, FFTW_EXHAUSTIVE) to be used when building plans. The variable timeout sets the maximum time spended on planners.

Parameters

flag

a FFTW library flag

 

timeout

planner time out in seconds

 

NCM_CHECK_PREPARED()

#define             NCM_CHECK_PREPARED(obj,name)

G_DECLARE_FINAL_TYPE()

#define             G_DECLARE_FINAL_TYPE(ModuleObjName, module_obj_name, MODULE, OBJ_NAME, ParentName)

G_DECLARE_DERIVABLE_TYPE()

#define             G_DECLARE_DERIVABLE_TYPE(ModuleObjName, module_obj_name, MODULE, OBJ_NAME, ParentName)

G_DECLARE_INTERFACE()

#define             G_DECLARE_INTERFACE(ModuleObjName, module_obj_name, MODULE, OBJ_NAME, PrerequisiteName)

g_clear_pointer()

#define             g_clear_pointer(ptr,freefunc)

g_clear_object()

#define             g_clear_object(obj)

NCM_FITS_ERROR()

#define             NCM_FITS_ERROR(status)

Types and Values

fftw_default_flags

extern guint fftw_default_flags;

NCM_CFG_DATA_DIR_ENV

#define NCM_CFG_DATA_DIR_ENV "NUMCOSMO_DATA_DIR"

NCM_ZERO_LIMIT

#define NCM_ZERO_LIMIT 1e-13

NCM_DEFAULT_PRECISION

#define NCM_DEFAULT_PRECISION 1e-7

NCM_THREAD_POOL_MAX

#define NCM_THREAD_POOL_MAX 5

mpz_inits

#define mpz_inits ncm_mpz_inits

mpz_clears

#define mpz_clears ncm_mpz_clears