Struct Simplex 

pub struct Simplex<T = f64> { /* private fields */ }

A simplex with level $\alpha$ is a set of the form $\Delta_\alpha^n = \{x \in \mathbb{R}^n {}:{} x \geq 0, \sum_i x_i = \alpha\}$, where $\alpha$ is a positive constant.

Implementations

impl<T: Float> Simplex<T>

pub fn new(alpha: T) -> Self

Construct a new simplex with given (positive) $\alpha$. The user does not need to specify the dimension of the simplex.

Example

use optimization_engine::constraints::{Constraint, Simplex};

let simplex = Simplex::new(1.0);
let mut x = [0.5, -0.5, 2.0];
simplex.project(&mut x).unwrap();

Trait Implementations

impl<T: Clone> Clone for Simplex<T>

fn clone(&self) -> Simplex<T>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Float> Constraint<T> for Simplex<T>

fn project(&self, x: &mut [T]) -> FunctionCallResult

Project onto $\Delta_\alpha^n$ using Condat’s fast projection algorithm.

See: Laurent Condat. Fast Projection onto the Simplex and the $\ell_1$ Ball. Mathematical Programming, Series A, Springer, 2016, 158 (1), pp.575-585. ⟨10.1007/s10107-015-0946-6⟩.

fn is_convex(&self) -> bool

Returns true if and only if the set is convex

impl<T: Copy> Copy for Simplex<T>