Spin Class

Spin Class

Hamiltonian for spin systems, such as the Ising model or a spin glass.

Inheritance Hierarchy

Namespace: Microsoft.Research.Liquid
Assembly: Liquid1 (in Liquid1.dll) Version: 1.0.0.0 (1.0.0.0)

Syntax

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

The Spin type exposes the following members.

Constructors

	Name	Description
	Spin(DictionaryInt32, Double, DictionaryTupleInt32, Int32, Double)	Creates a spin Hamiltonian for simple systems that only have single spin biases and two-spin couplings. The count of spins is inferred.
	Spin(FSharpListSpinTerm, Int32, FSharpOptionRunMode)	Creates a spin Hamiltonian from a set of spin terms.

Properties

	Name	Description
	currentCirc	The last (grown) circuit that was run.
	decohereModel	The decoherence model for this Hamiltonian. (Inherited from Hamiltonian.)
	Ket	Gets the Ket vector associated with this Hamiltonian (Inherited from Hamiltonian.)
	lastAnneal	The last set of annealing coefficients that were applied.
	lastRawCirc	The last (ungrown) circuit that was run.
	runMode	The run mode. Note that setting this property will force a new circuit to be generated.
	time	The current simulation time. Note that setting this property will force a new circuit to be generated.
	trotterN	The Trotter number. Note that setting this property will force a new circuit to be generated.

Methods

	Name	Description
	Copy	Returns an instance of Spin with the same Hamiltonian parameters as this instance. Simulation parameters such as run time and Trotter number are not copied.
	EnergyExpectation	Finds the expectation value of the Hamiltonian. That is, given a state vector \|psi>, this method computes <psi\|H\|psi>.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Ferro	Test adiabatic evolution with a ferro-magnetic chain
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	Peek	Peeks at the current Hamiltonian matrix. This is based on the most recently grown circuit.
	Prep	Prepares the qubit state for a run. All qubits are resets and initialized to the ground state.
	Run	Runs the simulation. This is a highly optimized implementation.
	Step	Performs a single timestep of simulation.
	Test(String, Int32, Int32, FSharpListTupleInt32, Double, Int32, Spin, FSharpOptionBoolean, FSharpOptionFSharpListTupleFSharpFuncQubit, Unit, Double)	Executes a set of simulation runs for a spin Hamiltonian.
	Test(String, Int32, Int32, DictionaryInt32, Double, DictionaryTupleInt32, Int32, Double, FSharpListTupleInt32, Double, Double, Int32, FSharpOptionBoolean, FSharpOptionFSharpListTupleFSharpFuncQubit, Unit, Double)	Executes a set of simulation runs for a spin Hamiltonian.
	ToString	Returns a string that represents the current object. (Inherited from Object.)