Struct SampleSet 

#[non_exhaustive]
pub struct SampleSet {
    pub objectives: Option<SampledValues>,
    pub decision_variables: Vec<SampledDecisionVariable>,
    pub constraints: Vec<SampledConstraint>,
    pub named_functions: Vec<SampledNamedFunction>,
    pub feasible: HashMap<u64, bool>,
    pub feasible_unrelaxed: HashMap<u64, bool>,
    pub feasible_relaxed: HashMap<u64, bool>,
    pub sense: i32,
    pub metadata: Option<ProcessMetadata>,
    pub annotations: HashMap<String, String>,
    pub format_version: u32,
}

Output of the sampling process.

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.

objectives: Option<SampledValues>

decision_variables: Vec<SampledDecisionVariable>

constraints: Vec<SampledConstraint>

named_functions: Vec<SampledNamedFunction>

feasible: HashMap<u64, bool>

Feasibility for both remaining and removed constraints of each sample.

The meaning of feasible field in SDK changes between Python SDK 1.6.0 to 1.7.0. In Python SDK 1.6.0, feasible represents the feasibility of remaining constraints of each sample, i.e. removed constraints (introduced in 1.6.0) are not considered. After Python SDK 1.7.0, feasible represents the feasibility of all constraints of each sample. The feasibility of 1.6.0 is renamed to feasible_relaxed in 1.7.0.

feasible_unrelaxed: HashMap<u64, bool>

👎Deprecated

[Deprecated] This field has been introduced in Python SDK 1.6.0 to represent the feasibility of all constraints of each sample. The feasible field is used in this sense after Python SDK 1.7.0.

feasible_relaxed: HashMap<u64, bool>

Feasibility for remaining (non-removed) constraints of each sample.

sense: i32

Minimize or Maximize

metadata: Option<ProcessMetadata>

OMMX-defined provenance metadata for this SampleSet.

annotations: HashMap<String, String>

User-defined or third-party extension annotations.

OMMX-reserved metadata must use explicit fields such as metadata. Keys in this map must be valid reverse-domain names and must not start with org.ommx.v1..

format_version: u32

Format version of this message for forward compatibility checks. See Instance.format_version for semantics.

Implementations

impl SampleSet

pub fn sense(&self) -> Sense

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

pub fn set_sense(&mut self, value: Sense)

Sets sense to the provided enum value.

Trait Implementations

impl Clone for SampleSet

fn clone(&self) -> SampleSet

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SampleSet

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

Formats the value using the given formatter.

impl Default for SampleSet

fn default() -> Self

Returns the “default value” for a type.

impl From<SampleSet> for SampleSet

Lossy: v1::SampleSet only has a constraints field for regular sampled constraints — it has no fields for indicator / one-hot / sos1 sampled constraints, so any data the in-memory SampleSet holds in those collections is dropped on serialization. This is a wire-format limitation that pre-dates the label/context SoA refactor; the matching Parse impl above initializes those collections to Default::default() for symmetry. Round-trip through to_v1_bytes / from_v1_bytes preserves variable labels and regular-constraint context.

fn from(sample_set: SampleSet) -> Self

Converts to this type from the input type.

impl Message for SampleSet

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 SampleSet

type Output = SampleSet

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 SampleSet

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for SampleSet