cova-solver 0.1.2

Cova's solvers library
Documentation 
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

//! Common traits and types for optimization solvers using argmin framework

use cova_algebra::tensors::DVector;

use crate::SolverResult;

/// Solution information returned by solvers
#[derive(Debug, Clone)]
pub struct Solution {
  /// The optimal solution vector
  pub x:               DVector<f64>,
  /// The optimal objective value
  pub objective_value: f64,
  /// Number of iterations taken
  pub iterations:      u64,
  /// Whether the solver converged
  pub converged:       bool,
  /// Termination reason
  pub termination:     String,
}

/// Common interface for optimization problems that can be solved with argmin
pub trait OptimizationProblem {
  /// Get the problem dimension
  fn dimension(&self) -> usize;

  /// Solve the optimization problem using argmin
  fn solve(&self) -> SolverResult<Solution>;
}