netket.operator.LocalOperator

netket.operator.LocalOperator#

class netket.operator.LocalOperator#

Bases: LocalOperatorBase

A custom local operator. This is a sum of an arbitrary number of operators acting locally on a limited set of k quantum numbers (i.e. k-local, in the quantum information sense).

Inheritance

__init__(hilbert, operators=[], acting_on=[], constant=0, dtype=None, *, mel_cutoff=1e-10)#

Constructs a new LocalOperator given a hilbert space and (if specified) a constant level shift.

Parameters:

hilbert (AbstractHilbert) – Hilbert space the operator acts on.
operators (Union[list[Union[ndarray, Array]], ndarray, Array]) – A list of operators, in matrix form. Supports numpy dense or scipy
format (sparse)
acting_on (Union[list[int], list[list[int]]]) – A list of list of sites, which the corresponding operators act on. This should be constructed such that operators[i] acts on the sites acting_on[i]. If operators is not a list of operators, acting_on should just be the list of corresponding sites.
constant (Number) – Constant diagonal shift of the operator, equivalent to \(+\text{c}\hat{I}\). Default is 0.0.
dtype (Optional[Any]) – The datatype to use for the matrix elements. Defaults to double precision if available.
mel_cutoff (float) – a cutoff to remove small matrix elements (default = 1e-10)

Examples

Constructs a LocalOperator without any operators.

>>> from netket.hilbert import Spin
>>> from netket.operator import LocalOperator
>>> hi = Spin(0.5)**20
>>> empty_hat = LocalOperator(hi)
>>> print(len(empty_hat.acting_on))
0

Attributes

H#: Returns the Conjugate-Transposed operator

T#: Returns the transposed operator

acting_on#

List containing the list of the sites on which every operator acts.

Every operator self.operators[i] acts on the sites self.acting_on[i]

constant#

dtype#

hilbert#: The hilbert space associated to this observable.

is_hermitian#: Returns true if this operator is hermitian.

max_conn_size#: The maximum number of non zero ⟨x|O|x’⟩ for every x.

mel_cutoff#

The cutoff for matrix elements. Only matrix elements such that abs(O(i,i))>mel_cutoff are considered

Type:: float

n_operators#

operators#: List of the matrices of the operators encoded in this Local Operator. Returns a copy.

size#

Methods

__call__(v)#

Call self as a function.

Return type:: ndarray
Parameters:: v (ndarray)

apply(v)#

Return type:: ndarray
Parameters:: v (ndarray)

collect()#

Returns a guaranteed concrete instance of an operator.

As some operations on operators return lazy wrappers (such as transpose, hermitian conjugate…), this is used to obtain a guaranteed non-lazy operator.

Return type:: AbstractOperator

conj(*, concrete=False)#

Return type:: AbstractOperator

conjugate(*, concrete=False)#: LocalOperator: Returns the complex conjugate of this operator.

copy(*, dtype=None, _cls=None)#

Returns a copy of the operator, while optionally changing the dtype of the operator.

Parameters:: dtype (Optional[Any]) – optional dtype

Internal args:: _cls: used to specify the target class

get_conn(x)#

Finds the connected elements of the Operator. Starting from a given quantum number x, it finds all other quantum numbers x’ such that the matrix element \(O(x,x')\) is different from zero. In general there will be several different connected states x’ satisfying this condition, and they are denoted here \(x'(k)\), for \(k=0,1...N_{\mathrm{connected}}\).

Parameters:: x (ndarray) – An array of shape (hilbert.size, ) containing the quantum numbers x.
Returns:: The connected states x’ of shape (N_connected,hilbert.size) array: An array containing the matrix elements \(O(x,x')\) associated to each x’.
Return type:: matrix
Raises:: ValueError – If the given quantum number is not compatible with the hilbert space.

get_conn_filtered(x, sections, filters)[source]#

Finds the connected elements of the Operator using only a subset of operators. Starting from a given quantum number x, it finds all other quantum numbers x’ such that the matrix element \(O(x,x')\) is different from zero. In general there will be several different connected states x’ satisfying this condition, and they are denoted here \(x'(k)\), for \(k=0,1...N_{\mathrm{connected}}\).

This is a batched version, where x is a matrix of shape (batch_size,hilbert.size).

Parameters:

x (matrix) – A matrix of shape (batch_size,hilbert.size) containing the batch of quantum numbers x.
sections (array) – An array of size (batch_size) useful to unflatten the output of this function. See numpy.split for the meaning of sections.
filters (array) – Only operators op(filters[i]) are used to find the connected elements of x[i].

Returns:

The connected states x’, flattened together in a single matrix. array: An array containing the matrix elements \(O(x,x')\) associated to each x’.

Return type:

matrix

get_conn_flattened(x, sections, pad=False)[source]#

This is a batched version, where x is a matrix of shape (batch_size,hilbert.size).

Parameters:

x (matrix) – A matrix of shape (batch_size,hilbert.size) containing the batch of quantum numbers x.
sections (array) – An array of size (batch_size) useful to unflatten the output of this function. See numpy.split for the meaning of sections.
pad (bool) – Whether to use zero-valued matrix elements in order to return all equal sections.

Returns:

The connected states x’, flattened together in a single matrix. array: An array containing the matrix elements \(O(x,x')\) associated to each x’.

Return type:

matrix

get_conn_padded(x)#

Finds the connected elements of the Operator.

Starting from a batch of quantum numbers \(x={x_1, ... x_n}\) of size \(B \times M\) where \(B\) size of the batch and \(M\) size of the hilbert space, finds all states \(y_i^1, ..., y_i^K\) connected to every \(x_i\).

Returns a matrix of size \(B \times K_{max} \times M\) where \(K_{max}\) is the maximum number of connections for every \(y_i\).

Parameters:: x (ndarray) – A N-tensor of shape \((...,hilbert.size)\) containing the batch/batches of quantum numbers \(x\).
Returns:: The connected states x’, in a N+1-tensor and an N-tensor containing the matrix elements \(O(x,x')\) associated to each x’ for every batch.
Return type:: (x_primes, mels)

n_conn(x, out=None)#

Return the number of states connected to x.

Parameters:

x (matrix) – A matrix of shape (batch_size,hilbert.size) containing the batch of quantum numbers x.
out (array) – If None an output array is allocated.

Returns:

The number of connected states x’ for each x[i].

Return type:

array

to_dense()#

Returns the dense matrix representation of the operator. Note that, in general, the size of the matrix is exponential in the number of quantum numbers, and this operation should thus only be performed for low-dimensional Hilbert spaces or sufficiently sparse operators.

This method requires an indexable Hilbert space.

Return type:: ndarray
Returns:: The dense matrix representation of the operator as a Numpy array.

to_jax_operator()[source]#

Returns the jax-compatible version of this operator, which is an instance of netket.operator.LocalOperatorJax.

Return type:: LocalOperatorJax

to_linear_operator()#

to_pauli_strings(**kwargs)#

Convert to PauliStrings object

Return type:: PauliStrings

to_qobj()#

Convert the operator to a qutip’s Qobj.

Returns:: A qutip.Qobj object.

to_sparse()#

Returns the sparse matrix representation of the operator. Note that, in general, the size of the matrix is exponential in the number of quantum numbers, and this operation should thus only be performed for low-dimensional Hilbert spaces or sufficiently sparse operators.

This method requires an indexable Hilbert space.

Return type:: csr_matrix
Returns:: The sparse matrix representation of the operator.

transpose(*, concrete=False)#: LocalOperator: Returns the transpose of this operator.

netket.operator.LocalOperator

Contents

netket.operator.LocalOperator#