coco.h

Go to the documentation of this file.

#ifndef __COCO_H__
#define __COCO_H__

#include <stddef.h>

/* Definitions of some 32 and 64-bit types (used by the random number generator) */
#ifdef _MSC_VER
typedef __int32 int32_t;
typedef unsigned __int32 uint32_t;
typedef __int64 int64_t;
typedef unsigned __int64 uint64_t;
#else
#include <stdint.h>
#endif

/* Include definition for NAN among other things */
#include <math.h>
#include <float.h>
#ifndef NAN

#define NAN 8.8888e88
#endif
#ifndef isnan

#define isnan(x) (0)
#endif
#ifndef INFINITY

#define INFINITY 1e22
/* why not using 1e99? */
#endif
#ifndef isinf

#define isinf(x) (0)
#endif

#ifdef __cplusplus
extern "C" {
#endif

static const char coco_version[32] = "$COCO_VERSION";
/***********************************************************************************************************/
static const double coco_pi = 3.14159265358979323846;
static const double coco_two_pi = 2.0 * 3.14159265358979323846;
/***********************************************************************************************************/

typedef enum {
  COCO_ERROR,     
  COCO_WARNING,   
  COCO_INFO,      
  COCO_DEBUG      
} coco_log_level_type_e;

/***********************************************************************************************************/

struct coco_problem_s;

typedef struct coco_problem_s coco_problem_t;

struct coco_suite_s;

typedef struct coco_suite_s coco_suite_t;

struct coco_observer_s;

typedef struct coco_observer_s coco_observer_t;

struct coco_archive_s;

typedef struct coco_archive_s coco_archive_t;

struct coco_random_state_s;

typedef struct coco_random_state_s coco_random_state_t;

/***********************************************************************************************************/

coco_suite_t *coco_suite(const char *suite_name, const char *suite_instance, const char *suite_options);

void coco_suite_free(coco_suite_t *suite);

coco_problem_t *coco_suite_get_next_problem(coco_suite_t *suite, coco_observer_t *observer);

coco_problem_t *coco_suite_get_problem(coco_suite_t *suite, const size_t problem_index);

coco_problem_t *coco_suite_get_problem_by_function_dimension_instance(coco_suite_t *suite,
                                                                      const size_t function,
                                                                      const size_t dimension,
                                                                      const size_t instance);

size_t coco_suite_get_number_of_problems(const coco_suite_t *suite);

size_t coco_suite_get_function_from_function_index(const coco_suite_t *suite, const size_t function_idx);

size_t coco_suite_get_dimension_from_dimension_index(const coco_suite_t *suite, const size_t dimension_idx);

size_t coco_suite_get_instance_from_instance_index(const coco_suite_t *suite, const size_t instance_idx);
size_t coco_suite_encode_problem_index(const coco_suite_t *suite,
                                       const size_t function_idx,
                                       const size_t dimension_idx,
                                       const size_t instance_idx);

void coco_suite_decode_problem_index(const coco_suite_t *suite,
                                     const size_t problem_index,
                                     size_t *function_idx,
                                     size_t *dimension_idx,
                                     size_t *instance_idx);
/***********************************************************************************************************/

coco_observer_t *coco_observer(const char *observer_name, const char *options);

void coco_observer_free(coco_observer_t *observer);

coco_problem_t *coco_problem_add_observer(coco_problem_t *problem, coco_observer_t *observer);

coco_problem_t *coco_problem_remove_observer(coco_problem_t *problem, coco_observer_t *observer);

const char *coco_observer_get_result_folder(const coco_observer_t *observer);

/***********************************************************************************************************/

void coco_evaluate_function(coco_problem_t *problem, const double *x, double *y);

void coco_evaluate_constraint(coco_problem_t *problem, const double *x, double *y);

void coco_recommend_solution(coco_problem_t *problem, const double *x);

void coco_problem_free(coco_problem_t *problem);

const char *coco_problem_get_name(const coco_problem_t *problem);

const char *coco_problem_get_id(const coco_problem_t *problem);

const char *coco_problem_get_type(const coco_problem_t *problem);

size_t coco_problem_get_dimension(const coco_problem_t *problem);

size_t coco_problem_get_number_of_objectives(const coco_problem_t *problem);

size_t coco_problem_get_number_of_constraints(const coco_problem_t *problem);

size_t coco_problem_get_evaluations(const coco_problem_t *problem);

size_t coco_problem_get_evaluations_constraints(const coco_problem_t *problem);

int coco_problem_final_target_hit(const coco_problem_t *problem);

double coco_problem_get_best_observed_fvalue1(const coco_problem_t *problem);

double depreciated_coco_problem_get_final_target_fvalue1(const coco_problem_t *problem);

const double *coco_problem_get_smallest_values_of_interest(const coco_problem_t *problem);

const double *coco_problem_get_largest_values_of_interest(const coco_problem_t *problem);

size_t coco_problem_get_number_of_integer_variables(const coco_problem_t *problem);

const double *coco_problem_get_largest_fvalues_of_interest(const coco_problem_t *problem);

size_t coco_problem_get_suite_dep_index(const coco_problem_t *problem);

void coco_problem_get_initial_solution(const coco_problem_t *problem, double *initial_solution);
/***********************************************************************************************************/

coco_random_state_t *coco_random_new(uint32_t seed);

void coco_random_free(coco_random_state_t *state);

double coco_random_uniform(coco_random_state_t *state);

double coco_random_normal(coco_random_state_t *state);
/***********************************************************************************************************/

void *coco_allocate_memory(const size_t size);

double *coco_allocate_vector(const size_t size);

void coco_free_memory(void *data);
/***********************************************************************************************************/

void coco_error(const char *message, ...);

void coco_warning(const char *message, ...);

void coco_info(const char *message, ...);

void coco_info_partial(const char *message, ...);

void coco_debug(const char *message, ...);

const char *coco_set_log_level(const char *level);
/***********************************************************************************************************/

coco_archive_t *coco_archive(const char *suite_name,
                             const size_t function,
                             const size_t dimension,
                             const size_t instance);
int coco_archive_add_solution(coco_archive_t *archive, const double y1, const double y2, const char *text);

size_t coco_archive_get_number_of_solutions(coco_archive_t *archive);

double coco_archive_get_hypervolume(coco_archive_t *archive);

const char *coco_archive_get_next_solution_text(coco_archive_t *archive);

void coco_archive_free(coco_archive_t *archive);

int coco_logger_biobj_feed_solution(coco_problem_t *problem, const size_t evaluation, const double *y);
/***********************************************************************************************************/

int coco_remove_directory(const char *path);

char *coco_strdupf(const char *str, ...);
/***********************************************************************************************************/

#ifdef __cplusplus
}
#endif
#endif