qcheff.operators.operator_base

Module Contents

Classes

OperatorMatrix

Interface for all operators used in qcheff.

Data

qcheff_dense_array
qcheff_sparse_array
qcheff_array
SparseMatrix
DenseMatrix

API

qcheff_dense_array: TypeAlias

None

qcheff_sparse_array: TypeAlias

None

qcheff_array: TypeAlias

None

SparseMatrix: TypeAlias

None

DenseMatrix: TypeAlias

None

class OperatorMatrix

Bases: typing.Protocol

Interface for all operators used in qcheff.

Parameters

op : qcheff_array The underlying array of the operator. backend_module : ModuleType, optional The module providing the backend for the operator. Defaults to the module of the input operator.

op: qcheff.operators.operator_base.qcheff_array

None

backend_module: types.ModuleType

‘field(…)’

abstractmethod save(filename: str) → None

Save the OperatorMatrix to disk.

Parameters

filename : str The filename to save to.

abstractmethod classmethod load(filename: str) → qcheff.operators.operator_base.OperatorMatrix

Load an OperatorMatrix from disk.

Parameters

filename : str The filename to load from.

Returns

OperatorMatrix The loaded OperatorMatrix.

diagonals() → qcheff.operators.operator_base.qcheff_array

Returns the diagonal elements of the operator.

Returns

qcheff_array The diagonal elements of the operator.

couplings() → qcheff.operators.operator_base.qcheff_array

Returns the off-diagonal elements of the operator.

Returns

off_diagonals : qcheff_array The off-diagonal elements of the operator.