pub struct AdaptiveToleranceState {
pub current_ftol: f64,
pub current_gtol: f64,
pub current_xtol: f64,
/* private fields */
}Expand description
State tracking for adaptive tolerance selection
Fields§
§current_ftol: f64Current function tolerance
current_gtol: f64Current gradient tolerance
current_xtol: f64Current step tolerance
Implementations§
Source§impl AdaptiveToleranceState
impl AdaptiveToleranceState
Sourcepub fn new(options: AdaptiveToleranceOptions, problem_dim: usize) -> Self
pub fn new(options: AdaptiveToleranceOptions, problem_dim: usize) -> Self
Create new adaptive tolerance state
Sourcepub fn update(
&mut self,
function_value: f64,
gradient_norm: f64,
step_norm: f64,
iteration: usize,
) -> Result<(), OptimizeError>
pub fn update( &mut self, function_value: f64, gradient_norm: f64, step_norm: f64, iteration: usize, ) -> Result<(), OptimizeError>
Update state with new iteration data and adapt tolerances
Sourcepub fn get_current_options(&self, base_options: &Options) -> Options
pub fn get_current_options(&self, base_options: &Options) -> Options
Get current Options struct with adapted tolerances
Sourcepub fn check_convergence(
&self,
function_change: f64,
step_norm: f64,
gradient_norm: f64,
) -> ConvergenceStatus
pub fn check_convergence( &self, function_change: f64, step_norm: f64, gradient_norm: f64, ) -> ConvergenceStatus
Check if convergence is achieved with current tolerances
Sourcepub fn get_adaptation_stats(&self) -> AdaptationStats
pub fn get_adaptation_stats(&self) -> AdaptationStats
Get adaptation statistics for debugging
Trait Implementations§
Source§impl Clone for AdaptiveToleranceState
impl Clone for AdaptiveToleranceState
Source§fn clone(&self) -> AdaptiveToleranceState
fn clone(&self) -> AdaptiveToleranceState
Returns a duplicate of the value. Read more
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreAuto Trait Implementations§
impl Freeze for AdaptiveToleranceState
impl RefUnwindSafe for AdaptiveToleranceState
impl Send for AdaptiveToleranceState
impl Sync for AdaptiveToleranceState
impl Unpin for AdaptiveToleranceState
impl UnwindSafe for AdaptiveToleranceState
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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 moreSource§impl<T> Pointable for T
impl<T> Pointable for T
Source§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
Source§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct
self from the equivalent element of its
superset. Read moreSource§fn is_in_subset(&self) -> bool
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
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
fn from_subset(element: &SS) -> SP
The inclusion map: converts
self to the equivalent element of its superset.