Skip to content
Symi Docs
WASM / JavaScript

Signatures in the WASM / JavaScript view are TypeScript. Where the JavaScript facade wraps an operation its form is listed first; the other calling forms are the raw wasm-bindgen exports.

On this page

Relations and predicates

Relations construct symbolic formulas. They are distinct from host-language truth queries.

Relations#

Relation nodes are used as equations for solve/solveset, as piecewise conditions, and as boolean-valued results.

Each relation is also a method of the left operand: x.less_than(1) builds the same node as context.less_than(x, 1). In Python, <, <=, >, and >= build the strict and non-strict order relations, so x < 1 is the relation x < 1. == and != are deliberately not relation builders: they compare two expressions structurally, which keeps expressions usable as dictionary keys and set members; build an equation value with equation. A relation has no Python truth value — its truth is three-valued, so bool(x < 1) raises, and so does a chained comparison such as 0 < x < 1. Ask for the verdict with evaluate_truth.

equal#

Raw WebAssembly: Default context

equal(left: Expression, right: Expression): Expression
Calling forms

Raw WebAssembly: Explicit context: Context.equal

equal(left: Expression, right: Expression): Expression

equation#

Raw WebAssembly: Default context

equation(left: Expression, right: Expression): Expression
Calling forms

Raw WebAssembly: Explicit context: Context.equation

equation(left: Expression, right: Expression): Expression

Constructs an equation value without evaluating it as a Boolean relation. Its two sides remain available for sidewise arithmetic and exact source-preserving solving.

transform_equation#

Raw WebAssembly: Default context

transformEquation(
    left: Expression,
    right: Expression,
    operation: string,
): EquationTransformation
Calling forms

Raw WebAssembly: Explicit context: Context.transformEquation

transformEquation(
    left: Expression,
    right: Expression,
    operation: string,
): EquationTransformation

Applies operation — "add", "subtract", "multiply", or "divide" — to an equation and a scalar, or adds or subtracts two equations, threading the operation over both sides. At least one operand must be an equation; two equations cannot be multiplied or divided, an equation cannot be a divisor, and a truth value beside an equation is refused.

The result says how the new equation relates to the old one, because not every side-wise operation preserves solutions. Adding or subtracting a scalar, multiplying by a factor proved nonzero, and dividing are equivalences: the new equation holds exactly where the old one does. Multiplying by a factor not proved nonzero, and combining two equations, give only a consequence: every solution of the input solves the result, but x(x−1)=0x(x - 1) = 0 also holds at x=0x = 0, where x−1=0x - 1 = 0 does not.

The relation is claimed under a condition on the free symbols. It records where a scalar operand is defined, because automatic simplification can cancel a pole out of the result — multiplying x=0x = 0 by 1/x1/x builds 1=01 = 0, and only the condition x≠0x \ne 0 still shows the lost point — and, for a divisor not proved nonzero, that the divisor is nonzero: dividing x2=xx^2 = x by xx gives x=1x = 1 under x≠0x \ne 0. A condition of true admits every point; false means the operand's domain could not be described and no claim is made.

The arithmetic operators and the add, subtract, multiply, and divide operations thread over equations the same way but return only the equation, so they refuse a multiplication or division that would need a guard to stay honest.

EquationTransformation#

Not exposed by the WASM / JavaScript bindings. Available as EquationTransformation in Python, api::EquationTransformation in Rust.

What transform_equation returns:

Member Meaning
equation The transformed equation
relation equivalence or consequence
condition The Boolean condition under which the relation is claimed

transformation_equation#

Raw WebAssembly: EquationTransformation property

readonly equation: Expression

Getter on EquationTransformation: the transformed equation.

transformation_relation#

Raw WebAssembly: EquationTransformation property

readonly relation: string

Getter on EquationTransformation: whether the transformed equation is equivalent to its input or only implied by it.

transformation_condition#

Raw WebAssembly: EquationTransformation property

readonly condition: Expression

Getter on EquationTransformation: the Boolean condition on the free symbols under which the relation is claimed.

not_equal#

Raw WebAssembly: Default context

notEqual(left: Expression, right: Expression): Expression
Calling forms

Raw WebAssembly: Explicit context: Context.notEqual

notEqual(left: Expression, right: Expression): Expression

less_than#

Raw WebAssembly: Default context

lessThan(left: Expression, right: Expression): Expression
Calling forms

Explicit context: Context.lessThan

lessThan(left: ExpressionLike, right: ExpressionLike): Expression

Raw WebAssembly: Explicit context: Context.lessThan

lessThan(left: Expression, right: Expression): Expression

SymiFacade method: SymiFacade.lessThan

lessThan(left: ExpressionLike, right: ExpressionLike): Expression

Expression method: Expression.lessThan

lessThan(other: ExpressionLike): Expression

less_than_or_equal#

Raw WebAssembly: Default context

lessThanOrEqual(left: Expression, right: Expression): Expression
Calling forms

Raw WebAssembly: Explicit context: Context.lessThanOrEqual

lessThanOrEqual(left: Expression, right: Expression): Expression

greater_than#

Raw WebAssembly: Default context

greaterThan(left: Expression, right: Expression): Expression
Calling forms

Raw WebAssembly: Explicit context: Context.greaterThan

greaterThan(left: Expression, right: Expression): Expression

greater_than_or_equal#

Raw WebAssembly: Default context

greaterThanOrEqual(left: Expression, right: Expression): Expression
Calling forms

Raw WebAssembly: Explicit context: Context.greaterThanOrEqual

greaterThanOrEqual(left: Expression, right: Expression): Expression

Example#

Relations are symbolic expressions until they are evaluated.

JavaScript
const x = symi.symbol("x");

console.log(symi.lessThan(x, 1).toString());
console.log(symi.evaluateTruth(symi.lessThan(symi.integer(1n), 2)));

Symi documentation · WASM / JavaScript