Skip to main content
Ctrl+K
NetKet
  • Posts
  • Papers
  • Get Involved
  • Citing
  • Documentation
NetKet - Home

Getting started

  • Installation
  • First Tutorial
  • Distributed computing (multi-node/HPC)

User guides

  • Architecture & Philosophy
  • Tutorials
    • Ground-State: Ising model
    • Ground-State: Bosons in a 3D Harmonic trap
    • Ground-State: Heisenberg model
    • Ground-State: J1-J2 model
    • Vision Transformer wave function
    • Ground-State: Bosonic Matrix Model
    • Symmetries: Honeycomb Heisenberg model
    • Lattice Fermions, from Slater Determinants to Neural Backflow Transformations
  • In-depth guides
    • The Hilbert module
    • The Operator module
    • The Sampler module
    • NetKet Pytrees
    • The Variational State Interface
    • The Drivers API
    • Quantum Geometric Tensor and Stochastic Reconfiguration
    • The Lindblad Master Equation
  • Advanced guides
    • Defining Custom Models
    • Overriding defaults in NetKet
    • Defining Custom Preconditioners
    • Defining Custom Observables and Operators
    • Custom Hilbert Space Constraints
  • VMC DIY
    • Part 1: Hamiltonians and Operators
    • Part 2: Variational States with Full Summation
    • Part 3: Monte Carlo Sampling
  • Developer guides
    • Contributing to NetKet
    • Documentation
    • Writing Tests
  • Configuration Options
  • 🔪 The Sharp Bits 🔪

