optimization_engine 0.12.0

A pure Rust framework for embedded nonconvex optimization. Ideal for robotics!
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

use super::Constraint;
use crate::FunctionCallResult;

/// The whole space, no constraints
#[derive(Default, Clone, Copy)]
pub struct NoConstraints {}

impl NoConstraints {
    /// Constructs new instance of `NoConstraints`
    ///
    /// # Example
    ///
    /// ```
    /// use optimization_engine::constraints::{Constraint, NoConstraints};
    ///
    /// let no_constraints = NoConstraints::new();
    /// let mut x = [1.0, -2.0, 3.0];
    /// no_constraints.project(&mut x).unwrap();
    /// ```
    ///
    #[must_use]
    pub fn new() -> NoConstraints {
        NoConstraints {}
    }
}

impl<T> Constraint<T> for NoConstraints {
    fn project(&self, _x: &mut [T]) -> FunctionCallResult {
        Ok(())
    }

    fn is_convex(&self) -> bool {
        true
    }
}