Struct EvaluatedConstraint 

#[non_exhaustive]
pub struct EvaluatedConstraint {
    pub id: u64,
    pub equality: i32,
    pub evaluated_value: f64,
    pub used_decision_variable_ids: Vec<u64>,
    pub subscripts: Vec<i64>,
    pub parameters: HashMap<String, String>,
    pub name: Option<String>,
    pub description: Option<String>,
    pub dual_variable: Option<f64>,
    pub removed_reason: Option<String>,
    pub removed_reason_parameters: HashMap<String, String>,
}

A constraint evaluated with a state

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

id: u64

equality: i32

evaluated_value: f64

The value of function for the state

used_decision_variable_ids: Vec<u64>

IDs of decision variables used to evaluate this constraint

subscripts: Vec<i64>

Integer parameters of the constraint.

parameters: HashMap<String, String>

Key-value parameters of the constraint.

name: Option<String>

Name of the constraint.

description: Option<String>

Detail human-readable description of the constraint.

dual_variable: Option<f64>

Value for the Lagrangian dual variable of this constraint. This is optional because not all solvers support to evaluate dual variables.

removed_reason: Option<String>

Short removed reason of the constraint. This field exists only if this message is evaluated from a removed constraint.

removed_reason_parameters: HashMap<String, String>

Detailed parameters why the constraint is removed. This field exists only if this message is evaluated from a removed constraint.

Implementations

impl EvaluatedConstraint

pub fn equality(&self) -> Equality

Returns the enum value of equality, or the default if the field is set to an invalid enum value.

pub fn set_equality(&mut self, value: Equality)

Sets equality to the provided enum value.

pub fn name(&self) -> &str

Returns the value of name, or the default value if name is unset.

pub fn description(&self) -> &str

Returns the value of description, or the default value if description is unset.

pub fn dual_variable(&self) -> f64

Returns the value of dual_variable, or the default value if dual_variable is unset.

pub fn removed_reason(&self) -> &str

Returns the value of removed_reason, or the default value if removed_reason is unset.

impl EvaluatedConstraint

pub fn is_feasible(&self, atol: ATol) -> Result<bool>

Trait Implementations

impl Clone for EvaluatedConstraint

fn clone(&self) -> EvaluatedConstraint

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EvaluatedConstraint

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

Formats the value using the given formatter.

impl Default for EvaluatedConstraint

fn default() -> Self

Returns the “default value” for a type.

impl From<EvaluatedConstraint> for EvaluatedConstraint

fn from(constraint: EvaluatedConstraint) -> Self

Converts to this type from the input type.

impl Message for EvaluatedConstraint

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl Parse for EvaluatedConstraint

type Output = EvaluatedConstraint

type Context = ()

fn parse(self, _: &Self::Context) -> Result<Self::Output, ParseError>

fn parse_as( self, context: &Self::Context, message: &'static str, field: &'static str, ) -> Result<Self::Output, ParseError>

impl PartialEq for EvaluatedConstraint

fn eq(&self, other: &EvaluatedConstraint) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for EvaluatedConstraint