Header menu logo Encodings

PIxOp<'idx, 'op> Type

A product of indexed operators, representing a tensor product of operators at specific sites.

PIxOp wraps a product term (P) of indexed operators. For example, the Pauli string X₀Z₂Y₃ would be a PIxOp containing three IxOp values.

The product includes a coefficient (from the underlying P type) and a sequence of indexed operator units.

Example

 // A Pauli product X₀ ⊗ Z₁ with coefficient 0.5
 let pauliString = PIxOp.TryCreateFromString Pauli.TryParse "0.5 (X, 0) (Z, 1)"
val pauliString: obj

Union cases

Union case Description

ProductTerm P<IxOp<'idx, 'op>>

Full Usage: ProductTerm P<IxOp<'idx, 'op>>

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

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

Instance members

Instance member Description

this.IsInIndexOrder

Full Usage: this.IsInIndexOrder

Parameters:
    indexOrder : IndexOrder - The expected ordering direction.

Returns: bool True if indices satisfy the ordering constraint.

Checks whether the operator indices are in the specified order.

indexOrder : IndexOrder

The expected ordering direction.

Returns: bool

True if indices satisfy the ordering constraint.

this.IsInIndexOrderAscending

Full Usage: this.IsInIndexOrderAscending

Returns: bool

Checks whether indices are in ascending order (0, 1, 2, ...).

Returns: bool

this.IsInIndexOrderDescending

Full Usage: this.IsInIndexOrderDescending

Returns: bool

Checks whether indices are in descending order (..., 2, 1, 0).

Returns: bool

this.Unapply

Full Usage: this.Unapply

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

Extracts the underlying product term.

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

this.Units

Full Usage: this.Units

Returns: Lazy<C<IxOp<'idx, 'op>>[]>

Lazily retrieves the sequence of operator units in this product.

Returns: Lazy<C<IxOp<'idx, 'op>>[]>

Static members

Static member Description

PIxOp.TryCreateFromString(unitFactory)

Full Usage: PIxOp.TryCreateFromString(unitFactory)

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

Returns: String -> PIxOp<uint32, 'op> option A parser function for product terms.

Attempts to parse a PIxOp from a string representation.

unitFactory : string -> 'op option

A function that parses operators from strings.

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

A parser function for product terms.

Type something to start searching.