Struct SosConstraintHandle 

pub struct SosConstraintHandle<'a> { /* private fields */ }

A model-bound handle to an SOS constraint.

Single-constraint forms of crate::sos_constraint! and the programmatic SOS registration methods return this handle.

Implementations

impl SosConstraintHandle<'_>

pub const fn id(self) -> SosConstraintId

pub fn index(self) -> usize

pub fn to_reformulated_model( self, options: SosReformulationOptions, ) -> Result<ReformulatedModel, ReformulationError>

Produce an independent model in which this SOS constraint is replaced by mixed-integer algebraic constraints.

Errors

Returns ReformulationError when a fallback Big-M is invalid or a member lacks a finite bound and no fallback was supplied.

pub fn reformulate( self, options: SosReformulationOptions, ) -> Result<Option<SosReformulationArtifacts>, ReformulationError>

Replace this SOS constraint on its source model without cloning the model. Returns Ok(None) if it was already reformulated.

Errors

Returns ReformulationError before modifying the model when the fallback Big-M or a required member bound is invalid.

Trait Implementations

impl<'a> Clone for SosConstraintHandle<'a>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for SosConstraintHandle<'a>

impl Debug for SosConstraintHandle<'_>

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

Formats the value using the given formatter.

impl From<SosConstraintHandle<'_>> for SosConstraintId

fn from(value: SosConstraintHandle<'_>) -> Self

Converts to this type from the input type.