Skip to main content

HessianMaterialization

Enum HessianMaterialization 

Source
pub enum HessianMaterialization {
    Unavailable,
    RepeatedHvp,
    BatchedHvp,
    Explicit,
}
Expand description

How (and whether) a HessianOperator can produce a dense materialized Hessian. Reported by HessianOperator::materialization() so a trust-region or ARC solver can decide between calling materialize_dense once and falling back to repeated Hessian-vector products through apply_into.

Variants§

§

Unavailable

Operator cannot produce a dense matrix; only Hv products are available. Solvers that require a dense Hessian must error or fall back to a matrix-free step (Steihaug-Toint, etc.).

§

RepeatedHvp

Materialization is possible but expensive: it costs one apply_into per column. Solvers should prefer matrix-free iterations unless the dimension is small.

§

BatchedHvp

Materialization can use a batched/multi-RHS path that is faster than n separate apply_into calls (e.g. tangent propagation across all basis vectors at once).

§

Explicit

The operator already holds a dense Hessian (or can produce one without extra Hv probes). materialize_dense() is essentially free.

Implementations§

Source§

impl HessianMaterialization

Source

pub fn is_available(self) -> bool

True when materialize_dense is expected to succeed and produce a usable result without significant additional work beyond what any other access would cost.

Trait Implementations§

Source§

impl Clone for HessianMaterialization

Source§

fn clone(&self) -> HessianMaterialization

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for HessianMaterialization

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for HessianMaterialization

Source§

fn eq(&self, other: &HessianMaterialization) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Copy for HessianMaterialization

Source§

impl Eq for HessianMaterialization

Source§

impl StructuralPartialEq for HessianMaterialization

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.