Struct IndicatorConstraint 

pub struct IndicatorConstraint<S: Stage<Self> = Created> {
    pub indicator_variable: VariableID,
    pub equality: Equality,
    pub stage: S::Data,
}

An indicator constraint: indicator_variable = 1 → f(x) <= 0 (or = 0).

When the binary indicator variable is 0, the constraint is unconditionally satisfied. When it is 1, the constraint f(x) <= 0 (or f(x) = 0) must hold.

The constraint’s IndicatorConstraintID is not stored in this struct — it is held by the enclosing collection (e.g. the BTreeMap key in Instance). Modeling labels and provenance live on the enclosing collection’s ConstraintContextStore; per-element context storage was retired in the v3 redesign.

Fields

indicator_variable: VariableID

The binary decision variable that activates this constraint.

equality: Equality

stage: S::Data

Implementations

impl IndicatorConstraint<Created>

pub fn new( indicator_variable: VariableID, equality: Equality, function: Function, ) -> Self

Create a new indicator constraint.

pub fn function(&self) -> &Function

Access the constraint function.

pub fn function_mut(&mut self) -> &mut Function

Mutable access to the constraint function.

Trait Implementations

impl<S: Clone + Stage<Self>> Clone for IndicatorConstraint<S>

where S::Data: Clone,

fn clone(&self) -> IndicatorConstraint<S>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl ConstraintType for IndicatorConstraint

type ID = IndicatorConstraintID

The ID type for this constraint family.

type Created = IndicatorConstraint

The constraint as defined in the problem.

type Evaluated = IndicatorConstraint<Evaluated>

The constraint after evaluation against a single state.

type Sampled = IndicatorConstraint<Sampled>

The constraint after evaluation against multiple samples.

impl<S: Debug + Stage<Self>> Debug for IndicatorConstraint<S>

where S::Data: Debug,

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for IndicatorConstraint<Created>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Evaluate for IndicatorConstraint<Created>

type Output = IndicatorConstraint<Evaluated>

type SampledOutput = IndicatorConstraint<Sampled>

fn evaluate(&self, state: &State, atol: ATol) -> Result<Self::Output>

Evaluate to return the output with used variable ids

fn evaluate_samples( &self, samples: &Sampled<State>, atol: ATol, ) -> Result<Self::SampledOutput>

Evaluate for each sample

fn partial_evaluate(&mut self, state: &State, atol: ATol) -> Result<()>

Partially evaluate the function to return the used variable ids

fn required_ids(&self) -> VariableIDSet

Decision variable IDs required for evaluation

impl From<IndicatorConstraint<Evaluated>> for EvaluatedIndicatorConstraint

fn from(constraint: EvaluatedIndicatorConstraint) -> Self

Converts to this type from the input type.

impl From<IndicatorConstraint<Sampled>> for SampledIndicatorConstraint

fn from(constraint: SampledIndicatorConstraint) -> Self

Converts to this type from the input type.

impl From<IndicatorConstraint> for IndicatorConstraint

fn from(constraint: IndicatorConstraint<Created>) -> Self

Converts to this type from the input type.

impl<S: PartialEq + Stage<Self>> PartialEq for IndicatorConstraint<S>

where S::Data: PartialEq,

fn eq(&self, other: &IndicatorConstraint<S>) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Propagate for IndicatorConstraint<Created>

type Transformed = Constraint

fn propagate( self, state: &State, atol: ATol, ) -> Result<(PropagateOutcome<Self>, State)>

Propagate variable fixings from state through this constraint.

impl Stage<IndicatorConstraint<Evaluated>> for Evaluated

type Data = IndicatorEvaluatedData

impl Stage<IndicatorConstraint<Sampled>> for Sampled

type Data = IndicatorSampledData

impl Stage<IndicatorConstraint> for Created

type Data = CreatedData

impl<S: PartialEq + Stage<Self>> StructuralPartialEq for IndicatorConstraint<S>

where S::Data: PartialEq,