Struct argmin::solver::quasinewton::sr1_trustregion::SR1TrustRegion
source · [−]pub struct SR1TrustRegion<B, R, F> { /* private fields */ }
Expand description
SR1 Trust Region method
References:
[0] Jorge Nocedal and Stephen J. Wright (2006). Numerical Optimization. Springer. ISBN 0-387-30303-0.
Implementations
sourceimpl<B, R, F> SR1TrustRegion<B, R, F> where
F: ArgminFloat,
impl<B, R, F> SR1TrustRegion<B, R, F> where
F: ArgminFloat,
sourcepub fn hessian(self, init_hessian: B) -> Self
pub fn hessian(self, init_hessian: B) -> Self
provide initial Hessian (it will be computed if not provided)
sourcepub fn with_tolerance_grad(self, tol_grad: F) -> Self
pub fn with_tolerance_grad(self, tol_grad: F) -> Self
Sets tolerance for the stopping criterion based on the change of the norm on the gradient
Trait Implementations
sourceimpl<B: Clone, R: Clone, F: Clone> Clone for SR1TrustRegion<B, R, F>
impl<B: Clone, R: Clone, F: Clone> Clone for SR1TrustRegion<B, R, F>
sourcefn clone(&self) -> SR1TrustRegion<B, R, F>
fn clone(&self) -> SR1TrustRegion<B, R, F>
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl<'de, B, R, F> Deserialize<'de> for SR1TrustRegion<B, R, F> where
B: Deserialize<'de>,
R: Deserialize<'de>,
F: Deserialize<'de>,
impl<'de, B, R, F> Deserialize<'de> for SR1TrustRegion<B, R, F> where
B: Deserialize<'de>,
R: Deserialize<'de>,
F: Deserialize<'de>,
sourcefn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
sourceimpl<B, R, F> Serialize for SR1TrustRegion<B, R, F> where
B: Serialize,
R: Serialize,
F: Serialize,
impl<B, R, F> Serialize for SR1TrustRegion<B, R, F> where
B: Serialize,
R: Serialize,
F: Serialize,
sourceimpl<O, R, P, G, B, F> Solver<O, IterState<P, G, (), B, F>> for SR1TrustRegion<B, R, F> where
O: CostFunction<Param = P, Output = F> + Gradient<Param = P, Gradient = G> + Hessian<Param = P, Hessian = B>,
P: Clone + SerializeAlias + DeserializeOwnedAlias + ArgminSub<P, P> + ArgminAdd<P, P> + ArgminDot<P, F> + ArgminDot<P, B> + ArgminNorm<F> + ArgminZeroLike,
G: Clone + SerializeAlias + DeserializeOwnedAlias + ArgminNorm<F> + ArgminDot<P, F> + ArgminSub<G, P>,
B: Clone + SerializeAlias + DeserializeOwnedAlias + ArgminDot<P, P> + ArgminAdd<B, B> + ArgminMul<F, B>,
R: Clone + TrustRegionRadius<F> + Solver<O, IterState<P, G, (), B, F>>,
F: ArgminFloat + ArgminNorm<F>,
impl<O, R, P, G, B, F> Solver<O, IterState<P, G, (), B, F>> for SR1TrustRegion<B, R, F> where
O: CostFunction<Param = P, Output = F> + Gradient<Param = P, Gradient = G> + Hessian<Param = P, Hessian = B>,
P: Clone + SerializeAlias + DeserializeOwnedAlias + ArgminSub<P, P> + ArgminAdd<P, P> + ArgminDot<P, F> + ArgminDot<P, B> + ArgminNorm<F> + ArgminZeroLike,
G: Clone + SerializeAlias + DeserializeOwnedAlias + ArgminNorm<F> + ArgminDot<P, F> + ArgminSub<G, P>,
B: Clone + SerializeAlias + DeserializeOwnedAlias + ArgminDot<P, P> + ArgminAdd<B, B> + ArgminMul<F, B>,
R: Clone + TrustRegionRadius<F> + Solver<O, IterState<P, G, (), B, F>>,
F: ArgminFloat + ArgminNorm<F>,
sourcefn init(
&mut self,
problem: &mut Problem<O>,
state: IterState<P, G, (), B, F>
) -> Result<(IterState<P, G, (), B, F>, Option<KV>), Error>
fn init(
&mut self,
problem: &mut Problem<O>,
state: IterState<P, G, (), B, F>
) -> Result<(IterState<P, G, (), B, F>, Option<KV>), Error>
Initializes the algorithm. Read more
sourcefn next_iter(
&mut self,
problem: &mut Problem<O>,
state: IterState<P, G, (), B, F>
) -> Result<(IterState<P, G, (), B, F>, Option<KV>), Error>
fn next_iter(
&mut self,
problem: &mut Problem<O>,
state: IterState<P, G, (), B, F>
) -> Result<(IterState<P, G, (), B, F>, Option<KV>), Error>
sourcefn terminate(&mut self, state: &IterState<P, G, (), B, F>) -> TerminationReason
fn terminate(&mut self, state: &IterState<P, G, (), B, F>) -> TerminationReason
Used to implement stopping criteria, in particular criteria which are not covered by
(terminate_internal
. Read more
sourcefn terminate_internal(&mut self, state: &I) -> TerminationReason
fn terminate_internal(&mut self, state: &I) -> TerminationReason
Checks whether basic termination reasons apply. Read more
Auto Trait Implementations
impl<B, R, F> RefUnwindSafe for SR1TrustRegion<B, R, F> where
B: RefUnwindSafe,
F: RefUnwindSafe,
R: RefUnwindSafe,
impl<B, R, F> Send for SR1TrustRegion<B, R, F> where
B: Send,
F: Send,
R: Send,
impl<B, R, F> Sync for SR1TrustRegion<B, R, F> where
B: Sync,
F: Sync,
R: Sync,
impl<B, R, F> Unpin for SR1TrustRegion<B, R, F> where
B: Unpin,
F: Unpin,
R: Unpin,
impl<B, R, F> UnwindSafe for SR1TrustRegion<B, R, F> where
B: UnwindSafe,
F: UnwindSafe,
R: UnwindSafe,
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,
pub fn to_subset(&self) -> Option<SS>
pub fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct self
from the equivalent element of its
superset. Read more
pub fn is_in_subset(&self) -> bool
pub fn is_in_subset(&self) -> bool
Checks if self
is actually part of its subset T
(and can be converted to it).
pub fn to_subset_unchecked(&self) -> SS
pub fn to_subset_unchecked(&self) -> SS
Use with care! Same as self.to_subset
but without any property checks. Always succeeds.
pub fn from_subset(element: &SS) -> SP
pub fn from_subset(element: &SS) -> SP
The inclusion map: converts self
to the equivalent element of its superset.
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcepub fn to_owned(&self) -> T
pub fn to_owned(&self) -> T
Creates owned data from borrowed data, usually by cloning. Read more
sourcepub fn clone_into(&self, target: &mut T)
pub fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more