argmin::solver::quasinewton::sr1

Struct SR1

Source
pub struct SR1<L, H, F> { /* private fields */ }
Expand description

SR1 method (broken!)

Example

§References:

[0] Jorge Nocedal and Stephen J. Wright (2006). Numerical Optimization. Springer. ISBN 0-387-30303-0.

Implementations§

Source§

impl<L, H, F: ArgminFloat> SR1<L, H, F>

Source

pub fn new(init_inverse_hessian: H, linesearch: L) -> Self

Constructor

Source

pub fn r(self, r: F) -> Result<Self, Error>

Set r

Source

pub fn with_tol_grad(self, tol_grad: F) -> Self

Sets tolerance for the stopping criterion based on the change of the norm on the gradient

Source

pub fn with_tol_cost(self, tol_cost: F) -> Self

Sets tolerance for the stopping criterion based on the change of the cost stopping criterion

Trait Implementations§

Source§

impl<L: Clone, H: Clone, F: Clone> Clone for SR1<L, H, F>

Source§

fn clone(&self) -> SR1<L, H, F>

Returns a copy 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<'de, L, H, F> Deserialize<'de> for SR1<L, H, F>
where L: Deserialize<'de>, H: Deserialize<'de>, F: Deserialize<'de>,

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl<L, H, F> Serialize for SR1<L, H, F>
where L: Serialize, H: Serialize, F: Serialize,

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl<O, L, H, F> Solver<O> for SR1<L, H, F>
where O: ArgminOp<Output = F, Hessian = H, Float = F>, O::Param: Debug + Clone + Default + Serialize + ArgminSub<O::Param, O::Param> + ArgminDot<O::Param, O::Float> + ArgminDot<O::Param, O::Hessian> + ArgminNorm<O::Float> + ArgminMul<O::Float, O::Param>, O::Hessian: Debug + Clone + Default + Serialize + DeserializeOwned + ArgminSub<O::Hessian, O::Hessian> + ArgminDot<O::Param, O::Param> + ArgminDot<O::Hessian, O::Hessian> + ArgminAdd<O::Hessian, O::Hessian> + ArgminMul<F, O::Hessian>, L: Clone + ArgminLineSearch<O::Param, O::Float> + Solver<OpWrapper<O>>, F: ArgminFloat,

Source§

const NAME: &'static str = "SR1"

Name of the solver
Source§

fn init( &mut self, op: &mut OpWrapper<O>, state: &IterState<O>, ) -> Result<Option<ArgminIterData<O>>, Error>

Initializes the algorithm Read more
Source§

fn next_iter( &mut self, op: &mut OpWrapper<O>, state: &IterState<O>, ) -> Result<ArgminIterData<O>, Error>

Computes one iteration of the algorithm.
Source§

fn terminate(&mut self, state: &IterState<O>) -> TerminationReason

Checks whether the algorithm must be terminated
Source§

fn terminate_internal(&mut self, state: &IterState<O>) -> TerminationReason

Checks whether basic termination reasons apply. Read more

Auto Trait Implementations§

§

impl<L, H, F> Freeze for SR1<L, H, F>
where F: Freeze, H: Freeze, L: Freeze,

§

impl<L, H, F> RefUnwindSafe for SR1<L, H, F>

§

impl<L, H, F> Send for SR1<L, H, F>
where F: Send, H: Send, L: Send,

§

impl<L, H, F> Sync for SR1<L, H, F>
where F: Sync, H: Sync, L: Sync,

§

impl<L, H, F> Unpin for SR1<L, H, F>
where F: Unpin, H: Unpin, L: Unpin,

§

impl<L, H, F> UnwindSafe for SR1<L, H, F>
where F: UnwindSafe, H: UnwindSafe, L: UnwindSafe,

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, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. 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.
Source§

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

Source§

fn vzip(self) -> V

Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> SendSyncUnwindSafe for T
where T: Send + Sync + UnwindSafe + ?Sized,