Spin.EnergyExpectation Method

Liquid Quantum Simulator

previous page next page

The Language-Integrated Quantum Operations (LIQUi|>) Simulator

SpinEnergyExpectation Method

Finds the expectation value of the Hamiltonian. That is, given a state vector |psi>, this method computes <psi|H|psi>.

Namespace: Microsoft.Research.Liquid
Assembly: Liquid1 (in Liquid1.dll) Version: 1.0.5981.24943 (1.0.*)

Syntax

Copy

member EnergyExpectation : 
        stdev : bool * 
        anneal : FSharpOption<float[]> * 
        qubits : FSharpOption<FSharpList<Qubit>> -> Tuple<float, float>

Parameters

stdev: Type: SystemBoolean
Whether or not to evaluate the standard deviation as well.
anneal: Type: Microsoft.FSharp.CoreFSharpOptionDouble
An optional array of annealing values to use. The default is to use the most recent annealing values.
qubits: Type: Microsoft.FSharp.CoreFSharpOptionFSharpListQubit
An optional state vector to take the expectation value against. The default is to use this.Ket.Qubits; that is, the qubits from the current Ket vector.

Return Value

Type: TupleDouble, Double
A tuple of the expectation value and standard deviation. The standard deviation will be 0.0 if it was not computed.

Reference

Spin Class

Microsoft.Research.Liquid Namespace

previous page start next page