solvr 0.2.0

Advanced computing library for real-world problem solving - optimization, differential equations, interpolation, statistics, and more
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

//! Semidefinite Programming (SDP) trait.
//!
//! Solves: min trace(C*X)
//!         s.t. trace(A_i*X) = b_i  for each constraint
//!              X >= 0 (positive semidefinite)
use crate::DType;

use numr::runtime::Runtime;
use numr::tensor::Tensor;

use crate::optimize::error::OptimizeResult;

/// Options for SDP solver.
#[derive(Debug, Clone)]
pub struct SdpOptions {
    /// Maximum iterations.
    pub max_iter: usize,
    /// Convergence tolerance.
    pub tol: f64,
}

impl Default for SdpOptions {
    fn default() -> Self {
        Self {
            max_iter: 200,
            tol: 1e-8,
        }
    }
}

/// Result of SDP solver.
#[derive(Debug, Clone)]
pub struct SdpResult<R: Runtime<DType = DType>> {
    /// Solution matrix X `[n, n]`.
    pub x: Tensor<R>,
    /// Optimal objective value.
    pub fun: f64,
    /// Dual variables.
    pub dual: Tensor<R>,
    /// Number of iterations.
    pub iterations: usize,
    /// Whether converged.
    pub converged: bool,
}

/// Trait for SDP algorithms.
pub trait SdpAlgorithms<R: Runtime<DType = DType>> {
    /// Solve a semidefinite program.
    ///
    /// min  trace(C*X)
    /// s.t. trace(A_i*X) = b_i
    ///      X >= 0  (positive semidefinite)
    ///
    /// # Arguments
    ///
    /// * `c_mat` - Cost matrix `[n, n]`
    /// * `a_mats` - Constraint matrices, each `[n, n]`
    /// * `b_vec` - Constraint RHS values `[m]`
    /// * `options` - Solver options
    fn solve_sdp(
        &self,
        c_mat: &Tensor<R>,
        a_mats: &[Tensor<R>],
        b_vec: &Tensor<R>,
        options: &SdpOptions,
    ) -> OptimizeResult<SdpResult<R>>;
}