coco_internal.h

Go to the documentation of this file.

#ifndef __COCO_INTERNAL__
#define __COCO_INTERNAL__

#ifdef __cplusplus
extern "C" {
#endif

/***********************************************************************************************************/
typedef void (*coco_data_free_function_t)(void *data);

typedef void (*coco_problem_free_function_t)(coco_problem_t *problem);

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

typedef void (*coco_recommend_function_t)(coco_problem_t *problem, const double *x);

typedef coco_problem_t *(*coco_logger_allocate_function_t)(coco_observer_t *observer,
                                                           coco_problem_t *problem);
typedef void (*coco_logger_free_function_t)(void *logger);

typedef coco_problem_t *(*coco_get_problem_function_t)(const size_t function,
                                                       const size_t dimension,
                                                       const size_t instance);

typedef struct {
  coco_problem_t *inner_problem;                  
  void *data;                                     
  coco_data_free_function_t data_free_function;   
} coco_problem_transformed_data_t;

typedef struct {
  coco_problem_t *problem1; 
  coco_problem_t *problem2; 
} coco_problem_stacked_data_t;

typedef struct {
  size_t count;  
  char **keys;   
} coco_option_keys_t;


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

struct coco_problem_s {

  coco_evaluate_function_t evaluate_function;         
  coco_evaluate_function_t evaluate_constraint;       
  coco_evaluate_function_t evaluate_gradient;         
  coco_recommend_function_t recommend_solution;       
  coco_problem_free_function_t problem_free_function; 
  size_t number_of_variables;          
  size_t number_of_objectives;         
  size_t number_of_constraints;        
  double *smallest_values_of_interest; 
  double *largest_values_of_interest;  
  size_t number_of_integer_variables;  
  double *initial_solution;            
  double *best_value;                  
  double *nadir_value;                 
  double *best_parameter;              
  char *problem_name;                  
  char *problem_id;                    
  char *problem_type;                  
  size_t evaluations;                  
  size_t evaluations_constraints;      
  /* Convenience fields for output generation */
  /* If at some point in time these arrays are changed to pointers, checks need to be added in the code to make sure
   * they are not NULL.*/

  double final_target_delta[1];        
  double best_observed_fvalue[1];      
  size_t best_observed_evaluation[1];  
  /* Fields depending on the containing benchmark suite */

  coco_suite_t *suite;                 
  size_t suite_dep_index;              
  size_t suite_dep_function;           
  size_t suite_dep_instance;           
  void *data;                          
  void *versatile_data;                /* Wassim: *< @brief pointer to eventual additional data that need to be accessed all along the transforamtions*/
};

struct coco_observer_s {

  int is_active;             
  char *observer_name;       
  char *result_folder;       
  char *algorithm_name;      
  char *algorithm_info;      
  size_t number_target_triggers;
  double target_precision;   
  size_t number_evaluation_triggers;
  char *base_evaluation_triggers;
  int precision_x;           
  int precision_f;           
  int precision_g;           
  int log_discrete_as_int;   
  void *data;                
  coco_data_free_function_t data_free_function;             
  coco_logger_allocate_function_t logger_allocate_function; 
  coco_logger_free_function_t logger_free_function;         
};

struct coco_suite_s {

  char *suite_name;                
  size_t number_of_dimensions;     
  size_t *dimensions;              
  size_t number_of_functions;      
  size_t *functions;               
  size_t number_of_instances;      
  char *default_instances;         
  size_t *instances;               
  coco_problem_t *current_problem; 
  long current_dimension_idx;      
  long current_function_idx;       
  long current_instance_idx;       
  void *data;                      
  coco_data_free_function_t data_free_function; 
};

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

void bbob_problem_best_parameter_print(const coco_problem_t *problem);
void bbob_biobj_problem_best_parameter_print(const coco_problem_t *problem);

#ifdef __cplusplus
}
#endif
#endif