fqe.S2Operator

The :math:S^2 operator.

Inherits From: FqeOperator

Methods

contract

View source

contract(
    brastate: "Wavefunction",
    ketstate: "Wavefunction"
) -> complex

Given two wavefunctions, generate the expectation value of the operator according to its representation.

Args
brastate Wavefunction on the bra side.
ketstate Wavefunction on the ket side.

rank

View source

rank()

Returns rank of the operator.

representation

View source

representation()

Returns the representation of the operator.