Header menu logo Encodings

SIxOp<'idx, 'op> Type

A sum of products of indexed operators, representing a linear combination.

SIxOp wraps a sum expression (S) of indexed operator products. This is the most general form of a quantum operator in this library, capable of representing Hamiltonians as sums of Pauli strings or fermionic terms.

Example: H = 0.5 X₀Z₁ + 0.3 Y₀Y₁ - 0.2 Z₀

Union cases

Union case Description

SumTerm S<IxOp<'idx, 'op>>

Full Usage: SumTerm S<IxOp<'idx, 'op>>

Parameters:
    Item : S<IxOp<'idx, 'op>>

Item : S<IxOp<'idx, 'op>>

Instance members

Instance member Description

this.AllTermsIndexOrdered

Full Usage: this.AllTermsIndexOrdered

Parameters:
    indexOrder : IndexOrder - The expected ordering direction.

Returns: Lazy<bool> A lazy boolean that is true if all terms satisfy the ordering.

Lazily checks whether all product terms have indices in the specified order.

indexOrder : IndexOrder

The expected ordering direction.

Returns: Lazy<bool>

A lazy boolean that is true if all terms satisfy the ordering.

this.ProductTerms

Full Usage: this.ProductTerms

Returns: Lazy<P<IxOp<'idx, 'op>> array>

Lazily retrieves the sequence of product terms in this sum.

Returns: Lazy<P<IxOp<'idx, 'op>> array>

this.Unapply

Full Usage: this.Unapply

Returns: S<IxOp<'idx, 'op>>

Extracts the underlying sum expression.

Returns: S<IxOp<'idx, 'op>>

Static members

Static member Description

SIxOp.TryCreateFromString(unitFactory)

Full Usage: SIxOp.TryCreateFromString(unitFactory)

Parameters:
    unitFactory : string -> 'op option - A function that parses operators from strings.

Returns: String -> SIxOp<uint32, 'op> option A parser function for sum expressions.

Attempts to parse an SIxOp from a string representation.

unitFactory : string -> 'op option

A function that parses operators from strings.

Returns: String -> SIxOp<uint32, 'op> option

A parser function for sum expressions.

Type something to start searching.