API documentation

  • API Stability
  • Public API
    • netket.callbacks
      • netket.callbacks.EarlyStopping
      • netket.callbacks.ConvergenceStopping
      • netket.callbacks.InvalidLossStopping
      • netket.callbacks.Timeout
    • netket.drivers
      • netket.driver.AbstractVariationalDriver
      • netket.driver.VMC
      • netket.driver.SteadyState
    • netket.errors
      • netket.errors.HilbertIndexingDuringTracingError
      • netket.errors.HolomorphicUndeclaredWarning
      • netket.errors.JaxOperatorSetupDuringTracingError
      • netket.errors.JaxOperatorNotConvertibleToNumba
      • netket.errors.NonHolomorphicQGTOnTheFlyDenseRepresentationError
      • netket.errors.NumbaOperatorGetConnDuringTracingError
      • netket.errors.RealQGTComplexDomainError
      • netket.errors.UnoptimalSRtWarning
      • netket.errors.SymmModuleInvalidInputShape
      • netket.errors.ParameterMismatchError
      • netket.errors.InitializePeriodicLatticeOnSmallLatticeWarning
      • netket.errors.UnoptimisedCustomConstraintRandomStateMethodWarning
      • netket.errors.UnhashableConstraintError
      • netket.errors.InvalidConstraintInterface
      • netket.errors.NetKetPyTreeUndeclaredAttributeAssignmentError
    • netket.exact
      • netket.exact.full_ed
      • netket.exact.lanczos_ed
      • netket.exact.steady_state
    • netket.graph
      • netket.graph.AbstractGraph
      • netket.graph.Graph
      • netket.graph.Lattice
      • netket.graph.Edgeless
      • netket.graph.lattice.LatticeSite
      • netket.graph.Grid
      • netket.graph.Hypercube
      • netket.graph.Square
      • netket.graph.Cube
      • netket.graph.Chain
      • netket.graph.Triangular
      • netket.graph.Honeycomb
      • netket.graph.KitaevHoneycomb
      • netket.graph.Kagome
      • netket.graph.BCC
      • netket.graph.FCC
      • netket.graph.Diamond
      • netket.graph.Pyrochlore
      • netket.graph.space_group.SpaceGroup
      • netket.graph.space_group.TranslationGroup
      • netket.graph.DoubledGraph
      • netket.graph.disjoint_union
    • netket.experimental.geometry
      • netket.experimental.geometry.Cell
      • netket.experimental.geometry.FreeSpace
    • netket.hilbert
      • netket.hilbert.TensorHilbert
      • netket.hilbert.DoubledHilbert
      • netket.hilbert.Spin
      • netket.hilbert.Qubit
      • netket.hilbert.Fock
      • netket.hilbert.SpinOrbitalFermions
      • netket.hilbert.AbstractHilbert
      • netket.hilbert.DiscreteHilbert
      • netket.hilbert.HomogeneousHilbert
      • netket.experimental.hilbert.ContinuousHilbert
      • netket.experimental.hilbert.Particle
      • netket.hilbert.constraint.DiscreteHilbertConstraint
      • netket.hilbert.constraint.SumConstraint
      • netket.hilbert.constraint.SumOnPartitionConstraint
      • netket.hilbert.constraint.ExtraConstraint
      • netket.hilbert.random.flip_state
      • netket.hilbert.random.random_state
      • netket.hilbert.index.optimalConstrainedHilbertindex
    • netket.jax
      • netket.jax.HashablePartial
      • netket.jax.PRNGKey
      • netket.jax.PRNGSeq
      • netket.jax.tree_dot
      • netket.jax.tree_norm
      • netket.jax.tree_ax
      • netket.jax.tree_axpy
      • netket.jax.tree_cast
      • netket.jax.tree_conj
      • netket.jax.tree_size
      • netket.jax.tree_leaf_iscomplex
      • netket.jax.tree_ishomogeneous
      • netket.jax.tree_ravel
      • netket.jax.tree_to_real
      • netket.jax.dtype_complex
      • netket.jax.is_complex_dtype
      • netket.jax.maybe_promote_to_complex
      • netket.jax.expect
      • netket.jax.vjp
      • netket.jax.jacobian
      • netket.jax.jacobian_default_mode
      • netket.jax.chunk
      • netket.jax.unchunk
      • netket.jax.apply_chunked
      • netket.jax.vmap_chunked
      • netket.jax.vjp_chunked
      • netket.jax.logsumexp_cplx
      • netket.jax.logdet_cmplx
    • netket.logging
      • netket.logging.AbstractLog
      • netket.logging.RuntimeLog
      • netket.logging.JsonLog
      • netket.logging.StateLog
      • netket.logging.TensorBoardLog
    • netket.models
      • netket.models.LogStateVector
      • netket.models.RBM
      • netket.models.RBMModPhase
      • netket.models.RBMMultiVal
      • netket.models.RBMSymm
      • netket.models.Jastrow
      • netket.models.NDM
      • netket.models.GCNN
      • netket.models.DeepSetMLP
      • netket.models.MLP
      • netket.models.AbstractARNN
      • netket.models.ARNNSequential
      • netket.models.FastARNNSequential
      • netket.models.ARNNDense
      • netket.models.ARNNConv1D
      • netket.models.ARNNConv2D
      • netket.models.FastARNNConv1D
      • netket.models.FastARNNConv2D
      • netket.models.Gaussian
      • netket.models.DeepSetRelDistance
      • netket.models.tensor_networks.MPSOpen
      • netket.models.tensor_networks.MPSPeriodic
      • netket.models.tensor_networks.MPDOOpen
      • netket.models.tensor_networks.MPDOPeriodic
      • netket.experimental.models.Slater2nd
      • netket.experimental.models.MultiSlater2nd
      • netket.experimental.models.RNN
      • netket.experimental.models.FastRNN
      • netket.experimental.models.LSTMNet
      • netket.experimental.models.FastLSTMNet
      • netket.experimental.models.GRUNet1D
      • netket.experimental.models.FastGRUNet1D
    • netket.nn
      • netket.nn.DenseSymm
      • netket.nn.DenseEquivariant
      • netket.nn.MaskedDense1D
      • netket.nn.MaskedConv1D
      • netket.nn.MaskedConv2D
      • netket.nn.FastMaskedDense1D
      • netket.nn.FastMaskedConv1D
      • netket.nn.FastMaskedConv2D
      • netket.nn.activation.reim
      • netket.nn.activation.reim_relu
      • netket.nn.activation.reim_selu
      • netket.nn.activation.log_cosh
      • netket.nn.activation.log_sinh
      • netket.nn.activation.log_tanh
      • netket.nn.binary_encoding
      • netket.nn.to_array
      • netket.nn.to_matrix
      • netket.nn.blocks.MLP
      • netket.nn.blocks.DeepSetMLP
      • netket.nn.blocks.SymmExpSum
      • netket.experimental.nn.rnn.RNNLayer
      • netket.experimental.nn.rnn.FastRNNLayer
      • netket.experimental.nn.rnn.RNNCell
      • netket.experimental.nn.rnn.LSTMCell
      • netket.experimental.nn.rnn.GRU1DCell
      • netket.experimental.nn.rnn.check_reorder_idx
      • netket.experimental.nn.rnn.ensure_prev_neighbors
      • netket.experimental.nn.rnn.get_snake_inv_reorder_idx
    • netket.operator
      • netket.operator.AbstractOperator
      • netket.operator.AbstractSuperOperator
      • netket.operator.DiscreteOperator
      • netket.operator.DiscreteJaxOperator
      • netket.operator.ContinuousOperator
      • netket.operator.BoseHubbard
      • netket.operator.BoseHubbardNumba
      • netket.operator.GraphOperator
      • netket.operator.LocalOperator
      • netket.operator.LocalOperatorNumba
      • netket.operator.Ising
      • netket.operator.IsingNumba
      • netket.operator.Heisenberg
      • netket.operator.PauliStrings
      • netket.operator.PauliStringsNumba
      • netket.operator.LocalLiouvillian
      • netket.operator.FermionOperator2nd
      • netket.operator.FermionOperator2ndNumba
      • netket.operator.fermion.create
      • netket.operator.fermion.destroy
      • netket.operator.fermion.number
      • netket.experimental.operator.ParticleNumberConservingFermioperator2nd
      • netket.experimental.operator.ParticleNumberAndSpinConservingFermioperator2nd
      • netket.experimental.operator.FermiHubbardJax
      • netket.operator.KineticEnergy
      • netket.operator.PotentialEnergy
      • netket.operator.SumOperator
      • netket.operator.boson.create
      • netket.operator.boson.destroy
      • netket.operator.boson.identity
      • netket.operator.boson.number
      • netket.operator.boson.proj
      • netket.operator.spin.identity
      • netket.operator.spin.sigmax
      • netket.operator.spin.sigmay
      • netket.operator.spin.sigmaz
      • netket.operator.spin.sigmap
      • netket.operator.spin.sigmam
    • netket.optimizer
      • netket.optimizer.Adam
      • netket.optimizer.AdaGrad
      • netket.optimizer.Sgd
      • netket.optimizer.Momentum
      • netket.optimizer.RmsProp
      • netket.optimizer.SR
      • netket.optimizer.qgt.QGTAuto
      • netket.optimizer.qgt.QGTOnTheFly
      • netket.optimizer.qgt.QGTJacobianPyTree
      • netket.optimizer.qgt.QGTJacobianDense
      • netket.optimizer.solver.cholesky
      • netket.optimizer.solver.LU
      • netket.optimizer.solver.pinv
      • netket.optimizer.solver.pinv_smooth
      • netket.optimizer.solver.solve
      • netket.optimizer.solver.svd
    • netket.sampler
      • netket.sampler.Sampler
      • netket.sampler.SamplerState
      • netket.sampler.MetropolisSamplerState
      • netket.sampler.ExactSampler
      • netket.sampler.MetropolisSampler
      • netket.sampler.MetropolisSamplerNumpy
      • netket.sampler.ParallelTemperingSampler
      • netket.sampler.ARDirectSampler
      • netket.sampler.MetropolisLocal
      • netket.sampler.MetropolisExchange
      • netket.sampler.MetropolisHamiltonian
      • netket.sampler.MetropolisGaussian
      • netket.sampler.MetropolisAdjustedLangevin
      • netket.sampler.ParallelTemperingLocal
      • netket.sampler.ParallelTemperingExchange
      • netket.sampler.ParallelTemperingHamiltonian
      • netket.sampler.MetropolisFermionHop
      • netket.sampler.rules.MetropolisRule
      • netket.sampler.rules.LocalRule
      • netket.sampler.rules.CustomRuleNumpy
      • netket.sampler.rules.ExchangeRule
      • netket.sampler.rules.FixedRule
      • netket.sampler.rules.HamiltonianRule
      • netket.sampler.rules.HamiltonianRuleNumpy
      • netket.sampler.rules.GaussianRule
      • netket.sampler.rules.LangevinRule
      • netket.sampler.rules.FermionHopRule
      • netket.sampler.rules.TensorRule
      • netket.sampler.rules.MultipleRules
      • netket.sampler.SamplerState
      • netket.sampler.MetropolisSamplerState
      • netket.sampler.MetropolisFermionHop
      • netket.sampler.rules.FermionHopRule
    • netket.stats
      • netket.stats.statistics
    • netket.utils
      • netket.utils.is_probably_holomorphic
      • netket.utils.struct.Pytree
      • netket.utils.struct.field
      • netket.utils.struct.ShardedFieldSpec
      • netket.utils.HashableArray
      • netket.utils.StaticRange
      • netket.utils.numbers.StaticZero
      • netket.utils.group.Permutation
      • netket.utils.group.PermutationGroup
      • netket.utils.group.FiniteGroup
      • netket.utils.group.PointGroup
      • netket.utils.timing.Timer
      • netket.utils.timing.timed_scope
      • netket.utils.timing.timed
    • netket.vqs
      • netket.vqs.VariationalState
      • netket.vqs.VariationalMixedState
      • netket.vqs.FullSumState
      • netket.vqs.MCState
      • netket.vqs.MCMixedState
      • netket.vqs.get_local_kernel
      • netket.vqs.get_local_kernel_arguments
    • netket.driver.VMC
    • netket.driver.SteadyState
  • Experimental API
    • netket.experimental.driver.VMC_SR
    • netket.experimental.QSR
    • netket.experimental.operator.ParticleNumberConservingFermioperator2nd
    • netket.experimental.operator.ParticleNumberAndSpinConservingFermioperator2nd
    • netket.experimental.operator.FermiHubbardJax
    • netket.experimental.operator.from_pyscf_molecule
    • netket.experimental.operator.pyscf.TV_from_pyscf_molecule
    • netket.experimental.logging.HDF5Log
    • netket.experimental.vqs.variables_from_file
    • netket.experimental.vqs.variables_from_tar
    • netket.experimental.TDVP
    • netket.experimental.driver.TDVPSchmitt
    • netket.experimental.dynamics.Euler
    • netket.experimental.dynamics.Heun
    • netket.experimental.dynamics.Midpoint
    • netket.experimental.dynamics.RK12
    • netket.experimental.dynamics.RK23
    • netket.experimental.dynamics.RK4
    • netket.experimental.dynamics.RK45
    • netket.experimental.dynamics.AbstractSolver
    • netket.experimental.dynamics.AbstractSolverState
    • netket.experimental.observable.Renyi2EntanglementEntropy
    • netket.experimental.observable.VarianceObservable
  • Change Log
  • Public API
  • netket.experimental.geometry
  • netket.exper...
  • Repository
  • Open issue
  • .rst

netket.experimental.geometry.Cell

Contents

  • Cell
    • Cell.dimension
    • Cell.extent
    • Cell.pbc
    • Cell.distance()
    • Cell.tree_flatten()
    • Cell.tree_unflatten()

netket.experimental.geometry.Cell#

class netket.experimental.geometry.Cell[source]#

Bases: object

A finite region in continuous space.

Inheritance
Inheritance diagram of netket.experimental.geometry.Cell
Attributes
dimension#
extent: tuple[float, ...]#
pbc: tuple[bool, ...]#
Methods
distance(r1, r2)[source]#

Euclidean distance between r1 and r2 considering boundary conditions.

Return type:

Array

Parameters:
  • r1 (Sequence[float] | Array)

  • r2 (Sequence[float] | Array)

tree_flatten()[source]#
classmethod tree_unflatten(aux, data)[source]#

previous

netket.experimental.geometry

next

netket.experimental.geometry.FreeSpace

Contents
  • Cell
    • Cell.dimension
    • Cell.extent
    • Cell.pbc
    • Cell.distance()
    • Cell.tree_flatten()
    • Cell.tree_unflatten()

By Author name not set

© Copyright 2019-2024, The Netket authors - All rights reserved.