netket.hilbert.Spin¶
-
class
netket.hilbert.
Spin
(s, N=1, total_sz=None, graph=None)[source]¶ Bases:
netket.hilbert.custom_hilbert.CustomHilbert
Hilbert space obtained as tensor product of local spin states.
-
__init__
(s, N=1, total_sz=None, graph=None)[source]¶ Hilbert space obtained as tensor product of local spin states.
- Parameters
Examples
Simple spin hilbert space.
>>> from netket.hilbert import Spin >>> g = Hypercube(length=10,n_dim=2,pbc=True) >>> hi = Spin(s=0.5, N=4) >>> print(hi.size) 4
- Attributes
-
-
local_states
¶ A list of discreet 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.
- Type
-
- Methods
-
all_states
(out=None)¶ Returns all valid states of the Hilbert space.
Throws an exception if the space is not indexable.
-
numbers_to_states
(numbers, out=None)¶ 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.
-
ptrace
(sites)[source]¶ Returns the hilbert space without the selected sites.
Not all hilbert spaces support this operation.
-
random_state
(key=<netket.hilbert.abstract_hilbert.NoneType object>, size=<netket.hilbert.abstract_hilbert.NoneType object>, dtype=<class 'numpy.float32'>, out=None, rgen=None)¶ 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.
out (
Optional
[ndarray
]) – Deprecated. Will be removed in v3.1rgen – Deprecated. Will be removed in v3.1
- Return type
ndarray
- Returns
A state or batch of states sampled from the uniform distribution on the hilbert space.
Example
>>> hi = netket.hilbert.Qubit(N=2) >>> hi.random_state(jax.random.PRNGKey(0)) array([0., 1.]) >>> hi.random_state(size=2) array([[0., 0.], [1., 0.]])
-
size_at_index
(i)¶ Size of the local degrees of freedom at the site i.
- Parameters
i – The index of the desired site
- 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 prefered.
-
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 – The index of the desired site.
- Returns
A list of values or None if there are infintely many.
-
states_to_numbers
(states, out=None)¶ 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.
-
-