/**
* @brief Returns the best known value for indicator_name matching the given key if the key is found, and
* throws a coco_error otherwise.
*/
static double suite_biobj_get_best_value(const char *indicator_name, const char *key) {
size_t i, count;
double best_value = 0;
char *curr_key;
if (strcmp(indicator_name, "hyp") == 0) {
curr_key = coco_allocate_string(COCO_PATH_MAX);
count = sizeof(suite_biobj_best_values_hyp) / sizeof(char *);
for (i = 0; i < count; i++) {
sscanf(suite_biobj_best_values_hyp[i], "%s %lf", curr_key, &best_value);
if (strcmp(curr_key, key) == 0) {
coco_free_memory(curr_key);
return best_value;
}
}
coco_free_memory(curr_key);
coco_warning("suite_biobj_get_best_value(): best value of %s could not be found; set to 1.0", key);
return 1.0;
} else {
coco_error("suite_biobj_get_best_value(): indicator %s not supported", indicator_name);
return 0; /* Never reached */
}
coco_error("suite_biobj_get_best_value(): unexpected exception");
return 0; /* Never reached */
}
/**
* @brief Initializes the biobjective logger.
*/
static coco_problem_t *logger_biobj(coco_observer_t *observer, coco_problem_t *inner_problem) {
coco_problem_t *problem;
logger_biobj_data_t *logger_biobj;
observer_biobj_data_t *observer_biobj;
const char nondom_folder_name[] = "archive";
char *path_name, *file_name = NULL, *prefix;
size_t i;
if (inner_problem->number_of_objectives != 2) {
coco_error("logger_biobj(): The bi-objective logger cannot log a problem with %d objective(s)", inner_problem->number_of_objectives);
return NULL; /* Never reached. */
}
logger_biobj = (logger_biobj_data_t *) coco_allocate_memory(sizeof(*logger_biobj));
logger_biobj->observer = observer;
logger_biobj->number_of_evaluations = 0;
logger_biobj->number_of_variables = inner_problem->number_of_variables;
logger_biobj->number_of_objectives = inner_problem->number_of_objectives;
logger_biobj->suite_dep_instance = inner_problem->suite_dep_instance;
observer_biobj = (observer_biobj_data_t *) observer->data;
/* Copy values from the observes that you might need even if they do not exist any more */
logger_biobj->log_nondom_mode = observer_biobj->log_nondom_mode;
logger_biobj->compute_indicators = observer_biobj->compute_indicators;
logger_biobj->precision_x = observer->precision_x;
logger_biobj->precision_f = observer->precision_f;
if (((observer_biobj->log_vars_mode == LOG_VARS_LOW_DIM) && (inner_problem->number_of_variables > 5))
|| (observer_biobj->log_vars_mode == LOG_VARS_NEVER))
logger_biobj->log_vars = 0;
else
logger_biobj->log_vars = 1;
/* Initialize logging of nondominated solutions into the archive file */
if (logger_biobj->log_nondom_mode != LOG_NONDOM_NONE) {
/* Create the path to the file */
path_name = coco_allocate_string(COCO_PATH_MAX);
memcpy(path_name, observer->result_folder, strlen(observer->result_folder) + 1);
coco_join_path(path_name, COCO_PATH_MAX, nondom_folder_name, NULL);
coco_create_directory(path_name);
/* Construct file name */
prefix = coco_remove_from_string(inner_problem->problem_id, "_i", "_d");
if (logger_biobj->log_nondom_mode == LOG_NONDOM_ALL)
file_name = coco_strdupf("%s_nondom_all.adat", prefix);
else if (logger_biobj->log_nondom_mode == LOG_NONDOM_FINAL)
file_name = coco_strdupf("%s_nondom_final.adat", prefix);
coco_join_path(path_name, COCO_PATH_MAX, file_name, NULL);
if (logger_biobj->log_nondom_mode != LOG_NONDOM_NONE)
coco_free_memory(file_name);
coco_free_memory(prefix);
/* Open and initialize the archive file */
logger_biobj->archive_file = fopen(path_name, "a");
if (logger_biobj->archive_file == NULL) {
coco_error("logger_biobj() failed to open file '%s'.", path_name);
return NULL; /* Never reached */
}
coco_free_memory(path_name);
/* Output header information */
fprintf(logger_biobj->archive_file, "%% instance = %ld, name = %s\n", inner_problem->suite_dep_instance, inner_problem->problem_name);
if (logger_biobj->log_vars) {
fprintf(logger_biobj->archive_file, "%% function evaluation | %lu objectives | %lu variables\n",
inner_problem->number_of_objectives, inner_problem->number_of_variables);
} else {
fprintf(logger_biobj->archive_file, "%% function evaluation | %lu objectives \n",
inner_problem->number_of_objectives);
}
}
/* Initialize the AVL trees */
logger_biobj->archive_tree = avl_tree_construct((avl_compare_t) avl_tree_compare_by_last_objective,
(avl_free_t) logger_biobj_node_free);
logger_biobj->buffer_tree = avl_tree_construct((avl_compare_t) avl_tree_compare_by_time_stamp, NULL);
problem = coco_problem_transformed_allocate(inner_problem, logger_biobj, logger_biobj_free);
problem->evaluate_function = logger_biobj_evaluate;
/* Initialize the indicators */
if (logger_biobj->compute_indicators) {
for (i = 0; i < OBSERVER_BIOBJ_NUMBER_OF_INDICATORS; i++)
logger_biobj->indicators[i] = logger_biobj_indicator(logger_biobj, inner_problem, observer_biobj_indicators[i]);
observer_biobj->previous_function = (long) inner_problem->suite_dep_function;
}
return problem;
}
/**
* @brief Initializes the indicator with name indicator_name.
*
* Opens files for writing and resets counters.
*/
static logger_biobj_indicator_t *logger_biobj_indicator(const logger_biobj_data_t *logger,
const coco_problem_t *problem,
const char *indicator_name) {
coco_observer_t *observer;
observer_biobj_data_t *observer_biobj;
logger_biobj_indicator_t *indicator;
char *prefix, *file_name, *path_name;
int info_file_exists = 0;
indicator = (logger_biobj_indicator_t *) coco_allocate_memory(sizeof(*indicator));
observer = logger->observer;
observer_biobj = (observer_biobj_data_t *) observer->data;
indicator->name = coco_strdup(indicator_name);
indicator->best_value = suite_biobj_get_best_value(indicator->name, problem->problem_id);
indicator->next_target_id = 0;
indicator->target_hit = 0;
indicator->current_value = 0;
indicator->additional_penalty = 0;
indicator->overall_value = 0;
/* Prepare the info file */
path_name = coco_allocate_string(COCO_PATH_MAX);
memcpy(path_name, observer->result_folder, strlen(observer->result_folder) + 1);
coco_create_directory(path_name);
file_name = coco_strdupf("%s_%s.info", problem->problem_type, indicator_name);
coco_join_path(path_name, COCO_PATH_MAX, file_name, NULL);
info_file_exists = coco_file_exists(path_name);
indicator->info_file = fopen(path_name, "a");
if (indicator->info_file == NULL) {
coco_error("logger_biobj_indicator() failed to open file '%s'.", path_name);
return NULL; /* Never reached */
}
coco_free_memory(file_name);
coco_free_memory(path_name);
/* Prepare the tdat file */
path_name = coco_allocate_string(COCO_PATH_MAX);
memcpy(path_name, observer->result_folder, strlen(observer->result_folder) + 1);
coco_join_path(path_name, COCO_PATH_MAX, problem->problem_type, NULL);
coco_create_directory(path_name);
prefix = coco_remove_from_string(problem->problem_id, "_i", "_d");
file_name = coco_strdupf("%s_%s.tdat", prefix, indicator_name);
coco_join_path(path_name, COCO_PATH_MAX, file_name, NULL);
indicator->tdat_file = fopen(path_name, "a");
if (indicator->tdat_file == NULL) {
coco_error("logger_biobj_indicator() failed to open file '%s'.", path_name);
return NULL; /* Never reached */
}
coco_free_memory(file_name);
coco_free_memory(path_name);
/* Prepare the dat file */
path_name = coco_allocate_string(COCO_PATH_MAX);
memcpy(path_name, observer->result_folder, strlen(observer->result_folder) + 1);
coco_join_path(path_name, COCO_PATH_MAX, problem->problem_type, NULL);
coco_create_directory(path_name);
file_name = coco_strdupf("%s_%s.dat", prefix, indicator_name);
coco_join_path(path_name, COCO_PATH_MAX, file_name, NULL);
indicator->dat_file = fopen(path_name, "a");
if (indicator->dat_file == NULL) {
coco_error("logger_biobj_indicator() failed to open file '%s'.", path_name);
return NULL; /* Never reached */
}
/* Output header information to the info file */
if (!info_file_exists) {
/* Output algorithm name */
fprintf(indicator->info_file, "algorithm = '%s', indicator = '%s', folder = '%s'\n%% %s", observer->algorithm_name,
indicator_name, problem->problem_type, observer->algorithm_info);
}
if (observer_biobj->previous_function != problem->suite_dep_function) {
fprintf(indicator->info_file, "\nfunction = %2lu, ", problem->suite_dep_function);
fprintf(indicator->info_file, "dim = %2lu, ", problem->number_of_variables);
fprintf(indicator->info_file, "%s", file_name);
}
coco_free_memory(prefix);
coco_free_memory(file_name);
coco_free_memory(path_name);
/* Output header information to the dat file */
fprintf(indicator->dat_file, "%%\n%% index = %ld, name = %s\n", problem->suite_dep_index, problem->problem_name);
fprintf(indicator->dat_file, "%% instance = %ld, reference value = %.*e\n", problem->suite_dep_instance,
logger->precision_f, indicator->best_value);
fprintf(indicator->dat_file, "%% function evaluation | indicator value | target hit\n");
/* Output header information to the tdat file */
fprintf(indicator->tdat_file, "%%\n%% index = %ld, name = %s\n", problem->suite_dep_index, problem->problem_name);
fprintf(indicator->tdat_file, "%% instance = %ld, reference value = %.*e\n", problem->suite_dep_instance,
logger->precision_f, indicator->best_value);
fprintf(indicator->tdat_file, "%% function evaluation | indicator value\n");
return indicator;
}
