Crate argmin

argmin is a numerical optimization library written entirely in Rust.

Its goal is to offer a wide range of optimization algorithms with a consistent interface. It is type-agnostic by design, meaning that any type and/or math backend, such as nalgebra or ndarray can be used – even your own.

Observers allow one to track the progress of iterations, either by using one of the provided ones for logging to screen or disk or by implementing your own.

An optional checkpointing mechanism helps to mitigate the negative effects of crashes in unstable computing environments.

Due to Rusts powerful generics and traits, most features can be exchanged by your own tailored implementations.

argmin is designed to simplify the implementation of optimization algorithms and as such can also be used as a toolbox for the development of new algorithms. One can focus on the algorithm itself, while the handling of termination, parameter vectors, populations, gradients, Jacobians and Hessians is taken care of by the library.

For an introduction on how to use argmin, please also have a look at the book.

Highlights

• Checkpointing
• Observers

Algorithms

• Line searches

  • Backtracking line search
  • More-Thuente line search
  • Hager-Zhang line search

• Trust region method

  • Cauchy point method
  • Dogleg method
  • Steihaug method

• Steepest descent

• Conjugate gradient methods

  • Conjugate gradient method
  • Nonlinear conjugate gradient method

• Newton methods

  • Newton’s method
  • Newton-CG

• Quasi-Newton methods

  • BFGS
  • L-BFGS
  • DFP
  • SR1
  • SR1-TrustRegion

• Gauss-Newton methods

  • Gauss-Newton method
  • Gauss-Newton method with linesearch

• Golden-section search

• Landweber iteration

• Brent’s methods

  • Brent’s minimization method
  • Brent’s root finding method

• Nelder-Mead method

• Simulated Annealing

• Particle Swarm Optimization

External solvers compatible with argmin

External solvers which implement the Solver trait are compatible with argmins Executor, and as such can leverage features like checkpointing and observers.

• egobox
• cobyla

License

Licensed under either of

• Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
• MIT License (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Modules

• core
  argmin optimization toolbox core
• solver
  Solvers

Macros

• argmin_error
  Create an ArgminError with a provided message.
• argmin_error_closure
  Create an ArgminError with a provided message wrapped in a closure for use in .ok_or_else(...) methods on Options.
• bulk
  Creates the bulk_X methods.
• check_param
  Release an T from an Option<T> if it is not None. If it is None, return an ArgminError with a provided message.
• float
  Convert a constant to a float of given precision
• kv
  Creates an KV at compile time