Fermion Class

Fermion Class

Hamiltonian simulation for fermionic systems.

Inheritance Hierarchy

SystemObject
Microsoft.Research.LiquidHamiltonian
Microsoft.Research.LiquidFermion

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

Syntax

Copy

[<SerializableAttribute>]
type Fermion =  
    class
        inherit Hamiltonian
    end

The Fermion type exposes the following members.

Constructors

	Name	Description
	Fermion(Double, Double, Int32, Int32, Int32, DictionaryString, String, FSharpFuncDouble, FSharpFuncFSharpListQubit, Unit)	Creates a new Fermion instance from a prebuilt Circuit.
	Fermion(Double, Double, Int32, Int32, Int32, FSharpListTupleInt32, Int32, Double, FSharpListTupleInt32, Int32, Int32, Int32, Double, DictionaryString, String, FSharpOptionFSharpListInt32)	Creates a new Fermion instance from orbit overlap integrals.

Top

Properties

	Name	Description
	bits	The mumber of phase estimation bits. This is the bit precision plus two.
	Circs	The built circuits, in bit order.
	currentCirc	The last circuit that was run (ungrown).
	decohereModel	The decoherence model for this Hamiltonian. (Inherited from Hamiltonian.)
	eMax	The maximum energy for phase estimation.
	eMin	The minimum energy for phase estimation.
	Energy	The result of phase estimation, interpreted as an energy. This will always be between eMin and eMax. This value is only available after Run has been called.
	Ket	Gets the Ket vector associated with this Hamiltonian (Inherited from Hamiltonian.)
	omega	The energy range, eMax - eMin, for phase estimation.
	order	The trotter order for phase estimation.
	Phase	The result of phase estimation, as an angle between 0 and 2*pi. This value is only available after Run has been called.
	trotterN	The trotter number for phase estimation.
	tTotal	The total evolution time for phase estimation. This is equal to 2*p1/omega.
	Ua	The gate function that implements a full Hamiltonian time step

Top

Methods

	Name	Description
	Build	Builds either a grown circuit or an exponentiated unitary.
	Clean	Cleans out temporary files.
	Dump	Dumps out information on this simulator.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	Load	Loads a Fermion test from a .dat file based on a script.
	LoadOrbs	Loads orbital information from an array of strings.
	PhaseSetup	Sets up phase estimation for all runs.
	Prep	Prepares an initial state from the provided spin orbital indices.
	Run(Boolean, FSharpOptionInt32)	Runs the simulation to obtain a phase estimate. A previous call to Build() or BuildSingle() is required.
	Run(DictionaryString, String, String)	Runs a Fermion test from a .dat file, based on a script A basic axecution trace is sent to both the console and the log. Detailed information is sent just sent to the log. See the Users Manual for details on the parameters.
	Run(DictionaryString, String, String)	Runs a pre-loaded Fermion test based on a script. A basic axecution trace is sent to both the console and the log. Detailed information is sent just sent to the log. See the Users Manual for details on the parameters.
	Run(DictionaryString, String, FSharpFuncDouble, FSharpFuncFSharpListQubit, Unit, Ket)	Runs a Fermion test from a pre-built circuit and state vector. See the Users Manual for details on the parameters.
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Remarks

This class simulates second-quantized models of electrons with a state space consisting of spin-up/spin-down pairs, with both one-body and two-body interactions.

In particular, this includes second-quantized quantum chemistry, where the state pairs are molecular orbitals, and the individual states are spin orbitals. In this case, the interaction terms come from various orbital overlap integrals. See the Users Manual for more detailed information.

Reference

Microsoft.Research.Liquid Namespace