Skip to content
Symi Docs
Swift
On this page

Integer number theory

All functions take and return Expression objects holding integer leaves, so arbitrary precision flows through the existing machinery; passing a non-integer expression raises. (Exception: continued_fraction_rational also accepts rational leaves; the three symbol functions return plain machine integers.)

is_prime#

Explicit context

func isPrime(argument: UniffiExpression) -> Bool?
Calling forms

Expression method: UniffiExpression.isPrime

func isPrime() -> UniffiTruthValue

Deterministic primality verdict; None when the input is outside the classifier's domain (e.g. not a natural number ≥0\geq 0 representation it handles).

factor_integer#

Explicit context

func factorInteger(argument: UniffiExpression) -> [UniffiExpressionUnsignedIntegerTuple]

Prime factorization as (prime, multiplicity) pairs, ascending. Errors on zero. Notes: WASM returns PrimeFactor objects with prime/multiplicity getters; the sign −1-1 of a negative input is carried as a leading (-1, 1) factor exactly as the core reports it.

prime_factor (WASM result class)#

prime#

Not exposed by the Swift bindings. Available as api::Session::prime in Rust.

multiplicity#

UniffiRootMultiplicity method

func multiplicity() -> UInt64

integer_gcd#

Explicit context

func integerGcd(
    left: UniffiExpression,
    right: UniffiExpression,
) -> UniffiExpression

Greatest common divisor (non-negative).

integer_lcm#

Explicit context

func integerLcm(
    left: UniffiExpression,
    right: UniffiExpression,
) -> UniffiExpression

Least common multiple.

extended_euclidean#

Explicit context

func extendedEuclidean(
    left: UniffiExpression,
    right: UniffiExpression,
) -> UniffiExpressionExpressionExpressionTuple

(gcd, x, y) with ax+by=gcd⁡a x + b y = \operatorname{gcd}. Notes: WASM returns a 3-element array [gcd, x, y].

modular_power#

Explicit context

func modularPower(
    base: UniffiExpression,
    exponent: UniffiExpression,
    modulus: UniffiExpression,
) -> UniffiExpression

base^exponent mod modulus by square-and-multiply; requires positive modulus and non-negative exponent.

modular_inverse#

Explicit context

func modularInverse(
    value: UniffiExpression,
    modulus: UniffiExpression,
) -> UniffiExpression

Multiplicative inverse of value modulo modulus; errors when gcd⁡(value⁡,modulus⁡)≠1\operatorname{gcd}(\operatorname{value}, \operatorname{modulus}) \ne 1.

chinese_remainder#

Explicit context

func chineseRemainder(residuesAndModuli: [UniffiExpressionExpressionTuple]) -> UniffiExpression

The smallest non-negative solution of the simultaneous congruences x≡ri(modmi)x \equiv r_i \pmod{m_i}. Moduli need not be pairwise coprime; inconsistent systems raise. Notes: WASM passes a flat interleaved array [residue_0, modulus_0, ...].

euler_totient#

Explicit context

func eulerTotient(value: UniffiExpression) -> UniffiExpression

Euler's φ(n)\varphi(n); requires a positive integer.

mobius#

Explicit context

func mobius(argument: UniffiExpression) -> UniffiExpression

Möbius μ(n)∈{−1,0,1}\mu(n) \in \{-1, 0, 1\}; requires a positive integer.

divisor_count#

Explicit context

func divisorCount(argument: UniffiExpression) -> UniffiExpression

Number of positive divisors τ(n)\tau(n).

divisor_sigma#

Explicit context

func divisorSigma(
    argument: UniffiExpression,
    power: UInt64,
) -> UniffiExpression

Sum of the power-th powers of the positive divisors σpower(n)\sigma_{\mathit{power}}(n); power = 0 gives divisor_count, power = 1 the divisor sum.

jacobi_symbol#

Explicit context

func jacobiSymbol(
    numerator: UniffiExpression,
    denominator: UniffiExpression,
) -> Int64

The Jacobi symbol (n/d)∈{−1,0,1}(n/d) \in \{-1, 0, 1\}; the denominator must be a positive odd integer.

legendre_symbol#

