Added OptimResult

README.md

@@ -31,5 +31,5 @@ let args = Array::from_vec(vec![3.0, -8.3]);
 let ans = minimizer.minimize(&function, args.view());
 
 // Print the optimized values
-println!("Final optimized arguments: {}", ans);
+println!("Final optimized arguments: {:?}", ans);
 ```

examples/simple.rs

@@ -3,6 +3,7 @@ extern crate optimize;
 
 use ndarray::prelude::*;
 
+use optimize::minimizer::Minimizer;
 use optimize::vector::NelderMeadBuilder;
 
 pub fn main() {
@@ -11,10 +12,10 @@ pub fn main() {
     let minimizer = NelderMeadBuilder::default()
         .xtol(1e-6f64)
         .ftol(1e-6f64)
-        .maxiter(50000) 
+        .maxiter(50000)
         .build()
         .unwrap();
     let args = Array::from_vec(vec![3.0, -8.3]);
     let ans = minimizer.minimize(&function, args.view());
-    println!("Final optimized arguments: {}", ans);
+    println!("Final optimized arguments: {:?}", ans);
 }

src/lib.rs

@@ -11,6 +11,7 @@
 //! # extern crate optimize;
 //! # use ndarray::prelude::*;
 //! # use optimize::vector::NelderMeadBuilder;
+//! # use optimize::minimizer::Minimizer;
 //! // Define a function that we aim to minimize
 //! let function = |x: ArrayView1<f64>| (1.0 - x[0]).powi(2) + 100.0 * (x[1] - x[0].powi(2)).powi(2);
 //!
@@ -29,7 +30,7 @@
 //! let ans = minimizer.minimize(&function, args.view());
 //!
 //! // Print the optimized values
-//! println!("Final optimized arguments: {}", ans);
+//! println!("Final optimized arguments: {}", ans.minimum_value.unwrap());
 //! ```
 
 #![deny(missing_docs)]
@@ -43,7 +44,8 @@ extern crate derive_builder;
 extern crate float_cmp;
 extern crate num_traits;
 
+pub mod minimizer;
 pub mod scalar;
 pub mod vector;
 
-mod utils;
+mod utils;

src/minimizer.rs

@@ -1,5 +1,42 @@
-
+//! This module provides the base framework for all minimizers present in this crate, such as the
+//! base trait and return type.
 use ndarray::prelude::*;
+use std::time::Duration;
+
+/// Minimizer states at the end of the run
+#[derive(Debug, PartialEq)]
+pub enum RunStatus {
+    /// Minimizer finished successfully.
+    Success,
+    /// Minimization was not succesful
+    Failure,
+}
+
+/// Final minimization parameters that result in the smallest found value.
+#[derive(Debug, PartialEq)]
+pub enum MinResult {
+    /// Scalar parameter value where the minimum is found
+    Scalar(f64),
+    /// Vector of parameters where the minimum if found
+    Vector(Array1<f64>),
+}
+
+/// A minimization result, storing various details of the run and the final results.
+#[derive(Debug, PartialEq)]
+pub struct OptimResult {
+    /// The runtime of the minimization according to the system clock.
+    pub runtime: Option<Duration>,
+    /// The number of function evaluations performed.
+    pub f_evals: Option<usize>,
+    /// The number of iterations run.
+    pub iterations: Option<usize>,
+    /// The final parameter values.
+    pub minimum: Option<MinResult>,
+    /// The function value at the found minimum.
+    pub minimum_value: Option<f64>,
+    /// The minimizer success or failure status.
+    pub status: RunStatus,
+}
 
 /// A general minimizer trait.
 pub trait Minimizer {
@@ -9,5 +46,5 @@ pub trait Minimizer {
         &self,
         func: F,
         args: ArrayView1<f64>,
-    ) -> Array1<f64>;
+    ) -> OptimResult;
 }

src/scalar/mod.rs

@@ -1 +1 @@
-//! This module contains algorithms that search for local minima of functions along a single dimension.
+//! This module contains algorithms that search for local minima of functions along a single dimension.

src/utils.rs

@@ -31,7 +31,6 @@ where
     grad
 }
 
-
 #[cfg(test)]
 mod tests {
 

src/vector/mod.rs

@@ -2,4 +2,4 @@
 
 mod nelder_mead;
 
-pub use self::nelder_mead::NelderMeadBuilder;
+pub use self::nelder_mead::NelderMeadBuilder;