openfermion.linalg.boson_operator_sparse

Initialize a Scipy sparse matrix in the Fock space from a bosonic operator.

openfermion.linalg.boson_operator_sparse(
    operator, trunc, hbar=1.0
)

Used in the notebooks

Used in the tutorials

Since the bosonic operators lie in an infinite Fock space, a truncation value needs to be provide so that a sparse matrix of finite size can be returned.

operator One of either BosonOperator or QuadOperator.
trunc int

The size at which the Fock space should be truncated when returning the matrix representing the ladder operator.

hbar float

the value of hbar to use in the definition of the canonical commutation relation [q_i, pj] = \delta{ij} i hbar. This only applies if calcualating the sparse representation of a quadrature operator.

The corresponding Scipy sparse matrix of size [trunc, trunc].