Skip to content
Symi Docs
Kotlin
On this page

The default context and module-level functions

Every operation in Symi runs against a context — the symbol table, the assumption records, and the hash-consed expression store. You can manage contexts explicitly (see Construction and parsing), but for everyday use the bindings provide a default context: a context created automatically per thread (per module instance in WASM), shared by a set of module-level functions that mirror the Context class methods one-for-one.

Rules of the model:

  • One default context per thread. The Rust core is thread-safe and its public types are Send + Sync, but a default context is a convenience for a caller who did not make one, so each thread gets its own rather than sharing one implicitly. The Python classes are unsendable and WebAssembly is single-threaded today, so in those hosts objects never cross threads anyway. Objects made by module functions and by default_context() interoperate freely; objects from an explicit context() must not be mixed in (as ever, contexts do not mix).
  • Assumptions are per-name and session-wide. symbol("x", positive=True) refines what x means everywhere in the default context, retroactively. Refinement is monotonic: strengthening an unknown property is allowed, contradicting an earlier declaration raises an error. clear_assumptions is the escape hatch; a fresh context() gives full isolation.
  • Memory is bounded by live objects. The expression store holds weak references: expressions you no longer hold are reclaimed automatically, so there is no module-level reset_context and long sessions do not leak. interner_length reports the live count.
  • Structural constructors use the default context. matrix, point_2d, segment_2d, polygon_2d, triangle_2d, and circle_2d are both exported classes and default-context constructors: call Matrix([[x, y]]) in Python or symi.matrix([[x, y]]) through the JavaScript facade. Their methods on an explicit Context() remain available for isolated construction. undefined_function is a module-level factory in Python and on the raw WASM module (undefinedFunction); it has no class constructor. reset_context is likewise context-only: resetting the shared default context would strand every live object, and the weak store removes the memory reason to do it.
  • Python import * shadows builtins. The module exports abs, min, and max; use import symi as sc in code that also needs the Python builtins.

Functions#

default_context#

Not exposed by the Kotlin bindings. Available as module.default_context in Python, api::defaults::Session::default_context in Rust.

Return a handle to the thread's default context — the same context every module-level function and direct structural-class constructor uses. Pass it to code written against the explicit-context API. Each call returns a new handle to the same underlying context.

clear_assumptions#

Explicit context

fun clearAssumptions(variable: kotlin.String): Unit

Reset one symbol's assumptions to the default (complex domain, every property unknown). This is the only sanctioned widening operation: it is explicit and per-symbol, and the symbol's identity is untouched, so existing expressions remain structurally valid. Use it when a monotonic-refinement conflict blocks a re-declaration you actually intend.

assumptions_of#

Explicit context

fun assumptionsOf(variable: kotlin.String): List<UniffiAssumptionProposition>

Return the symbol's current assumptions as a native Python mapping or JavaScript record with domain, positive, negative, nonzero, and finite fields. The variable may be a name or same-context symbol. The domain is one of complex, real, rational, integer, natural, or positive_integer; truth-valued fields are yes, no, or unknown.

interner_length#

Explicit context

fun internerLength(): kotlin.ULong

Number of live expressions currently interned in the context. Dead entries awaiting the amortized sweep are not counted. Useful for observing memory in long-running sessions and in tests that assert the store stays bounded.

Example#

Symi documentation · Kotlin