qrunch.quantum.operators.second_quantization.hardcore_boson.operator_base

Base class for all fermion operators, which define internal logic.

Classes

PairedHardcoreBosonOperator

Base class for an abstract hardcore boson operator.

PairedHardcoreBosonOperators

Represents the collection of hardcore boson operators.

class PairedHardcoreBosonOperator

Bases: Expression[PairedHardcoreBosonOperators], Indexable[PairedHardcoreBosonOperators], ABC

Base class for an abstract hardcore boson operator.

All concrete hardcore boson operators should inherit from this.

This class serves as the foundation for all boson operators, specifically annihilation and creation operators for bosons.

__init__(site: AbstractIndex | int) None

Initialize the boson operator on a specific site.

Parameters:

site (AbstractIndex | int) – The site to act upon.

Return type:

None

get_indices() tuple[AbstractIndex | int]

Get indices of the operator.

Return type:

tuple[AbstractIndex | int]

property site: AbstractIndex | int

The site the operator acts on.

with_indices(index_value_pairs: IndexValuePairs) PairedHardcoreBosonOperator

Create a new copy of the operator with the AbstractIndex set to the given value.

Parameters:

index_value_pairs (IndexValuePairs) – Map of abstract indices to concrete values.

Return type:

PairedHardcoreBosonOperator

class PairedHardcoreBosonOperators

Bases: OperatorCollection

Represents the collection of hardcore boson operators.