Skip to main content

ProjectionOperator

oxiphysics_core::convex_analysis

Struct ProjectionOperator 

Source 
pub struct ProjectionOperator;
Expand description

Collection of projection operators onto standard convex sets.

Each method returns the projection of a given point onto a specified set.

Implementations§

Source§

impl ProjectionOperator

Source

pub fn onto_hyperplane(x: &[f64], a: &[f64], b: f64) -> Vec<f64>

Project x onto the hyperplane {z : aᵀz = b}.

proj(x) = x - (aᵀx - b) / ||a||² · a

Source

pub fn onto_halfspace(x: &[f64], a: &[f64], b: f64) -> Vec<f64>

Project x onto the halfspace {z : aᵀz ≤ b}.

If x is already in the halfspace returns x unchanged.

Source

pub fn onto_ball(x: &[f64], center: &[f64], radius: f64) -> Vec<f64>

Project x onto the Euclidean ball B(center, radius).

Source

pub fn onto_box(x: &[f64], lo: &[f64], hi: &[f64]) -> Vec<f64>

Project x onto the axis-aligned box [lo, hi] component-wise.

Source

pub fn onto_simplex(x: &[f64]) -> Vec<f64>

Project x onto the probability simplex Δ = {z ≥ 0 : sum z = 1}.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.