Explicit context

func legendreSymbol(
    numerator: UniffiExpression,
    prime: UniffiExpression,
) -> Int64

The Legendre symbol; the second argument must be an odd prime.

kronecker_symbol#

Explicit context

func kroneckerSymbol(
    numerator: UniffiExpression,
    denominator: UniffiExpression,
) -> Int64

The Kronecker extension of the Jacobi symbol to all integer denominators.

integer_square_root#

Explicit context

func integerSquareRoot(argument: UniffiExpression) -> UniffiExpression

⌊n⌋\lfloor\sqrt{n}\rfloor for non-negative n.

integer_nth_root#

Explicit context

func integerNthRoot(
    argument: UniffiExpression,
    rootIndex: UInt64,
) -> UniffiExpression

⌊n1/root_index⌋\lfloor n^{1/\mathit{root\_index}}\rfloor; odd indices accept negative n. Errors when no real root exists (even index, negative n).

continued_fraction_rational#

Explicit context

func continuedFractionRational(value: UniffiExpression) -> [UniffiExpression]

Terminating continued-fraction expansion [a0; a1, a2, ...] of an integer or rational expression leaf.

continued_fraction_quadratic_irrational#

Explicit context

func continuedFractionQuadraticIrrational(value: UniffiExpression) -> UniffiQuadraticContinuedFractionExpansion

Eventually-periodic expansion of d\sqrt{d} for a non-negative integer d, returned as (initial_terms, periodic_part). Perfect squares give a one-element initial part and an empty period. Notes: WASM returns a QuadraticContinuedFractionExpansion object with initial_terms/periodic_terms getters.

quadratic_continued_fraction_expansion (WASM result class)#

initial_terms#

UniffiQuadraticContinuedFractionExpansion method

func initialTerms() -> [UniffiExpression]

The terms preceding the periodic part of the expansion.

periodic_terms#

UniffiQuadraticContinuedFractionExpansion method

func periodicTerms() -> [UniffiExpression]

The repeating terms of the expansion.

Diophantine equations#

The two supported Diophantine subclasses are linear equations via the extended Euclidean algorithm and Pell's equation via the continued fraction of D\sqrt{D}. General Diophantine solving is undecidable (Matiyasevich–Robinson–Davis–Putnam) and is out of scope; the solvers return exact integers and never guess.

solve_linear_diophantine#

Explicit context

func solveLinearDiophantine(
    coefficients: [UniffiExpression],
    constant: UniffiExpression,
) -> [UniffiExpression]

General integer solution of a1x1+…+anxn=ca_1 x_1 + \ldots + a_n x_n = c, returned as the parametric coordinates — one expression per unknown, affine in fresh integer parameter symbols (diophantine_parameter_k) shared across the coordinates so that choosing any integers for the parameters yields a solution tuple. The list is empty only when the equation provably has no integer solution (gcd⁡(ai)∤c\gcd(a_i) \nmid c). When every coefficient and the constant are zero, each coordinate is its own fresh integer parameter. All coefficients and the constant must be integer expression leaves; any other input, including an empty coefficient list, raises a declined-computation error instead of returning an empty list.

solve_linear_diophantine_system#

Explicit context

func solveLinearDiophantineSystem(
    coefficientMatrix: UniffiMatrix,
    constants: [UniffiExpression],
) -> [UniffiExpression]

General integer solution of the rectangular system Ax=bA x = b, returned as one parametric coordinate expression per column of A. The coordinates share fresh integer parameter symbols and describe the complete affine integer lattice of solutions. The list is empty only when the system provably has no integer solution. A row count of A that differs from the number of constants raises a length-mismatch error, and an entry that is not an integer expression leaf raises a declined-computation error.

solve_pell#

Explicit context

func solvePell(radicand: UniffiExpression) -> [UniffiExpression]

Fundamental solution [x, y] of x2−Dy2=1x^2 - D y^2 = 1 for a positive non-square integer D, the smallest positive solution from which all others are generated by the recurrence xk+1=x1xk+Dy1ykx_{k+1} = x_1 x_k + D y_1 y_k, yk+1=x1yk+y1xky_{k+1} = x_1 y_k + y_1 x_k. The list is empty when D is a perfect square or non-positive (no nontrivial fundamental solution). A radicand that is not an exact integer raises an integer-required error.

