openfermion.ops.BosonOperator

BosonOperator stores a sum of products of bosonic ladder operators.

Inherits From: SymbolicOperator

openfermion.ops.BosonOperator(
    term=None, coefficient=1.0
)

Used in the notebooks

Used in the tutorials

In OpenFermion, we describe bosonic ladder operators using the shorthand: 'i^' = b^\dagger_i 'j' = b_j where ['i', 'j^'] = delta_ij is the commutator.

One can multiply together these bosonic ladder operators to obtain a bosonic term. For instance, '2^ 1' is a bosonic term which creates at mode 2 and destroys at mode 1. The BosonicOperator class also stores a coefficient for the term, e.g. '3.17 * 2^ 1'.

The BosonOperator class is designed (in general) to store sums of these terms. For instance, an instance of BosonOperator might represent 3.17 2^ 1 - 66.2 * 8^ 7 6^ 2 The Bosonic Operator class overloads operations for manipulation of these objects by the user.

BosonOperator is a subclass of SymbolicOperator. Importantly, it has attributes set as follows::

actions = (1, 0)
action_strings = ('^', '')
action_before_index = False
different_indices_commute = True

See the documentation of SymbolicOperator for more details.

.. code-block:: python

H = (BosonOperator('0^ 3', .5)

   + .5 * BosonOperator('3^ 0'))

Equivalently

H2 = BosonOperator('0^ 3', 0.5) H2 += BosonOperator('3^ 0', 0.5)

Adding BosonOperator is faster using += (as this is done by in-place addition). Specifying the coefficient during initialization is faster than multiplying a BosonOperator with a scalar.

action_before_index Whether action comes before index in string representations.
action_strings The string representations of the allowed actions.
actions The allowed actions.
constant The value of the constant term.
different_indices_commute Whether factors acting on different indices commute.

Methods

accumulate

View source

@classmethod
accumulate(
    operators, start=None
)

Sums over SymbolicOperators.

compress

View source

compress(
    abs_tol=EQ_TOLERANCE
)

Eliminates all terms with coefficients close to zero and removes small imaginary and real parts.

Args
abs_tol float

Absolute tolerance, must be at least 0.0

get_operator_groups

View source

get_operator_groups(
    num_groups
)

Gets a list of operators with a few terms.

Args
num_groups int

How many operators to get in the end.

Returns
operators [self.__class__]

A list of operators summing up to self.

get_operators

View source

get_operators()

Gets a list of operators with a single term.

Returns
operators [self.__class__]

A generator of the operators in self.

identity

View source

@classmethod
identity()

Returns: multiplicative_identity (SymbolicOperator): A symbolic operator u with the property that ux = xu = x for all operators x of the same class.

induced_norm

View source

induced_norm(
    order=1
)

Compute the induced p-norm of the operator.

If we represent an operator as \(\sum_{j} w_j H_j\) where \(w_j\) are scalar coefficients then this norm is \(\left(\sum_{j} \| w_j \|^p \right)^{\frac{1}{p} }\) where \(p\) is the order of the induced norm

Args
order int

the order of the induced norm.

is_boson_preserving

View source

is_boson_preserving()

Query whether the term preserves particle number.

This is equivalent to requiring the same number of raising and lowering operators in each term.

is_normal_ordered

View source

is_normal_ordered()

Return whether or not term is in normal order.

In our convention, ladder operators come first. Note that unlike the Fermion operator, due to the commutation of ladder operators with different indices, the BosonOperator sorts ladder operators by index.

isclose

View source

isclose(
    other, tol=EQ_TOLERANCE
)

Check if other (SymbolicOperator) is close to self.

Comparison is done for each term individually. Return True if the difference between each term in self and other is less than EQ_TOLERANCE

Args
other SymbolicOperator

SymbolicOperator to compare against.

many_body_order

View source

many_body_order()

Compute the many-body order of a SymbolicOperator.

The many-body order of a SymbolicOperator is the maximum length of a term with nonzero coefficient.

Returns
int

zero

View source

@classmethod
zero()

Returns: additive_identity (SymbolicOperator): A symbolic operator o with the property that o+x = x+o = x for all operators x of the same class.

__add__

View source

__add__(
    addend
)

Args: addend (SymbolicOperator): The operator to add.

Returns
sum (SymbolicOperator)

__div__

View source

__div__(
    divisor
)

For compatibility with Python 2.

__eq__

View source

__eq__(
    other
)

Approximate numerical equality (not true equality).

__iter__

View source

__iter__()

__mul__

View source

__mul__(
    multiplier
)

Return self * multiplier for a scalar, or a SymbolicOperator.

Args
multiplier A scalar, or a SymbolicOperator.

Returns
product (SymbolicOperator)

Raises
TypeError Invalid type cannot be multiply with SymbolicOperator.

__ne__

View source

__ne__(
    other
)

Return self!=value.

__neg__

View source

__neg__()

Returns: negation (SymbolicOperator)

__pow__

View source

__pow__(
    exponent
)

Exponentiate the SymbolicOperator.

Args
exponent int

The exponent with which to raise the operator.

Returns
exponentiated (SymbolicOperator)

Raises
ValueError Can only raise SymbolicOperator to non-negative integer powers.

__radd__

View source

__radd__(
    addend
)

Args: addend (SymbolicOperator): The operator to add.

Returns
sum (SymbolicOperator)

__rmul__

View source

__rmul__(
    multiplier
)

Return multiplier * self for a scalar.

We only define rmul for scalars because the left multiply exist for SymbolicOperator and left multiply is also queried as the default behavior.

Args
multiplier A scalar to multiply by.

Returns
product A new instance of SymbolicOperator.

Raises
TypeError Object of invalid type cannot multiply SymbolicOperator.

__rsub__

View source

__rsub__(
    subtrahend
)

Args: subtrahend (SymbolicOperator): The operator to subtract.

Returns
difference (SymbolicOperator)

__sub__

View source

__sub__(
    subtrahend
)

Args: subtrahend (SymbolicOperator): The operator to subtract.

Returns
difference (SymbolicOperator)

__truediv__

View source

__truediv__(
    divisor
)

Return self / divisor for a scalar.

Note
This is always floating point division.

Args
divisor A scalar to divide by.

Returns
A new instance of SymbolicOperator.

Raises
TypeError Cannot divide local operator by non-scalar type.