LadderSequence<TIndex> Class

Definition

Class representing a sequence of raising and lowering operators.

[Newtonsoft.Json.JsonConverter(typeof(Microsoft.Quantum.Chemistry.Json.LadderSequenceJsonConverter))]
public class LadderSequence<TIndex> : IEquatable<Microsoft.Quantum.Chemistry.LadderOperators.LadderSequence<TIndex>> where TIndex : IEquatable<TIndex>
[<Newtonsoft.Json.JsonConverter(typeof(Microsoft.Quantum.Chemistry.Json.LadderSequenceJsonConverter))>]
type LadderSequence<'Index (requires 'Index :> IEquatable<'Index>)> = class
    interface IEquatable<LadderSequence<'Index>>
Public Class LadderSequence(Of TIndex)
Implements IEquatable(Of LadderSequence(Of TIndex))

Type Parameters

TIndex
Inheritance
LadderSequence<TIndex>
Derived
Attributes
Newtonsoft.Json.JsonConverterAttribute
Implements

Constructors

LadderSequence<TIndex>()

Constructor for empty ladder operator sequence.

LadderSequence<TIndex>(IEnumerable<LadderOperator<TIndex>>, Int32)

Construct instance from sequence of ladder operators.

LadderSequence<TIndex>(IEnumerable<TIndex>)

Construct a sequence of ladder operators from an even-length sequence of integers.

LadderSequence<TIndex>(LadderSequence<TIndex>)

Constructor for an identical ladder operator sequence.

Properties

Coefficient

sign (-1,+1) coefficient of ladder operators.

Sequence

Sequence of ladder operators.

Methods

_JsonGetCoefficient()

Returns sign coefficient of ladder operator sequence.

_JsonGetSequence()

Returns ladder operator sequence.

_JsonSetCoefficient(Int32)

Sets sign coefficient of ladder operator sequence.

_JsonSetObject(Object)

Used only for JSON serialization.

_JsonSetSequence(Object)

Sets ladder operator sequence.

Equals(LadderSequence<TIndex>)
Equals(Object)
GetHashCode()
IsInNormalOrder()

Checks whether all raising operators are to the left of all lowering operators.

Multiply(LadderSequence<TIndex>, LadderSequence<TIndex>)

Concatenates two Fermion terms.

SelectIndex<TNewIndex>(Func<TIndex,TNewIndex>)

Creates a new ladder sequence with a different indexing scheme.

ToIndices()

Returns list of indices of the ladder operator sequence.

ToLadderSequence()

Returns a copy of the ladder sequence base class.

ToRaisingLowering()

Returns sequence of raising and lowering types of the ladder operator sequence.

ToString()

Returns a human-readable description of this object.

UniqueIndices()

Counts the number of unique system indices across all LadderOperator<TIndex> terms in a LadderSequence<TIndex>

Operators

Equality(LadderSequence<TIndex>, LadderSequence<TIndex>)
Implicit(ValueTuple<RaisingLowering,TIndex>[] to LadderSequence<TIndex>)
Inequality(LadderSequence<TIndex>, LadderSequence<TIndex>)

Extension Methods

ToIndexOrder<TIndex>(LadderSequence<TIndex>)

Converts a LadderSequence to normal order, then index order. In general, this can generate new terms and modifies the coefficient.

ToNormalOrder<TIndex>(LadderSequence<TIndex>)

Converts a LadderSequence to normal order. In general, this can generate new terms and modifies the coefficient.

Applies to