Struct argmin::solver::trustregion::trustregion_method::TrustRegion
source · [−]pub struct TrustRegion<R, F> { /* private fields */ }
Expand description
The trust region method approximates the cost function within a certain region around the current point in parameter space. Depending on the quality of this approximation, the region is either expanded or contracted.
The calculation of the actual step length and direction is done by one of the following methods:
This subproblem can be set via set_subproblem(...)
. If this is not provided, it will default
to the Steihaug method.
References:
[0] Jorge Nocedal and Stephen J. Wright (2006). Numerical Optimization. Springer. ISBN 0-387-30303-0.
Implementations
sourceimpl<R, F> TrustRegion<R, F> where
F: ArgminFloat,
impl<R, F> TrustRegion<R, F> where
F: ArgminFloat,
Trait Implementations
sourceimpl<R: Clone, F: Clone> Clone for TrustRegion<R, F>
impl<R: Clone, F: Clone> Clone for TrustRegion<R, F>
sourcefn clone(&self) -> TrustRegion<R, F>
fn clone(&self) -> TrustRegion<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, R, F> Deserialize<'de> for TrustRegion<R, F> where
R: Deserialize<'de>,
F: Deserialize<'de>,
impl<'de, R, F> Deserialize<'de> for TrustRegion<R, F> where
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<R, F> Serialize for TrustRegion<R, F> where
R: Serialize,
F: Serialize,
impl<R, F> Serialize for TrustRegion<R, F> where
R: Serialize,
F: Serialize,
sourceimpl<O, R, F, P, G, H> Solver<O, IterState<P, G, (), H, F>> for TrustRegion<R, F> where
O: CostFunction<Param = P, Output = F> + Gradient<Param = P, Gradient = G> + Hessian<Param = P, Hessian = H>,
P: Clone + SerializeAlias + DeserializeOwnedAlias + ArgminNorm<F> + ArgminDot<P, F> + ArgminDot<G, F> + ArgminAdd<P, P>,
G: Clone + SerializeAlias + DeserializeOwnedAlias,
H: Clone + SerializeAlias + DeserializeOwnedAlias + ArgminDot<P, P>,
R: Clone + TrustRegionRadius<F> + Solver<O, IterState<P, G, (), H, F>>,
F: ArgminFloat,
impl<O, R, F, P, G, H> Solver<O, IterState<P, G, (), H, F>> for TrustRegion<R, F> where
O: CostFunction<Param = P, Output = F> + Gradient<Param = P, Gradient = G> + Hessian<Param = P, Hessian = H>,
P: Clone + SerializeAlias + DeserializeOwnedAlias + ArgminNorm<F> + ArgminDot<P, F> + ArgminDot<G, F> + ArgminAdd<P, P>,
G: Clone + SerializeAlias + DeserializeOwnedAlias,
H: Clone + SerializeAlias + DeserializeOwnedAlias + ArgminDot<P, P>,
R: Clone + TrustRegionRadius<F> + Solver<O, IterState<P, G, (), H, F>>,
F: ArgminFloat,
sourcefn init(
&mut self,
problem: &mut Problem<O>,
state: IterState<P, G, (), H, F>
) -> Result<(IterState<P, G, (), H, F>, Option<KV>), Error>
fn init(
&mut self,
problem: &mut Problem<O>,
state: IterState<P, G, (), H, F>
) -> Result<(IterState<P, G, (), H, F>, Option<KV>), Error>
Initializes the algorithm. Read more
sourcefn next_iter(
&mut self,
problem: &mut Problem<O>,
state: IterState<P, G, (), H, F>
) -> Result<(IterState<P, G, (), H, F>, Option<KV>), Error>
fn next_iter(
&mut self,
problem: &mut Problem<O>,
state: IterState<P, G, (), H, F>
) -> Result<(IterState<P, G, (), H, F>, Option<KV>), Error>
sourcefn terminate(&mut self, _state: &IterState<P, G, (), H, F>) -> TerminationReason
fn terminate(&mut self, _state: &IterState<P, G, (), H, 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<R, F> RefUnwindSafe for TrustRegion<R, F> where
F: RefUnwindSafe,
R: RefUnwindSafe,
impl<R, F> Send for TrustRegion<R, F> where
F: Send,
R: Send,
impl<R, F> Sync for TrustRegion<R, F> where
F: Sync,
R: Sync,
impl<R, F> Unpin for TrustRegion<R, F> where
F: Unpin,
R: Unpin,
impl<R, F> UnwindSafe for TrustRegion<R, F> where
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