resopt 0.3.0

Declarative constrained residual optimization in Rust
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
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

use std::time::Instant;

use crate::{
    solve::{SolveDiagnostics, SolveOptions, SolveResult, SolveStatus, Solver},
    ConstrainedResidualProblem, Error,
};

#[cfg(feature = "clarabel")]
use crate::backends::clarabel::ClarabelSolver;

/// Default public solver.
///
/// When the `clarabel` feature is enabled, this solver delegates supported
/// problems to the Clarabel backend. Otherwise, it returns `NotImplemented`.
#[derive(Debug, Clone, PartialEq)]
pub struct DefaultSolver {
    options: SolveOptions,
}

impl DefaultSolver {
    pub fn new() -> Self {
        Self {
            options: SolveOptions::default(),
        }
    }

    pub fn with_options(mut self, options: SolveOptions) -> Self {
        self.options = options;
        self
    }

    pub fn options(&self) -> &SolveOptions {
        &self.options
    }
}

impl Default for DefaultSolver {
    fn default() -> Self {
        Self::new()
    }
}

impl Solver for DefaultSolver {
    fn solve(&self, problem: &ConstrainedResidualProblem) -> Result<SolveResult, Error> {
        let start = Instant::now();

        if let Err(_err) = problem.validate() {
            let diagnostics = SolveDiagnostics::new(
                0,
                "problem validation failed".to_string(),
                start.elapsed().as_secs_f64(),
                None,
            );

            return Ok(SolveResult::new(
                SolveStatus::InvalidProblem,
                None,
                None,
                diagnostics,
            ));
        }

        #[cfg(feature = "clarabel")]
        {
            ClarabelSolver::new()
                .with_options(self.options.clone())
                .solve(problem)
        }

        #[cfg(not(feature = "clarabel"))]
        {
            let diagnostics = SolveDiagnostics::new(
                0,
                "default solver is not implemented yet; enable the `clarabel` feature".to_string(),
                start.elapsed().as_secs_f64(),
                None,
            );

            Ok(SolveResult::new(
                SolveStatus::NotImplemented,
                None,
                None,
                diagnostics,
            ))
        }
    }
}