API reference
=============

This section is generated from the package source with Sphinx autodoc and
autosummary.

Top-level exports
-----------------

.. autosummary::
   :toctree: generated
   :nosignatures:

   nkdsl.SymbolicDiscreteJaxOperator
   nkdsl.Update
   nkdsl.ExpressionContext
   nkdsl.SiteSelector
   nkdsl.site
   nkdsl.emitted
   nkdsl.symbol
   nkdsl.source_index
   nkdsl.target_index
   nkdsl.shift
   nkdsl.shift_mod
   nkdsl.write
   nkdsl.swap
   nkdsl.permute
   nkdsl.affine
   nkdsl.scatter
   nkdsl.identity
   nkdsl.SymbolicOperator
   nkdsl.CompiledOperator
   nkdsl.SymbolicOperatorSum
   nkdsl.SymbolicCompiler
   nkdsl.SymbolicCompilerOptions
   nkdsl.SymbolicCompilationContext
   nkdsl.SymbolicCompiledArtifact
   nkdsl.SymbolicCompilationSignature
   nkdsl.SymbolicCacheKey
   nkdsl.SymbolicOperatorIR
   nkdsl.SymbolicIRTerm
   nkdsl.KBodyIteratorSpec
   nkdsl.EmissionSpec
   nkdsl.UpdateProgram
   nkdsl.UpdateOp
   nkdsl.AmplitudeExpr
   nkdsl.PredicateExpr
   nkdsl.cfg

Modules
-------

.. autosummary::
   :toctree: generated
   :nosignatures:

   nkdsl
   nkdsl.dsl
   nkdsl.dsl.context
   nkdsl.dsl.operator
   nkdsl.dsl.rewrite
   nkdsl.dsl.selectors
   nkdsl.core
   nkdsl.core.base
   nkdsl.core.operator
   nkdsl.core.compiled
   nkdsl.core.sum
   nkdsl.compiler
   nkdsl.compiler.compiler
   nkdsl.compiler.defaults
   nkdsl.compiler.cache.store
   nkdsl.compiler.core.artifact
   nkdsl.compiler.core.context
   nkdsl.compiler.core.options
   nkdsl.compiler.core.pipeline
   nkdsl.compiler.core.pass_report
   nkdsl.compiler.core.signature
   nkdsl.compiler.diagnostics
   nkdsl.compiler.diagnostics.collector
   nkdsl.compiler.diagnostics.formatting
   nkdsl.compiler.diagnostics.models
   nkdsl.compiler.diagnostics.state_sampling
   nkdsl.compiler.diagnostics.traversals
   nkdsl.compiler.diagnostics.rules
   nkdsl.compiler.diagnostics.rules.base
   nkdsl.compiler.diagnostics.rules.connectivity_rules
   nkdsl.compiler.diagnostics.rules.structural_rules
   nkdsl.compiler.diagnostics.rules.symbol_rules
   nkdsl.compiler.lowering.base
   nkdsl.compiler.lowering.registry
   nkdsl.compiler.lowering.jax_lowerer
   nkdsl.compiler.passes.base
   nkdsl.compiler.passes.diagnostics
   nkdsl.compiler.passes.validation
   nkdsl.compiler.passes.normalization
   nkdsl.compiler.passes.analysis
   nkdsl.compiler.passes.fusion
   nkdsl.ir
   nkdsl.ir.expressions
   nkdsl.ir.predicates
   nkdsl.ir.update
   nkdsl.ir.term
   nkdsl.ir.program
   nkdsl.ir.validate
   nkdsl.errors
   nkdsl.errors.exceptions
   nkdsl.configs