pub struct AutoDiffContext {
pub parameters: Vec<f64>,
pub parameter_names: Vec<String>,
pub method: GradientMethod,
pub gradients: Vec<f64>,
pub grad_evaluations: usize,
pub func_evaluations: usize,
}
Expand description
Automatic differentiation context for tracking gradients
Fields§
§parameters: Vec<f64>
Parameter values
parameter_names: Vec<String>
Parameter names/indices
method: GradientMethod
Gradient computation method
gradients: Vec<f64>
Current gradients
grad_evaluations: usize
Gradient computation count
func_evaluations: usize
Function evaluation count
Implementations§
Source§impl AutoDiffContext
impl AutoDiffContext
Sourcepub fn new(parameters: Vec<f64>, method: GradientMethod) -> Self
pub fn new(parameters: Vec<f64>, method: GradientMethod) -> Self
Create new autodiff context
Sourcepub fn with_parameter_names(self, names: Vec<String>) -> Self
pub fn with_parameter_names(self, names: Vec<String>) -> Self
Set parameter names
Sourcepub fn update_parameters(&mut self, new_params: Vec<f64>)
pub fn update_parameters(&mut self, new_params: Vec<f64>)
Update parameters
Sourcepub fn get_parameter(&self, name: &str) -> Option<f64>
pub fn get_parameter(&self, name: &str) -> Option<f64>
Get parameter by name
Trait Implementations§
Source§impl Clone for AutoDiffContext
impl Clone for AutoDiffContext
Source§fn clone(&self) -> AutoDiffContext
fn clone(&self) -> AutoDiffContext
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 moreAuto Trait Implementations§
impl Freeze for AutoDiffContext
impl RefUnwindSafe for AutoDiffContext
impl Send for AutoDiffContext
impl Sync for AutoDiffContext
impl Unpin for AutoDiffContext
impl UnwindSafe for AutoDiffContext
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.