pub struct ParameterShiftOptimizer {
pub shift_value: f64,
pub higher_order_shifts: Vec<f64>,
pub use_finite_differences: bool,
}Expand description
Parameter-shift rule optimizations for ML gradients
Fields§
§shift_value: f64§higher_order_shifts: Vec<f64>§use_finite_differences: boolImplementations§
Source§impl ParameterShiftOptimizer
impl ParameterShiftOptimizer
Sourcepub fn compute_gradient(
&self,
expectation_fn: impl Fn(&Array1<f64>) -> Result<f64, QuantRS2Error>,
parameters: &Array1<f64>,
) -> Result<Array1<f64>, QuantRS2Error>
pub fn compute_gradient( &self, expectation_fn: impl Fn(&Array1<f64>) -> Result<f64, QuantRS2Error>, parameters: &Array1<f64>, ) -> Result<Array1<f64>, QuantRS2Error>
Compute gradient using parameter-shift rule
Sourcepub fn higher_order_gradient(
&self,
expectation_fn: impl Fn(&Array1<f64>) -> Result<f64, QuantRS2Error>,
parameters: &Array1<f64>,
param_idx: usize,
) -> Result<f64, QuantRS2Error>
pub fn higher_order_gradient( &self, expectation_fn: impl Fn(&Array1<f64>) -> Result<f64, QuantRS2Error>, parameters: &Array1<f64>, param_idx: usize, ) -> Result<f64, QuantRS2Error>
Higher-order parameter shifts for better accuracy
Trait Implementations§
Source§impl Clone for ParameterShiftOptimizer
impl Clone for ParameterShiftOptimizer
Source§fn clone(&self) -> ParameterShiftOptimizer
fn clone(&self) -> ParameterShiftOptimizer
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 ParameterShiftOptimizer
impl Debug for ParameterShiftOptimizer
Auto Trait Implementations§
impl Freeze for ParameterShiftOptimizer
impl RefUnwindSafe for ParameterShiftOptimizer
impl Send for ParameterShiftOptimizer
impl Sync for ParameterShiftOptimizer
impl Unpin for ParameterShiftOptimizer
impl UnwindSafe for ParameterShiftOptimizer
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.