XACC
Public Member Functions | Protected Attributes | List of all members
xacc::algorithm::ParameterShiftGradient Class Reference
Inheritance diagram for xacc::algorithm::ParameterShiftGradient:
xacc::AlgorithmGradientStrategy xacc::Identifiable

Public Member Functions

bool optionalParameters (const HeterogeneousMap parameters) override
 
std::vector< std::shared_ptr< CompositeInstruction > > getGradientExecutions (std::shared_ptr< CompositeInstruction > circuit, const std::vector< double > &x) override
 
void compute (std::vector< double > &dx, std::vector< std::shared_ptr< AcceleratorBuffer >> results) override
 
const std::string name () const override
 
const std::string description () const override
 
- Public Member Functions inherited from xacc::Identifiable
virtual ~Identifiable ()
 

Protected Attributes

std::shared_ptr< ObservableH
 
std::shared_ptr< Observablecommutator
 
double factor = 0.5
 
- Protected Attributes inherited from xacc::AlgorithmGradientStrategy
std::vector< int > nInstructionsElement
 
std::vector< double > coefficients
 

Member Function Documentation

const std::string xacc::algorithm::ParameterShiftGradient::description ( ) const
inlineoverridevirtual

Return the description of this instance

Returns
description The description of this object.

Implements xacc::Identifiable.

const std::string xacc::algorithm::ParameterShiftGradient::name ( ) const
inlineoverridevirtual

Return the name of this instance.

Returns
name The string name

Implements xacc::Identifiable.


The documentation for this class was generated from the following file: