Skip to main content

ConvexFunction

Struct ConvexFunction 

Source
pub struct ConvexFunction {
    pub name: String,
    pub lipschitz_grad: Option<f64>,
    pub strong_convexity: Option<f64>,
    /* private fields */
}
Expand description

Represents a convex function f : ℝ^n → ℝ with optional gradient.

Fields§

§name: String

Name of the function.

§lipschitz_grad: Option<f64>

Lipschitz constant of gradient (if known).

§strong_convexity: Option<f64>

Strong convexity modulus (if known).

Implementations§

Source§

impl ConvexFunction

Source

pub fn new( name: impl Into<String>, eval_fn: fn(&[f64]) -> f64, grad_fn: Option<fn(&[f64]) -> Vec<f64>>, ) -> Self

Construct a new convex function.

Source

pub fn eval(&self, x: &[f64]) -> f64

Evaluate f at x.

Source

pub fn gradient(&self, x: &[f64]) -> Vec<f64>

Compute gradient of f at x (finite differences if no exact gradient provided).

Source

pub fn fenchel_conjugate_approx( &self, y: &[f64], radius: f64, steps: usize, ) -> f64

Compute the Fenchel conjugate f*(y) = sup_x {⟨y,x⟩ - f(x)} approximately via grid search on [-R, R]^n with resolution steps.

Source

pub fn in_epigraph(&self, x: &[f64], t: f64) -> bool

Compute epigraph membership: (x, t) ∈ epi(f) iff f(x) ≤ t.

Source

pub fn in_level_set(&self, x: &[f64], alpha: f64) -> bool

Compute level set membership: x ∈ lev_α(f) iff f(x) ≤ α.

Trait Implementations§

Source§

impl Clone for ConvexFunction

Source§

fn clone(&self) -> ConvexFunction

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 ConvexFunction

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.