[![Build Status](https://travis-ci.org/yuulive/ka.svg?branch=master)](https://travis-ci.org/yuulilve/ka)
[![Crates.io](https://img.shields.io/crates/v/ka.svg)](https://crates.io/crates/ka)
[![docs.rs](https://docs.rs/ka/badge.svg)](https://docs.rs/ka)

# About
This crate provides functionality for several functions that are commonly
used to benchmark new optimization algorithms. More specifically, function is part of a struct
that contains the objective function as well as other important information (bounds of the
canonical problem, the known minimum value, and a function that returns the global minimizer.

This crate provides access to several single- and multi-objective funtions. For exhaustive lists, check [here](single/index.html) and [here](multi/index.html), respectively.


# Example Usage
Using this crate is easy! Simply add this crate as a dependency and then `use` it:
```rust
use ka::*;

fn main() {
    // Print some info about the ackley function
    println!("Minmimum: {:?}", Ackley::MINIMUM);
    println!("Minmizer: {:?}", Ackley::minimizer(5));
    println!("Minmizer: {:?}", single::Ackley::BOUNDS);
}
```
You can also use a `use` statement that looks more like `use ka::{SingleObjective}` but that's just messy!