Skip to main content

Constraint

Struct Constraint 

Source
pub struct Constraint<S: Stage<Self> = Created> {
    pub equality: Equality,
    pub stage: S::Data,
}
Expand description

A constraint parameterized by its lifecycle stage.

Holds only the constraint’s intrinsic data (equality plus stage-specific data in stage). Modeling labels and transformation provenance live on the enclosing collection’s ConstraintContextStore keyed by id; per-element storage was retired in the v3 context redesign.

The constraint’s ConstraintID is not stored in this struct — it is held by the enclosing collection (e.g. the BTreeMap key in Instance), which is the single source of truth. Standalone constraints are identity-less until inserted into a collection.

Fields§

§equality: Equality§stage: S::Data

Implementations§

Source§

impl Constraint<Created>

Source

pub fn reduce_binary_power( &mut self, binary_ids: &VariableIDSet, ) -> Result<bool, CoefficientError>

Reduce binary powers in the constraint function.

For binary variables, x^n = x for any n >= 1, so we can reduce higher powers to linear terms.

Returns true if any reduction was performed, false otherwise.

Source§

impl Constraint<Created>

Source

pub fn function(&self) -> &Function

Access the constraint function.

Source

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

Mutable access to the constraint function.

Source

pub fn equal_to_zero(function: Function) -> Self

Source

pub fn less_than_or_equal_to_zero(function: Function) -> Self

Source§

impl Constraint<Evaluated>

Source

pub fn is_feasible_with_tolerance(&self, atol: ATol) -> bool

Check if this constraint is feasible given a specific tolerance

Source

pub fn violation(&self) -> f64

Calculate the violation (constraint breach) value for this constraint

Returns the amount by which this constraint is violated:

  • For f(x) = 0: returns |f(x)|
  • For f(x) ≤ 0: returns max(0, f(x))

Returns 0.0 if the constraint is satisfied.

Source§

impl Constraint<Sampled>

Source

pub fn is_feasible(&self, sample_id: SampleID, atol: ATol) -> Option<bool>

Check feasibility for a specific sample.

Returns None if sample_id is not present in the sampled data.

Source

pub fn feasible_ids(&self, atol: ATol) -> FnvHashSet<SampleID>

Get all sample IDs that are feasible

Source

pub fn infeasible_ids(&self, atol: ATol) -> FnvHashSet<SampleID>

Get all sample IDs that are infeasible

Trait Implementations§

Source§

impl AbsDiffEq for Constraint<Created>

Source§

type Epsilon = ATol

Used for specifying relative comparisons.
Source§

fn default_epsilon() -> Self::Epsilon

The default tolerance to use when testing values that are close together. Read more
Source§

fn abs_diff_eq(&self, other: &Self, epsilon: Self::Epsilon) -> bool

A test for equality that uses the absolute difference to compute the approximate equality of two numbers.
Source§

fn abs_diff_ne(&self, other: &Rhs, epsilon: Self::Epsilon) -> bool

The inverse of AbsDiffEq::abs_diff_eq.
Source§

impl Arbitrary for Constraint<Created>

Source§

type Parameters = PolynomialParameters

The type of parameters that arbitrary_with accepts for configuration of the generated Strategy. Parameters must implement Default.
Source§

type Strategy = BoxedStrategy<Constraint>

The type of Strategy used to generate values of type Self.
Source§

fn arbitrary_with(params: Self::Parameters) -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self). The strategy is passed the arguments given in args. Read more
Source§

fn arbitrary() -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self). Read more
Source§

impl<S: Clone + Stage<Self>> Clone for Constraint<S>
where S::Data: Clone,

Source§

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

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl ConstraintType for Constraint

Constraint (= Constraint<Created>) serves as the type family for regular constraints.

Source§

type ID = ConstraintID

The ID type for this constraint family.
Source§

type Created = Constraint

The constraint as defined in the problem.
Source§

type Evaluated = Constraint<Evaluated>

The constraint after evaluation against a single state.
Source§

type Sampled = Constraint<Sampled>

The constraint after evaluation against multiple samples.
Source§

impl<S: Debug + Stage<Self>> Debug for Constraint<S>
where S::Data: Debug,

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for Constraint<Created>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Evaluate for Constraint<Created>

Source§

type Output = Constraint<Evaluated>

Source§

type SampledOutput = Constraint<Sampled>

Source§

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

Evaluate to return the output with used variable ids
Source§

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

Evaluate for each sample
Source§

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

Partially evaluate the function to return the used variable ids
Source§

fn required_ids(&self) -> VariableIDSet

Decision variable IDs required for evaluation
Source§

impl From<Constraint<Evaluated>> for EvaluatedRegularConstraint

Source§

fn from(constraint: EvaluatedConstraint) -> Self

Converts to this type from the input type.
Source§

impl From<Constraint<Sampled>> for SampledRegularConstraint

Source§

fn from(constraint: SampledConstraint) -> Self

Converts to this type from the input type.
Source§

impl From<Constraint> for RegularConstraint

Source§

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

Converts to this type from the input type.
Source§

impl<S: PartialEq + Stage<Self>> PartialEq for Constraint<S>
where S::Data: PartialEq,

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Stage<Constraint<Evaluated>> for Evaluated

Source§

impl Stage<Constraint<Sampled>> for Sampled

Source§

impl Stage<Constraint> for Created

Source§

impl<S: PartialEq + Stage<Self>> StructuralPartialEq for Constraint<S>
where S::Data: PartialEq,

Auto Trait Implementations§

§

impl<S> Freeze for Constraint<S>
where <S as Stage<Constraint<S>>>::Data: Freeze,

§

impl<S> RefUnwindSafe for Constraint<S>
where <S as Stage<Constraint<S>>>::Data: RefUnwindSafe,

§

impl<S> Send for Constraint<S>
where <S as Stage<Constraint<S>>>::Data: Send,

§

impl<S> Sync for Constraint<S>
where <S as Stage<Constraint<S>>>::Data: Sync,

§

impl<S> Unpin for Constraint<S>
where <S as Stage<Constraint<S>>>::Data: Unpin,

§

impl<S> UnsafeUnpin for Constraint<S>
where <S as Stage<Constraint<S>>>::Data: UnsafeUnpin,

§

impl<S> UnwindSafe for Constraint<S>
where <S as Stage<Constraint<S>>>::Data: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more