Struct VqeOptimizer

Source

pub struct VqeOptimizer {
    pub energy: Expression,
    pub params: Vec<Expression>,
    pub learning_rate: f64,
}

Expand description

VQE optimizer state

Fields§

§energy: Expression

Energy expression (symbolic Hamiltonian expectation value)

§params: Vec<Expression>

Parameters

§learning_rate: f64

Learning rate

Implementations§

Source §

impl VqeOptimizer

Source

pub fn new( energy: Expression, params: Vec<Expression>, learning_rate: f64, ) -> Self

Create a new VQE optimizer

Source

pub fn compute_gradient( &self, values: &HashMap<String, f64>, ) -> SymEngineResult<Vec<f64>>

Compute gradient at current parameter values

Source

pub fn step(&self, values: &mut HashMap<String, f64>) -> SymEngineResult<f64>

Perform one optimization step

Auto Trait Implementations§

§

impl UnwindSafe for VqeOptimizer

Blanket Implementations§

Source §

impl<T> Any for T
where T: 'static + ?Sized,

Source §

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

Source §

impl<T> Borrow<T> for T
where T: ?Sized,

Source §

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

Source §

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source §

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

impl<T, U> Into for T
where U: From<T>,

Source §

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source §

impl<T> IntoEither for T

Source §

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 more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

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 more

Source §