pub struct QuantumNaturalGradient {
pub fisher_information: Array2<f64>,
pub gradient: Array1<f64>,
pub regularization: f64,
}Expand description
Quantum natural gradient implementations
Fields§
§fisher_information: Array2<f64>§gradient: Array1<f64>§regularization: f64Implementations§
Source§impl QuantumNaturalGradient
impl QuantumNaturalGradient
Sourcepub fn new(parameter_count: usize, regularization: f64) -> Self
pub fn new(parameter_count: usize, regularization: f64) -> Self
Create a new quantum natural gradient calculator
Sourcepub fn compute_fisher_information(
&mut self,
circuit_generator: impl Fn(&Array1<f64>) -> Result<Array2<Complex64>, QuantRS2Error>,
parameters: &Array1<f64>,
state: &Array1<Complex64>,
) -> Result<(), QuantRS2Error>
pub fn compute_fisher_information( &mut self, circuit_generator: impl Fn(&Array1<f64>) -> Result<Array2<Complex64>, QuantRS2Error>, parameters: &Array1<f64>, state: &Array1<Complex64>, ) -> Result<(), QuantRS2Error>
Compute the quantum Fisher information matrix
Sourcepub fn natural_gradient(&self) -> Result<Array1<f64>, QuantRS2Error>
pub fn natural_gradient(&self) -> Result<Array1<f64>, QuantRS2Error>
Compute the natural gradient
Sourcepub fn update_parameters(
&self,
parameters: &Array1<f64>,
learning_rate: f64,
) -> Result<Array1<f64>, QuantRS2Error>
pub fn update_parameters( &self, parameters: &Array1<f64>, learning_rate: f64, ) -> Result<Array1<f64>, QuantRS2Error>
Update parameters using natural gradient descent
Trait Implementations§
Source§impl Clone for QuantumNaturalGradient
impl Clone for QuantumNaturalGradient
Source§fn clone(&self) -> QuantumNaturalGradient
fn clone(&self) -> QuantumNaturalGradient
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 QuantumNaturalGradient
impl RefUnwindSafe for QuantumNaturalGradient
impl Send for QuantumNaturalGradient
impl Sync for QuantumNaturalGradient
impl Unpin for QuantumNaturalGradient
impl UnwindSafe for QuantumNaturalGradient
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.