solve_negative_pell#

Explicit context

func solveNegativePell(radicand: UniffiExpression) -> [UniffiExpression]

Fundamental solution [x, y] of the negative-Pell equation x2−Dy2=−1x^2 - D y^2 = -1 when it is solvable (exactly when the continued fraction of D\sqrt{D} has odd period), and an empty list for an integer D for which it is not. A radicand that is not an exact integer raises an integer-required error.

pell_solutions#

Explicit context

func pellSolutions(
    radicand: UniffiExpression,
    count: UInt64,
) -> [UniffiExpression]

The first count positive solutions of x2−Dy2=1x^2 - D y^2 = 1, materialised from the fundamental solution by the Pell recurrence and returned as a flat list [x1,y1,x2,y2,…][x_1, y_1, x_2, y_2, \ldots]. Empty when the integer D has no fundamental solution; a radicand that is not an exact integer raises an integer-required error.

Integer-domain solving#

solve_integers is the deliberate integer-domain solver. It takes a conjunction of equations and linear congruences in an ordered list of integer unknowns, and either states the complete integer solution set or declines with a typed reason. It never returns a few sampled solutions as if they were all of them, and it never reports "no solution" for a problem it could not decide. General Diophantine equations are undecidable, so the accepted classes are deliberately narrow:

Request Result
One unknown, rational-coefficient polynomial or rational equations finite, empty, or lattice_family (every integer except undefined_points)
One unknown, linear congruences, with or without equations congruence_family (one residue class), finite, or empty
Several unknowns, affine equations and congruences lattice_family, finite, or empty, by Smith normal form
Two unknowns, one equation a*x^2 + b*y^2 + c = 0 reducing to x^2 - D*y^2 = N pell_orbits, finite, or empty
Anything else, including symbolic parameters declined with unsupported_class

solve_integers#

Explicit context

func solveIntegers(
    equations: [UniffiExpression],
    unknowns: [String],
    congruences: [UniffiExpression],
    moduli: [UniffiExpression],
    options: UniffiIntegerSolveOptions,
) -> UniffiIntegerSolveReport

Each equation is an equation or an expression meaning expression = 0. Congruence i states that congruences[i] vanishes modulo the positive integer moduli[i]; congruences are passed through this typed boundary, never parsed from mod syntax, and must be affine with integer coefficients. An empty or repeated unknown list, a moduli list of a different length, a modulus that is not a positive integer, and a zero limit are errors, not declines.

Every report that is not declined reads the same way. The integer solutions are exactly the tuples obtained by substituting integers for parameters into one of the solutions, other than the undefined_points. The three kinds of answer are kept apart:

  • finite and empty have no parameters: solutions is the whole enumerated set, and an empty list is a proof of no solution.
  • lattice_family and congruence_family are unbounded integer parameter families: 6*x + 9*y = 21 gives one tuple affine in one parameter, with its lattice_particular point and Hermite-reduced lattice_basis; 6x≡9(mod15)6x \equiv 9 \pmod{15} gives x = 4 + 5*k with residue 4 and modulus 5.
  • pell_orbits is a union of orbits under multiplication by the norm-one unit, not a list of samples. x^2 - 5*y^2 = 4 reports its pell_equation, the unit (9, 4), one seed per orbit, and two closed-form tuples per seed, one for each sign, exact in an integer exponent k. Every orbit is covered because each solution has exactly one representative in the unit's fundamental interval, and the scan of that interval is exhaustive.

Source definedness is kept: 1/(x - 1) = 0 is empty, and undefined_points still lists 1. A request whose proof would exceed a limit declines rather than returning part of the answer: a generalized Pell scan needing more than maximum_seed_candidates ordinates declines with seed_candidate_limit, and an integer or unit longer than maximum_integer_bits bits declines with integer_size_limit or fundamental_unit_limit. x^3 + y^3 + z^3 = 3 declines with unsupported_class. Python returns a dictionary with one key per report field below; WASM, Kotlin, and Swift return an IntegerSolveReport object.

