1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562
use coco_sys::{coco_observer_t, coco_problem_t, coco_random_state_t, coco_suite_t};
use std::{
ffi::{CStr, CString},
marker::PhantomData,
ops::RangeInclusive,
ptr,
};
pub enum LogLevel {
Error,
Warning,
Info,
Debug,
}
impl Default for LogLevel {
fn default() -> Self {
LogLevel::Info
}
}
impl LogLevel {
pub fn as_str(&self) -> &'static str {
match self {
LogLevel::Error => "error",
LogLevel::Warning => "warning",
LogLevel::Info => "info",
LogLevel::Debug => "debug",
}
}
}
/// Sets COCO's log level.
pub fn set_log_level(level: LogLevel) {
let level = CString::new(level.as_str()).unwrap();
unsafe {
coco_sys::coco_set_log_level(level.as_ptr());
}
}
/// A COCO suite
pub struct Suite {
inner: *mut coco_suite_t,
name: CString,
instance: CString,
options: CString,
}
impl Clone for Suite {
fn clone(&self) -> Self {
Suite::new_raw(
self.name.clone(),
self.instance.clone(),
self.options.clone(),
)
.unwrap()
}
}
unsafe impl Send for Suite {}
pub enum SuiteName {
Bbob,
BbobBiobj,
BbobBiobjExt,
BbobLargescale,
BbobConstrained,
BbobMixint,
BbobBiobjMixint,
Toy,
}
impl SuiteName {
pub fn as_str(&self) -> &'static str {
match self {
SuiteName::Bbob => "bbob",
SuiteName::BbobBiobj => "bbob-biobj",
SuiteName::BbobBiobjExt => "bbob-biobj-ext",
SuiteName::BbobLargescale => "bbob-largescale",
SuiteName::BbobConstrained => "bbob-constrained",
SuiteName::BbobMixint => "bbob-mixint",
SuiteName::BbobBiobjMixint => "bbob-biobj-mixint",
SuiteName::Toy => "toy",
}
}
}
impl Suite {
/// Instantiates the specified COCO suite.
///
/// # suite_instance
/// A string used for defining the suite instances. Two ways are supported:
/// - "year: YEAR", where YEAR is the year of the BBOB workshop, includes the instances (to be) used in that
/// year's workshop;
/// - "instances: VALUES", where VALUES are instance numbers from 1 on written as a comma-separated list or a
/// range m-n.
///
/// # suite_options
/// A string of pairs "key: value" used to filter the suite (especially useful for
/// parallelizing the experiments). Supported options:
/// - "dimensions: LIST", where LIST is the list of dimensions to keep in the suite (range-style syntax is
/// not allowed here),
/// - "dimension_indices: VALUES", where VALUES is a list or a range of dimension indices (starting from 1) to keep
/// in the suite, and
/// - "function_indices: VALUES", where VALUES is a list or a range of function indices (starting from 1) to keep
/// in the suite, and
/// - "instance_indices: VALUES", where VALUES is a list or a range of instance indices (starting from 1) to keep
/// in the suite.
pub fn new(name: SuiteName, instance: &str, options: &str) -> Option<Suite> {
let name = CString::new(name.as_str()).unwrap();
let instance = CString::new(instance).unwrap();
let options = CString::new(options).unwrap();
Self::new_raw(name, instance, options)
}
fn new_raw(name: CString, instance: CString, options: CString) -> Option<Suite> {
let inner =
unsafe { coco_sys::coco_suite(name.as_ptr(), instance.as_ptr(), options.as_ptr()) };
if inner.is_null() {
None
} else {
Some(Suite {
inner,
name,
instance,
options,
})
}
}
/// Returns the next problem or `None` when the suite completed.
pub fn next_problem<'s>(&'s mut self, observer: Option<&mut Observer>) -> Option<Problem<'s>> {
let observer = observer.map(|o| o.inner).unwrap_or(ptr::null_mut());
let inner = unsafe { coco_sys::coco_suite_get_next_problem(self.inner, observer) };
if inner.is_null() {
return None;
}
unsafe {
coco_sys::coco_suite_forget_current_problem(self.inner);
}
let mut function = 0;
let mut dimension = 0;
let mut instance = 0;
unsafe {
let suite_index = coco_sys::coco_problem_get_suite_dep_index(inner);
coco_sys::coco_suite_decode_problem_index(
self.inner,
suite_index,
&mut function,
&mut dimension,
&mut instance,
);
}
Some(Problem {
inner,
function_idx: function as usize,
dimension_idx: dimension as usize,
instance_idx: instance as usize,
_phantom: PhantomData,
})
}
/// Returns the problem for the given function, dimension and instance.
///
/// **Important:** This is different from [[Suite::problem_by_function_dimension_instance_index]].
///
/// While a suite can contain multiple problems with equal function, dimension and instance, this
/// function always returns the first problem in the suite with the given function, dimension and instance
/// values. If the given values don't correspond to a problem, the function returns `None`.
pub fn problem_by_function_dimension_instance(
&mut self,
function: usize,
dimension: usize,
instance: usize,
) -> Option<Problem> {
let problem = unsafe {
coco_sys::coco_suite_get_problem_by_function_dimension_instance(
self.inner,
function as usize,
dimension as usize,
instance as usize,
)
};
if problem.is_null() {
return None;
}
Some(Problem {
inner: problem,
function_idx: function,
dimension_idx: dimension,
instance_idx: instance,
_phantom: PhantomData,
})
}
/// Returns the problem for the given function, dimension and instance index.
pub fn problem_by_function_dimension_instance_index(
&mut self,
function_idx: usize,
dimension_idx: usize,
instance_idx: usize,
) -> Option<Problem> {
let problem_index = unsafe {
coco_sys::coco_suite_encode_problem_index(
self.inner,
function_idx.try_into().unwrap(),
dimension_idx.try_into().unwrap(),
instance_idx.try_into().unwrap(),
)
};
let problem = unsafe { coco_sys::coco_suite_get_problem(self.inner, problem_index) };
if problem.is_null() {
return None;
}
Some(Problem {
inner: problem,
function_idx,
dimension_idx,
instance_idx,
_phantom: PhantomData,
})
}
/// Returns the total number of problems in the suite.
pub fn number_of_problems(&self) -> usize {
unsafe {
coco_sys::coco_suite_get_number_of_problems(self.inner)
.try_into()
.unwrap()
}
}
}
impl Drop for Suite {
fn drop(&mut self) {
unsafe {
coco_sys::coco_suite_free(self.inner);
}
}
}
/// A specific problem instance.
///
/// Instances can be optained using [Suite::next_problem]
/// and [Suite::problem_by_function_dimension_instance].
pub struct Problem<'suite> {
inner: *mut coco_problem_t,
function_idx: usize,
instance_idx: usize,
dimension_idx: usize,
_phantom: PhantomData<&'suite Suite>,
}
unsafe impl Send for Problem<'_> {}
impl Problem<'_> {
/// Returns the ID of the problem.
///
/// For the `toy` suite this is
/// - `{function-name}_d{dimension}`
///
/// For `bbob` it is
/// - bbob_f{function-index}_i{instance}_d{dimension}
pub fn id(&self) -> &str {
unsafe {
CStr::from_ptr(coco_sys::coco_problem_get_id(self.inner))
.to_str()
.unwrap()
}
}
/// Returns the name of the problem.
pub fn name(&self) -> &str {
unsafe {
CStr::from_ptr(coco_sys::coco_problem_get_name(self.inner))
.to_str()
.unwrap()
}
}
/// Returns the index of the problem.
pub fn function_index(&self) -> usize {
self.function_idx
}
/// Returns the dimension index of the problem.
pub fn dimension_index(&self) -> usize {
self.dimension_idx
}
/// Returns the instance of the problem.
pub fn instance_index(&self) -> usize {
self.instance_idx
}
/// Evaluates the problem at `x` and returns the result in `y`.
///
/// The length of `x` must match [Problem::dimension] and the
/// length of `y` must match [Problem::number_of_objectives].
pub fn evaluate_function(&mut self, x: &[f64], y: &mut [f64]) {
assert_eq!(self.dimension(), x.len());
assert_eq!(self.number_of_objectives(), y.len());
unsafe {
coco_sys::coco_evaluate_function(self.inner, x.as_ptr(), y.as_mut_ptr());
}
}
/// Evaluates the problem constraints in point x and save the result in y.
///
/// The length of `x` must match [Problem::dimension] and the
/// length of `y` must match [Problem::number_of_constraints].
pub fn evaluate_constraint(&mut self, x: &[f64], y: &mut [f64]) {
assert_eq!(self.dimension(), x.len());
assert_eq!(self.number_of_constraints(), y.len());
unsafe {
coco_sys::coco_evaluate_constraint(self.inner, x.as_ptr(), y.as_mut_ptr());
}
}
/// Returns true if a previous evaluation hit the target value.
pub fn final_target_hit(&self) -> bool {
unsafe { coco_sys::coco_problem_final_target_hit(self.inner) == 1 }
}
/// Returns the optimal function value + delta of the problem
pub fn final_target_value(&self) -> f64 {
unsafe { coco_sys::coco_problem_get_final_target_fvalue1(self.inner) }
}
/// Returns the optimal function value of the problem
///
/// To check whether the target has been reached use [[Problem::final_target_value]]
/// or [[Problem::final_target_hit]] instead.
pub fn best_value(&self) -> f64 {
unsafe { coco_sys::coco_problem_get_best_value(self.inner) }
}
/// Returns the dimension of the problem.
pub fn dimension(&self) -> usize {
unsafe {
coco_sys::coco_problem_get_dimension(self.inner)
.try_into()
.unwrap()
}
}
/// Returns the number of objectives of the problem.
pub fn number_of_objectives(&self) -> usize {
unsafe {
coco_sys::coco_problem_get_number_of_objectives(self.inner)
.try_into()
.unwrap()
}
}
/// Returns the number of constraints of the problem.
pub fn number_of_constraints(&self) -> usize {
unsafe {
coco_sys::coco_problem_get_number_of_constraints(self.inner)
.try_into()
.unwrap()
}
}
/// Returns the numver of integer variables of the problem.
///
/// The first `n` variables will be integers then.
/// Returns `0` if all variables are continuous.
pub fn number_of_integer_variables(&self) -> usize {
unsafe {
coco_sys::coco_problem_get_number_of_integer_variables(self.inner)
.try_into()
.unwrap()
}
}
/// Returns the upper and lover bounds of the problem.
pub fn get_ranges_of_interest(&self) -> Vec<RangeInclusive<f64>> {
let dimension = self.dimension() as isize;
unsafe {
let smallest = coco_sys::coco_problem_get_smallest_values_of_interest(self.inner);
let largest = coco_sys::coco_problem_get_largest_values_of_interest(self.inner);
(0..dimension)
.into_iter()
.map(|i| (*smallest.offset(i))..=(*largest.offset(i)))
.collect()
}
}
/// Returns how often this instance has been evaluated.
pub fn evaluations(&self) -> u64 {
unsafe {
#[allow(clippy::useless_conversion)]
coco_sys::coco_problem_get_evaluations(self.inner)
.try_into()
.unwrap()
}
}
/// Returns how often this instances constrants have been evaluated.
pub fn evaluations_constraints(&self) -> u64 {
unsafe {
#[allow(clippy::useless_conversion)]
coco_sys::coco_problem_get_evaluations_constraints(self.inner)
.try_into()
.unwrap()
}
}
/// Writes a feasible initial solution into `x`.
///
/// If the problem does not provide a specific solution,
/// it will be the center of the problem's region of interest.
pub fn initial_solution(&self, x: &mut [f64]) {
assert_eq!(self.dimension(), x.len());
unsafe {
coco_sys::coco_problem_get_initial_solution(self.inner, x.as_mut_ptr());
}
}
}
impl Drop for Problem<'_> {
fn drop(&mut self) {
unsafe {
coco_sys::coco_problem_free(self.inner);
}
}
}
/// An observer to log results in COCO's data format.
///
/// Can be provided to [Suite::next_problem] and it will
/// automatically be attached to the returned problem.
pub struct Observer {
inner: *mut coco_observer_t,
}
pub enum ObserverName {
Bbob,
BbobBiobj,
Toy,
None,
}
impl ObserverName {
fn as_str(&self) -> &'static str {
match self {
ObserverName::Bbob => "bbob",
ObserverName::BbobBiobj => "bbob-biobj",
ObserverName::Toy => "toy",
ObserverName::None => "no-observer",
}
}
}
impl Observer {
/// Creates a new observer.
///
/// # observer_options
/// A string of pairs "key: value" used to pass the options to the observer. Some
/// observer options are general, while others are specific to some observers. Here we list only the general
/// options, see observer_bbob, observer_biobj and observer_toy for options of the specific observers.
/// - "result_folder: NAME" determines the folder within the "exdata" folder into which the results will be
/// output. If the folder with the given name already exists, first NAME_001 will be tried, then NAME_002 and
/// so on. The default value is "default".
/// - "algorithm_name: NAME", where NAME is a short name of the algorithm that will be used in plots (no
/// spaces are allowed). The default value is "ALG".
/// - "algorithm_info: STRING" stores the description of the algorithm. If it contains spaces, it must be
/// surrounded by double quotes. The default value is "" (no description).
/// - "number_target_triggers: VALUE" defines the number of targets between each 10^i and 10^(i+1)
/// (equally spaced in the logarithmic scale) that trigger logging. The default value is 100.
/// - "target_precision: VALUE" defines the precision used for targets (there are no targets for
/// abs(values) < target_precision). The default value is 1e-8.
/// - "number_evaluation_triggers: VALUE" defines the number of evaluations to be logged between each 10^i
/// and 10^(i+1). The default value is 20.
/// - "base_evaluation_triggers: VALUES" defines the base evaluations used to produce an additional
/// evaluation-based logging. The numbers of evaluations that trigger logging are every
/// base_evaluation * dimension * (10^i). For example, if base_evaluation_triggers = "1,2,5", the logger will
/// be triggered by evaluations dim*1, dim*2, dim*5, 10*dim*1, 10*dim*2, 10*dim*5, 100*dim*1, 100*dim*2,
/// 100*dim*5, ... The default value is "1,2,5".
/// - "precision_x: VALUE" defines the precision used when outputting variables and corresponds to the number
/// of digits to be printed after the decimal point. The default value is 8.
/// - "precision_f: VALUE" defines the precision used when outputting f values and corresponds to the number of
/// digits to be printed after the decimal point. The default value is 15.
/// - "precision_g: VALUE" defines the precision used when outputting constraints and corresponds to the number
/// of digits to be printed after the decimal point. The default value is 3.
/// - "log_discrete_as_int: VALUE" determines whether the values of integer variables (in mixed-integer problems)
/// are logged as integers (1) or not (0 - in this case they are logged as doubles). The default value is 0.
pub fn new(name: ObserverName, options: &str) -> Option<Observer> {
let name = CString::new(name.as_str()).unwrap();
let options = CString::new(options).unwrap();
let inner = unsafe { coco_sys::coco_observer(name.as_ptr(), options.as_ptr()) };
if inner.is_null() {
None
} else {
Some(Observer { inner })
}
}
/// Prints where the result is written to.
pub fn result_folder(&self) -> &str {
unsafe {
CStr::from_ptr(coco_sys::coco_observer_get_result_folder(self.inner))
.to_str()
.unwrap()
}
}
}
impl Drop for Observer {
fn drop(&mut self) {
unsafe {
coco_sys::coco_observer_free(self.inner);
}
}
}
/// COCO specific random number generator.
pub struct RandomState {
inner: *mut coco_random_state_t,
}
impl RandomState {
/// Creates a new random number state using the given seed.
pub fn new(seed: u32) -> Self {
let inner = unsafe { coco_sys::coco_random_new(seed) };
RandomState { inner }
}
/// Generates an approximately normal random number.
pub fn normal(&mut self) -> f64 {
unsafe { coco_sys::coco_random_normal(self.inner) }
}
/// Returns one uniform [0, 1) random value.
pub fn uniform(&mut self) -> f64 {
unsafe { coco_sys::coco_random_uniform(self.inner) }
}
}
impl Drop for RandomState {
fn drop(&mut self) {
unsafe {
coco_sys::coco_random_free(self.inner);
}
}
}