RemovedConstraintCollection

class RemovedConstraintCollection

Live mapping of all retained removed constraint families in a model.

Obtained from removed_constraints or removed_constraints. Each access returns an independent snapshot, including labels, provenance, and removal reasons. Changing that snapshot does not update its owner; a later lookup reads the owner’s current state.

Removed constraints are excluded from the active formulation but still checked when candidates are evaluated. Removal can follow relaxation, an equivalent lowering, or another transformation; the collection’s presence does not identify which guarantee holds. See removed_constraints for their evaluation semantics and relax_constraint() for a complete relax, inspect, evaluate, and restore example.

The collection keeps its owner alive. The typed-key, get, live-view, iteration, and snapshot equality rules are documented in ConstraintCollection. Use of_kind and ConstraintFamilyView to inspect one family. A model’s constraints_df(kind=..., removed=True) includes both active and removed rows.

__contains__(key: object) → bool

__eq__(other: Any) → Any

__getitem__(key: ConstraintID) → RemovedConstraint

__getitem__(key: IndicatorConstraintID) → RemovedIndicatorConstraint

__getitem__(key: OneHotConstraintID) → RemovedOneHotConstraint

__getitem__(key: Sos1ConstraintID) → RemovedSos1Constraint

__getitem__(key: ConstraintIDBase) → ConstraintView

Fetch the constraint identified by a typed ID from the current owner.

__iter__() → Iterator[ConstraintIDBase]

Iterate a snapshot of typed IDs; constraint rows are not collected.

__len__() → int

__repr__() → str

get(key: ConstraintID, default: None = None) → RemovedConstraint | None

get(key: ConstraintID, default: _T) → RemovedConstraint | _T

get(key: IndicatorConstraintID, default: None = None) → RemovedIndicatorConstraint | None

get(key: IndicatorConstraintID, default: _T) → RemovedIndicatorConstraint | _T

get(key: OneHotConstraintID, default: None = None) → RemovedOneHotConstraint | None

get(key: OneHotConstraintID, default: _T) → RemovedOneHotConstraint | _T

get(key: Sos1ConstraintID, default: None = None) → RemovedSos1Constraint | None

get(key: Sos1ConstraintID, default: _T) → RemovedSos1Constraint | _T

get(key: ConstraintIDBase, default: None = None) → ConstraintView | None

get(key: ConstraintIDBase, default: ConstraintView) → ConstraintView

get(key: ConstraintIDBase, default: _T) → ConstraintView | _T

items() → ItemsView[ConstraintIDBase, ConstraintView]

Live item view; each row is fetched when visited.

keys() → KeysView[ConstraintIDBase]

Live key view. Iteration order is family order, then numeric ID.

of_kind(kind: Literal["regular"]) → ConstraintFamilyView[ConstraintID, RemovedConstraint]

of_kind(kind: Literal["indicator"]) → ConstraintFamilyView[IndicatorConstraintID, RemovedIndicatorConstraint]

of_kind(kind: Literal["one_hot"]) → ConstraintFamilyView[OneHotConstraintID, RemovedOneHotConstraint]

of_kind(kind: Literal["sos1"]) → ConstraintFamilyView[Sos1ConstraintID, RemovedSos1Constraint]

Return a live view of one family without collecting rows. Uses the same kind strings as constraints_df. Integer keys are promoted; wrong-family IDs are rejected. The view retains this collection and its owner; row lifecycle and iteration snapshot rules match the original collection.

values() → ValuesView[ConstraintView]

Live value view; each row is fetched when visited.