pub struct OptimizationTrajectory {
pub parameters: Vec<Array1<f64>>,
pub function_values: Vec<f64>,
pub gradient_norms: Vec<f64>,
pub step_sizes: Vec<f64>,
pub custom_metrics: HashMap<String, Vec<f64>>,
pub nit: Vec<usize>,
pub times: Vec<f64>,
}
Expand description
Trajectory data collected during optimization
Fields§
§parameters: Vec<Array1<f64>>
Parameter values at each iteration
function_values: Vec<f64>
Function values at each iteration
gradient_norms: Vec<f64>
Gradient norms at each iteration (if available)
step_sizes: Vec<f64>
Step sizes at each iteration (if available)
custom_metrics: HashMap<String, Vec<f64>>
Custom metrics at each iteration
nit: Vec<usize>
Iteration numbers
times: Vec<f64>
Wall clock times (in seconds from start)
Implementations§
Source§impl OptimizationTrajectory
impl OptimizationTrajectory
Sourcepub fn add_point(
&mut self,
iteration: usize,
params: &ArrayView1<'_, f64>,
function_value: f64,
time: f64,
)
pub fn add_point( &mut self, iteration: usize, params: &ArrayView1<'_, f64>, function_value: f64, time: f64, )
Add a new point to the trajectory
Sourcepub fn add_gradient_norm(&mut self, grad_norm: f64)
pub fn add_gradient_norm(&mut self, grad_norm: f64)
Add gradient norm information
Sourcepub fn add_step_size(&mut self, step_size: f64)
pub fn add_step_size(&mut self, step_size: f64)
Add step size information
Sourcepub fn add_custom_metric(&mut self, name: &str, value: f64)
pub fn add_custom_metric(&mut self, name: &str, value: f64)
Add custom metric
Sourcepub fn final_parameters(&self) -> Option<&Array1<f64>>
pub fn final_parameters(&self) -> Option<&Array1<f64>>
Get the final parameter values
Sourcepub fn final_function_value(&self) -> Option<f64>
pub fn final_function_value(&self) -> Option<f64>
Get the final function value
Sourcepub fn convergence_rate(&self) -> Option<f64>
pub fn convergence_rate(&self) -> Option<f64>
Calculate convergence rate (linear convergence coefficient)
Trait Implementations§
Source§impl Clone for OptimizationTrajectory
impl Clone for OptimizationTrajectory
Source§fn clone(&self) -> OptimizationTrajectory
fn clone(&self) -> OptimizationTrajectory
Returns a duplicate of the value. Read more
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moreSource§impl Debug for OptimizationTrajectory
impl Debug for OptimizationTrajectory
Auto Trait Implementations§
impl Freeze for OptimizationTrajectory
impl RefUnwindSafe for OptimizationTrajectory
impl Send for OptimizationTrajectory
impl Sync for OptimizationTrajectory
impl Unpin for OptimizationTrajectory
impl UnwindSafe for OptimizationTrajectory
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.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.