nkdsl.dsl

User-facing declarative symbolic operator DSL.

Functions

affine(site_ref, *, scale[, bias])	Returns an Update computing x'[i] = scale * x[i] + bias.
available_emission_clause_names()	Lists emission clause names currently registered.
available_iterator_clause_names()	Lists iterator clause names currently registered.
available_predicate_clause_names()	Lists predicate clause names currently registered.
emitted(label)	Returns a symbolic selector bound to the emitted/connected state x'.
hop(src, dst, *[, amount])	Returns an Update transferring occupation from src to dst.
identity()	Returns the identity (no-op) Update.
permute(*site_refs)	Returns an Update performing a cyclic rotation over K sites.
register(-> type[~typing.Any])	Registers either an iterator clause, predicate clause or an emission clause class.
register_emission_clause(-> type[])	Registers one emission clause class.
register_iterator_clause(-> type[])	Registers one iterator clause class.
register_predicate_clause(-> type[])	Registers one predicate clause class.
scatter(flat_indices, values)	Returns an Update performing bulk writes to static flat indices.
shift(site_ref, delta)	Returns an Update that shifts site site_ref by delta.
shift_mod(site_ref, delta)	Returns an Update performing a Hilbert-aware wrapped modular shift.
site(label)	Returns a symbolic site selector.
source_index(flat_index)	Returns a static source-configuration read x[flat_index].
swap(site_a, site_b)	Returns an Update that swaps sites site_a and site_b.
symbol(name, *[, default, doc, dtype])	Returns a free symbolic amplitude expression by name.
target_index(flat_index)	Returns a static emitted/target-configuration read x'[flat_index].
write(site_ref, value)	Returns an Update that writes value to site site_ref.

Classes

AbstractEmissionClause(builder)	Abstract base class for custom fluent emission clauses.
AbstractIteratorClause(builder)	Abstract base class for custom fluent iterator clauses.
AbstractPredicateClause(builder)	Abstract base class for custom fluent predicate clauses.
EmissionClauseSpec([mode, predicate, ...])	One normalized emission-clause action.
ExpressionContext()	Utility context passed to DSL callables at build time.
SiteSelector(label[, namespace])	Symbolic selector for one Hilbert-space site iterator.
SymbolicDiscreteJaxOperator(hilbert[, name, ...])	Fluent builder for declarative symbolic quantum operators.
Update([_program])	Immutable, chainable site-update program builder.