Skip to main content

CostModel

Struct CostModel 

Source
pub struct CostModel { /* private fields */ }
Expand description

A problem’s cost, ready to evaluate.

Implementations§

Source§

impl CostModel

Source

pub fn new(problem: Problem) -> Self

Wrap a built problem.

Source

pub fn with_threads(self, threads: usize) -> Result<Self>

Evaluate on a pool of threads threads instead of the default one. No effect without the parallel feature or on wasm32.

Source

pub fn problem(&self) -> &Problem

The problem.

Source

pub fn dim(&self) -> usize

Number of parameters.

Source

pub fn eval_generic<T: Scalar>( &self, x: &[T], grad: bool, ) -> Result<(T, T, T, Option<Vec<T>>)>

(cost, fidelity, penalty, gradient of the cost) over any scalar type; the gradient only when grad.

Source

pub fn value(&self, x: &[f64]) -> Result<Eval>

The cost at x.

Source

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

The cost and its gradient at x.

Source

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

The Hessian of the cost at x applied to v, exactly: the reverse pass over dual numbers x + ε·v.

Source

pub fn hessian_matrix(&self, x: &[f64]) -> Result<DMatrix<f64>>

The Hessian of the cost at x: one exact Hessian-vector product per column, possibly in parallel, symmetrised.

Source

pub fn waveforms(&self, x: &[f64]) -> Result<Waveforms>

The modulated waveforms at x.

Trait Implementations§

Source§

impl Objective for CostModel

Source§

fn dim(&self) -> usize

Number of parameters.
Source§

fn value(&self, x: &[f64]) -> Result<Eval>

The objective at x.
Source§

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

The objective and its gradient at x.
Source§

fn hessian(&self, x: &[f64]) -> Result<(Eval, Vec<f64>, DMatrix<f64>)>

The objective, its gradient and its Hessian at x.
Source§

fn hvp(&self, x: &[f64], v: &[f64]) -> Result<Vec<f64>>

The Hessian at x applied to v. The default forms the whole Hessian; objectives that can do better override it.

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> SendAlias for T

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> SyncAlias for T

Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V