IntegerSolveReport#

Not exposed by the Swift bindings. Available as api::IntegerSolveReport in Rust.

What solve_integers returns. complete is false only for a declined report.

integer_report_verdict#

UniffiIntegerSolveReport method

func verdict() -> UniffiIntegerSolveVerdict

Getter on IntegerSolveReport: finite, empty, lattice_family, congruence_family, pell_orbits, or declined.

integer_report_complete#

UniffiIntegerSolveReport method

func complete() -> Bool

Getter on IntegerSolveReport: whether the report states the whole integer solution set.

integer_report_unknowns#

UniffiIntegerSolveReport method

func unknowns() -> [UniffiExpression]

Getter on IntegerSolveReport: the requested unknowns, in the order every tuple uses.

integer_report_solutions#

UniffiIntegerSolveReport method

func solutions() -> [UniffiIntegerSolutionTuple]

Getter on IntegerSolveReport: the solution tuples, exact in the integer parameters.

integer_report_parameters#

UniffiIntegerSolveReport method

func parameters() -> [UniffiExpression]

Getter on IntegerSolveReport: the parameters of the solution tuples, each ranging over every integer.

integer_report_undefined_points#

UniffiIntegerSolveReport method

func undefinedPoints() -> [UniffiIntegerSolutionTuple]

Getter on IntegerSolveReport: the integer points at which some source equation is undefined. No solution is one of them.

integer_report_lattice_particular#

UniffiIntegerSolveReport method

func latticeParticular() -> UniffiIntegerSolutionTuple?

Getter on IntegerSolveReport: one point of the solution lattice of a lattice_family report.

integer_report_lattice_basis#

UniffiIntegerSolveReport method

func latticeBasis() -> [UniffiIntegerSolutionTuple]

Getter on IntegerSolveReport: a Hermite-reduced basis of the direction lattice of a lattice_family report.

integer_report_residue#

UniffiIntegerSolveReport method

func residue() -> UniffiExpression?

Getter on IntegerSolveReport: the least nonnegative member of the class of a congruence_family report.

integer_report_modulus#

UniffiIntegerSolveReport method

func modulus() -> UniffiExpression?

Getter on IntegerSolveReport: the positive modulus of the class of a congruence_family report.

integer_report_pell_equation#

UniffiIntegerSolveReport method

func pellEquation() -> UniffiExpression?

Getter on IntegerSolveReport: the normalized equation x^2 - D*y^2 = N of a pell_orbits report, written in the unknowns.

integer_report_pell_unit#

UniffiIntegerSolveReport method

func pellUnit() -> UniffiIntegerSolutionTuple?

Getter on IntegerSolveReport: the fundamental solution (u, v) of u^2 - D*v^2 = 1 that generates every orbit.

integer_report_pell_seeds#

UniffiIntegerSolveReport method

func pellSeeds() -> [UniffiIntegerSolutionTuple]

Getter on IntegerSolveReport: one seed per orbit, in the order of the requested unknowns.

integer_report_proof_methods#

UniffiIntegerSolveReport method

func proofMethods() -> [UniffiIntegerSolveProofMethod]

Getter on IntegerSolveReport: the kinds of exact evidence the result rests on, such as integer_root_theorem, chinese_remainder, smith_normal_form, or pell_fundamental_interval.

integer_report_decline_reason#

UniffiIntegerSolveReport method

func declineReason() -> UniffiIntegerSolveDeclineReason?

Getter on IntegerSolveReport: why the solve made no claim, present exactly when the verdict is declined.

IntegerSolutionTuple#

Not exposed by the Swift bindings. Available as api::IntegerSolutionTuple in Rust.

One exact tuple of a report, with one coordinate per requested unknown.

integer_tuple_coordinates#

UniffiIntegerSolutionTuple method

func coordinates() -> [UniffiExpression]

Getter on IntegerSolutionTuple: the coordinates, in the order of the requested unknowns.

Example#

Additional API#

RootMultiplicity#

RootMultiplicity.root#

UniffiRootMultiplicity method

func root() -> UniffiExpression

Principal n-th root, stored as x^(1/n).

Symi documentation · Swift