Constraints

Constraint — a bound on a numeric calculation that the solver must satisfy.

class ConstraintType(*values)

Constraint operator.

Values:

EQUALITY: The expression must equal the bound. INEQUALITY: The expression must lie within the lower/upper bounds.

EQUALITY = 'equality'

INEQUALITY = 'inequality'

class ConstraintSpecification(constraint_type, lower, upper, lower_inclusive, upper_inclusive, priority, hard_score)

The nested specification object of a Constraint.

A bound is emitted either as a literal (lowerBound/upperBound) or, when it is a model named value, as a bare-id reference (lowerBoundReference/upperBoundReference). All keys are always present (null where unset), and @type is the constraint type.

class Constraint(constraint)

A bound on a numeric Calculation that the solver must respect.

Construct via ModelConfiguration.add_constraint(); configure via the chained set_* methods. Default type is ConstraintType.INEQUALITY with upper_bound = 0 and inclusive bounds.

set_type(constraint_type)

Set the constraint type (equality or inequality).

Return type:

Constraint

set_lower_bound(lower_bound)

Set the lower bound. Pass a literal, Calculation, or Parameter.

Return type:

Constraint

set_upper_bound(upper_bound)

Set the upper bound. See set_lower_bound() for accepted types.

Return type:

Constraint

set_lower_bound_inclusive(lower_bound_inclusive)

Toggle inclusive/exclusive comparison on the lower bound.

Return type:

Constraint

set_upper_bound_inclusive(upper_bound_inclusive)

Toggle inclusive/exclusive comparison on the upper bound.

Return type:

Constraint

set_priority(priority)

Set the constraint Priority.

Return type:

Constraint

set_hard_score(hard_score)

Set the per-violation penalty applied to the solver’s hard score.

Return type:

Constraint

set_name(name)

Set an optional display name.

Return type:

Constraint

build()

Serialise to a dict; bound/reference splitting is delegated to the spec object.

Return type:

dict[str, Any]