Struct Hyperplane

pub struct Hyperplane<'a> { /* private fields */ }

A hyperplane is a set given by $H = \{x \in \mathbb{R}^n {}:{} \langle c, x\rangle = b\}$.

Implementations

impl<'a> Hyperplane<'a>

pub fn new(normal_vector: &'a [f64], offset: f64) -> Self

A hyperplane is a set given by $H = \{x \in \mathbb{R}^n {}:{} \langle c, x\rangle = b\}$, where $c$ is the normal vector of the hyperplane and $b$ is an offset.

This method constructs a new instance of Hyperplane with a given normal vector and bias

Arguments

• normal_vector: the normal vector, $c$, as a slice
• offset: the offset parameter, $b$

Returns

New instance of Hyperplane

Panics

Does not panic. Note: it does not panic if you provide an empty slice as normal_vector, but you should avoid doing that.

Example

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

let normal_vector = [1., 2.];
let offset = 1.0;
let hyperplane = Hyperplane::new(&normal_vector, offset);
let mut x = [-1., 3.];
hyperplane.project(&mut x);

Trait Implementations

impl<'a> Clone for Hyperplane<'a>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Constraint for Hyperplane<'a>

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

Projects on the hyperplane using the formula:

$$\begin{aligned} \mathrm{proj}_{H}(x) = x - \frac{\langle c, x\rangle - b} {\|c\|}c. \end{aligned}$$

where $H = \{x \in \mathbb{R}^n {}:{} \langle c, x\rangle = b\}$

Arguments

• x: (in) vector to be projected on the current instance of a hyperplane, (out) projection on the second-order cone

Panics

This method panics if the length of x is not equal to the dimension of the hyperplane.

fn is_convex(&self) -> bool

Hyperplanes are convex sets

Returns

Returns true