Skip to main content

Type Alias: SolverInfo

SolverInfo = { apiVersion: string; build: string; edition: Edition; solverVersion: string; valuesMasked: boolean; }

Version and edition information reported by the solver.

Remarks​

Describes the solver binary the API is talking to: its version, its edition, and whether it masks solution values.

The edition is fixed when the solver binary is built. In the preview edition, all solution values are masked (reported as absent), so SolverInfo.valuesMasked is the reliable way to tell whether the values in a Solution are real.

It is attached to every SolveResult as SolveResult.solverInfo, and can also be queried without solving.

See​

Properties​

apiVersion​

apiVersion: string

Version of the API package (the language binding).

Returns​

The API version string.

Remarks​

This is the version of the language API, equal to the ApiVersion constant. It may differ from SolverInfo.solverVersion, which is the version of the solver binary.

build​

build: string

Build identifier of the solver binary.

Returns​

The build identifier, or an empty string for an official release.

Remarks​

Identifies the exact build of the solver, including the source commit hash. It is empty for an official release. Useful to include in bug reports so the precise binary can be identified.

edition​

edition: Edition

Edition of the solver binary.

Returns​

The edition name, one of "preview", "academic", or "full".

Remarks​

The edition is fixed when the solver is built. To decide whether solution values are available, prefer SolverInfo.valuesMasked over comparing this string.

solverVersion​

solverVersion: string

Version of the solver binary.

Returns​

The solver version string.

Remarks​

The API and the solver normally have matching versions, but this field reports the solver's own version directly.

valuesMasked​

valuesMasked: boolean

Whether the solver masks solution values.

Returns​

True if solution values are masked (preview edition), False otherwise.

Remarks​

When true (the preview edition), every value in a Solution is reported as absent regardless of the actual result. Use this flag to distinguish a masked value from a variable that is genuinely absent.