netket.hilbert.CustomHilbert#

class netket.hilbert.CustomHilbert[source]#

Bases: HomogeneousHilbert

A custom hilbert space with discrete local quantum numbers.

Inheritance
Inheritance diagram of netket.hilbert.CustomHilbert
__init__(local_states, N=1, constraint_fn=None)[source]#

Constructs a new CustomHilbert given a list of eigenvalues of the states and a number of sites, or modes, within this hilbert space.

Parameters:
  • local_states (Optional[StaticRange]) – StaticRange object describing the numbers used to encode the local degree of freedom of this Hilbert Space.

  • N (int) – Number of modes in this hilbert space (default 1).

  • constraint_fn (Optional[Callable]) – A function specifying constraints on the quantum numbers. Given a batch of quantum numbers it should return a vector of bools specifying whether those states are valid or not.

The netket.utils.StaticRange object works like a standard range object and is used to define the valid configurations of the local degrees of freedom.

For example, the StaticRange of a Fock Hilbert space is constructed as

>>> import netket as nk
>>> n_max = 10
>>> nk.utils.StaticRange(start=0, step=1, length=n_max)
StaticRange(start=0, step=1, length=10, dtype=int64)

and the range of a Spin-1/2 Hilbert space is constructed as:

>>> import netket as nk
>>> n_max = 10
>>> nk.utils.StaticRange(start=-1, step=2, length=2)
StaticRange(start=-1, step=2, length=2, dtype=int64)

Examples

Simple custom hilbert space.

>>> import netket as nk
>>> g = nk.graph.Hypercube(length=10,n_dim=2,pbc=True)
>>> local_states = nk.utils.StaticRange(start=-2.0, step=1.0, length=4)
>>> hi = nk.hilbert.CustomHilbert(local_states=local_states, N=100)
>>> print(hi.size)
100
Attributes
constrained#

The hilbert space does not contain prod(hilbert.shape) basis states.

Typical constraints are population constraints (such as fixed number of bosons, fixed magnetization…) which ensure that only a subset of the total unconstrained space is populated.

Typically, objects defined in the constrained space cannot be converted to QuTiP or other formats.

is_finite#

Whether the local hilbert space is finite.

is_indexable#

Whether the space can be indexed with an integer

local_size#

Size of the local degrees of freedom that make the total hilbert space.

local_states#

A list of discrete local quantum numbers. If the local states are infinitely many, None is returned.

n_states#

The total dimension of the many-body Hilbert space. Throws an exception iff the space is not indexable.

shape#

The size of the hilbert space on every site.

size#

The total number number of degrees of freedom.

Methods
all_states()#

Returns all valid states of the Hilbert space.

Throws an exception if the space is not indexable.

Return type:

ndarray

Returns:

A (n_states x size) batch of states. this corresponds to the pre-allocated array if it was passed.

numbers_to_states(numbers)#

Returns the quantum numbers corresponding to the n-th basis state for input n.

n is an array of integer indices such that numbers[k]=Index(states[k]). Throws an exception iff the space is not indexable.

This function validates the inputs by checking that the numbers provided are smaller than the Hilbert space size, and throws an error if that condition is not met. When called from within a jax.jit context, this uses {func}`equinox.error_if` to throw runtime errors.

Parameters:

numbers (numpy.array) – Batch of input numbers to be converted into arrays of quantum numbers.

Return type:

Union[ndarray, Array]

ptrace(sites)#

Returns the hilbert space without the selected sites.

Not all hilbert spaces support this operation.

Parameters:

sites (Union[int, Iterable]) – a site or list of sites to trace away

Return type:

AbstractHilbert

Returns:

The partially-traced hilbert space. The type of the resulting hilbert space might be different from the starting one.

random_state(key=None, size=None, dtype=<class 'numpy.float32'>)#

Generates either a single or a batch of uniformly distributed random states. Runs as random_state(self, key, size=None, dtype=np.float32) by default.

Parameters:
  • key – rng state from a jax-style functional generator.

  • size (Optional[int]) – If provided, returns a batch of configurations of the form (size, N) if size is an integer or (*size, N) if it is a tuple and where \(N\) is the Hilbert space size. By default, a single random configuration with shape (#,) is returned.

  • dtype – DType of the resulting vector.

Return type:

Array

Returns:

A state or batch of states sampled from the uniform distribution on the hilbert space.

Example

>>> import netket, jax
>>> hi = netket.hilbert.Qubit(N=2)
>>> k1, k2 = jax.random.split(jax.random.PRNGKey(1))
>>> print(hi.random_state(key=k1))
[1. 0.]
>>> print(hi.random_state(key=k2, size=2))
[[0. 0.]
 [0. 1.]]
size_at_index(i)#

Size of the local degrees of freedom for the i-th variable.

Parameters:

i (int) – The index of the desired site

Return type:

int

Returns:

The number of degrees of freedom at that site

states()#

Returns an iterator over all valid configurations of the Hilbert space. Throws an exception iff the space is not indexable. Iterating over all states with this method is typically inefficient, and `all_states` should be preferred.

Return type:

Iterator[ndarray]

states_at_index(i)#

A list of discrete local quantum numbers at the site i.

If the local states are infinitely many, None is returned.

Parameters:

i (int) – The index of the desired site.

Returns:

A list of values or None if there are infinitely many.

states_to_local_indices(x)#

Returns a tensor with the same shape of x, where all local values are converted to indices in the range 0…self.shape[i]. This function is guaranteed to be jax-jittable.

For the Fock space this returns x, but for other hilbert spaces such as Spin this returns an array of indices.

Warning

This function is experimental. Use at your own risk.

Parameters:

x (Union[ndarray, Array]) – a tensor containing samples from this hilbert space

Returns:

a tensor containing integer indices into the local hilbert

states_to_numbers(states)#

Returns the basis state number corresponding to given quantum states.

The states are given in a batch, such that states[k] has shape (hilbert.size). Throws an exception iff the space is not indexable.

Parameters:

states (Union[ndarray, Array]) – Batch of states to be converted into the corresponding integers.

Returns:

Array of integers corresponding to states.

Return type:

numpy.darray