Skip to main content

FunctionClass

Enum FunctionClass 

Source
pub enum FunctionClass {
    SquaredNorm,
    EuclideanNorm,
    NegativeEntropy,
    LpNorm {
        p: f64,
    },
    BoxIndicator {
        lo: f64,
        hi: f64,
    },
    Numerical,
}
Expand description

Identifies the class of a convex function for exact conjugate computation.

Variants§

§

SquaredNorm

f(x) = (1/2) ‖x‖² — conjugate is f* = (1/2) ‖y‖².

§

EuclideanNorm

f(x) = ‖x‖ (Euclidean norm) — conjugate is indicator of unit ball.

§

NegativeEntropy

f(x) = sum_i x_i log x_i (negative entropy, domain x > 0) — conjugate is sum_i e^{y_i - 1}.

§

LpNorm

f(x) = (1/p) ‖x‖_p^p — conjugate is (1/q) ‖y‖_q^q (1/p + 1/q = 1).

Fields

§

BoxIndicator

Indicator of a hyperbox [lo, hi]^n — conjugate is sum_i max(lo y_i, hi y_i).

Fields

§lo: f64
§hi: f64
§

Numerical

Unknown / use numerical approximation.

Trait Implementations§

Source§

impl Clone for FunctionClass

Source§

fn clone(&self) -> FunctionClass

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for FunctionClass

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.