netket.operator.PauliStrings

class netket.operator.PauliStrings(hilbert, operators=None, weights=None, *, cutoff=1e-10, dtype=<class 'complex'>)

Bases: netket.operator.DiscreteOperator

A Hamiltonian consisiting of the sum of products of Pauli operators.

Inheritance
Inheritance diagram of netket.operator.PauliStrings
__init__(hilbert, operators=None, weights=None, *, cutoff=1e-10, dtype=<class 'complex'>)[source]

Constructs a new PauliStrings operator given a set of Pauli operators. This class has two possible forms for initialization: PauliStrings(hilbert, operators, ...) or PauliStrings(operators, ...). When no hilbert argument is passed, the hilbert defaults to Qubit, where the number of qubits is automatically deduced from the operators.

Parameters
  • hilbert (AbstractHilbert) – A hilbert space, optional (is no AbstractHilbert is passed, default is Qubit)

  • operators (list(string)) – A list of Pauli operators in string format, e.g. [‘IXX’, ‘XZI’].

  • weights (Optional[List[Union[float, complex]]]) – A list of amplitudes of the corresponding Pauli operator.

  • cutoff (float) – a cutoff to remove small matrix elements

  • dtype (Any) –

Examples

Constructs a new PauliStrings operator X_0*X_1 + 3.*Z_0*Z_1 with both construction schemes.

>>> import netket as nk
>>> operators, weights = ['XX','ZZ'], [1,3]
>>> op = nk.operator.PauliStrings(operators, weights)
>>> op.hilbert
Qubit(N=2)
>>> op.hilbert.size
2
>>> hilbert = nk.hilbert.Spin(1/2, 2)
>>> op = nk.operator.PauliStrings(hilbert, operators, weights)
>>> op.hilbert
Spin(s=1/2, N=2)
Attributes
H

Returns the Conjugate-Transposed operator

Return type

AbstractOperator

T

Returns the transposed operator

Return type

AbstractOperator

dtype

The dtype of the operator’s matrix elements ⟨σ|Ô|σ’⟩.

Return type

Any

hilbert

The hilbert space associated to this operator.

Return type

AbstractHilbert

is_hermitian

Returns true if this operator is hermitian.

Return type

bool

max_conn_size

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

Return type

int

size

The total number number of local degrees of freedom.

Return type

int

Methods
__call__(v)

Call self as a function.

Return type

ndarray

Parameters

v (numpy.ndarray) –

apply(v)
Return type

ndarray

Parameters

v (numpy.ndarray) –

collect()

Returns a guranteed concrete instancce of an operator.

As some operations on operators return lazy wrapperes (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)

Returns the complex-conjugate of this operator.

Parameters

concrete – if True returns a concrete operator and not a lazy wrapper

Return type

AbstractOperator

Returns

if concrete is not True, self or a lazy wrapper; the complex-conjugated operator otherwise

static from_openfermion(hilbert, of_qubit_operator=None, *, n_qubits=None)[source]

Converts an openfermion QubitOperator into a netket PauliStrings. The hilbert first argument can be dropped, see __init__ for details and default value

Parameters
  • hilbert (optional) – hilbert of the resulting PauliStrings object

  • of_qubit_operator (required) – openfermion.ops.QubitOperator object

  • n_qubits (int) – total number of qubits in the system, default None means inferring it from the QubitOperator. Argument is ignored when hilbert is given.

Returns

A PauliStrings object.

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}}\). :type x: ndarray :param x: An array of shape (hilbert.size) containing the quantum numbers x. :type x: array

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.

Parameters

x (numpy.ndarray) –

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

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}}\).

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.

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 x 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 x Kmax x M where Kmax is the maximum number of connections for every y_i. :type x: ndarray :param x: 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. mels: A N-tensor containing the matrix elements \(O(x,x')\)

associated to each x’ for every batch.

Return type

x_primes

Parameters

x (numpy.ndarray) –

static identity(hilbert, **kwargs)[source]
Parameters

hilbert (netket.hilbert.AbstractHilbert) –

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_linear_operator()
to_qobj()

Convert the operator to a qutip’s Qobj. :rtype: qutip.Qobj :returns: A qutip.Qobj object.

Return type

qutip.Qobj

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)

Returns the transpose of this operator.

Parameters

concrete – if True returns a concrete operator and not a lazy wrapper

Return type

AbstractOperator

Returns

if concrete is not True, self or a lazy wrapper; the transposed operator otherwise