Struct optimization_engine::constraints::Rectangle

pub struct Rectangle<'a> { /* fields omitted */ }

A rectangle, $R = \{x \in \mathbb{R}^n {}:{} x_{\min} {}\leq{} x {}\leq{} x_{\max}\}$

A set of the form $\{x \in \mathbb{R}^n {}:{} x_{\min} {}\leq{} x {}\leq{} x_{\max}\}$, where $\leq$ is meant in the element-wise sense and either of $x_{\min}$ and $x_{\max}$ can be equal to infinity.

Implementations

impl<'a> Rectangle<'a>

pub fn new(xmin: Option<&'a [f64]>, xmax: Option<&'a [f64]>) -> Rectangle<'a>

Construct a new rectangle with given $x_{\min}$ and $x_{\max}$

Arguments

• xmin: minimum value of x
• xmin: maximum value of x

Note

Rectangle does not copy xmin and xmax internally; it only keeps a reference. You may set one of xmin and xmax to None (but not both).

Panics

The method panics if:

• Both xmin and xmax are None (use NoConstraints instead)
• Both xmin and xmax have been provided, but they have incompatible dimensions

Trait Implementations

impl<'a> Clone for Rectangle<'a>

fn clone(&self) -> Rectangle<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Constraint for Rectangle<'a>

fn project(&self, x: &mut [f64])

Projection onto the set, that is,

fn is_convex(&self) -> bool

Returns true if and only if the set is convex

impl<'a> Copy for Rectangle<'a>