Skip to main content

Step

Enum Step 

Source
#[non_exhaustive]
pub enum Step {
#[non_exhaustive]
Tableau { phase: Phase, iteration: usize, snapshot: Snapshot, },
#[non_exhaustive]
Pivot { phase: Phase, iteration: usize, entering: usize, entering_name: String, leaving_row: usize, leaving: usize, leaving_name: String, pivot_value: Rational, ratios: Vec<RatioTest>, },
#[non_exhaustive]
PhaseOneFinished { artificial_sum: Rational, feasible: bool, },
#[non_exhaustive]
ArtificialPivotedOut { row: usize, entering: usize, entering_name: String, },
#[non_exhaustive]
RedundantRowRemoved { row: usize, },
#[non_exhaustive]
ArtificialRemainsPositive { artificials: Vec<NamedValue>, unbounded_direction: bool, },
#[non_exhaustive]
DualPivot { phase: Phase, iteration: usize, leaving_row: usize, leaving: usize, leaving_name: String, entering: usize, entering_name: String, pivot_value: Rational, ratios: Vec<DualRatioTest>, },
#[non_exhaustive]
InfeasibleRow { row: usize, basic: NamedValue, },
#[non_exhaustive]
ConstraintAdded { constraint: usize, row: usize, satisfied: bool, },
#[non_exhaustive]
Finished { termination: Termination, }, }
Expand description

One recorded event.

New kinds of steps (for example from future methods) may be added in minor releases, so matches on Step need a wildcard arm. With the serde feature, a step is a JSON object whose "type" field is the variant name in snake_case ("tableau", "pivot", …).

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

#[non_exhaustive]
Tableau

The tableau at the start of an iteration (iteration starts at 0).

Fields

This variant is marked as non-exhaustive
Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.
§phase: Phase
§iteration: usize
§snapshot: Snapshot
§

#[non_exhaustive]
Pivot

A pivot: which column enters, which row leaves, and the ratio test behind the choice.

Fields

This variant is marked as non-exhaustive
Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.
§phase: Phase
§iteration: usize
§entering: usize
§entering_name: String
§leaving_row: usize
§leaving: usize
§leaving_name: String
§pivot_value: Rational
§ratios: Vec<RatioTest>
§

#[non_exhaustive]
PhaseOneFinished

Phase 1 of the two-phase method finished.

Fields

This variant is marked as non-exhaustive
Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.
§artificial_sum: Rational
§feasible: bool
§

#[non_exhaustive]
ArtificialPivotedOut

A zero-valued artificial variable was swapped out of the basis.

Fields

This variant is marked as non-exhaustive
Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.
§row: usize
§entering: usize
§entering_name: String
§

#[non_exhaustive]
RedundantRowRemoved

A row whose basic variable was artificial and had no usable column: it was redundant.

Fields

This variant is marked as non-exhaustive
Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.
§row: usize
§

#[non_exhaustive]
ArtificialRemainsPositive

Big-M: the penalty row (M part) can no longer improve, yet some artificial variables are still positive, so the problem is infeasible. unbounded_direction is true when the run stopped at an unbounded direction rather than at an optimal tableau.

Fields

This variant is marked as non-exhaustive
Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.
§artificials: Vec<NamedValue>

Each positive artificial variable and its value.

§unbounded_direction: bool
§

#[non_exhaustive]
DualPivot

A dual simplex pivot: which row leaves (it has a negative right-hand side), which column enters, and the ratio test over the columns behind the choice.

Fields

This variant is marked as non-exhaustive
Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.
§phase: Phase
§iteration: usize
§leaving_row: usize
§leaving: usize
§leaving_name: String
§entering: usize
§entering_name: String
§pivot_value: Rational
§

#[non_exhaustive]
InfeasibleRow

Dual simplex: the leaving row has a negative right-hand side but no negative entry, so its equation (non-negative terms adding up to a negative number) cannot hold: the problem is infeasible.

Fields

This variant is marked as non-exhaustive
Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.
§row: usize
§basic: NamedValue

The basic variable of that row and its (negative) value.

§

#[non_exhaustive]
ConstraintAdded

reoptimize: constraint constraint of the extended problem was appended to the final tableau as row row, expressed in the current basis with its own slack basic. satisfied tells whether the previous optimum already meets it.

Fields

This variant is marked as non-exhaustive
Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.
§constraint: usize
§row: usize
§satisfied: bool
§

#[non_exhaustive]
Finished

Final outcome.

Fields

This variant is marked as non-exhaustive
Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.
§termination: Termination

Trait Implementations§

Source§

impl Clone for Step

Source§

fn clone(&self) -> Self

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 Debug for Step

Source§

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

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

impl<'de> Deserialize<'de> for Step

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Eq for Step

Source§

impl PartialEq for Step

Source§

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

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

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

Inequality operator !=. Read more
Source§

impl Serialize for Step

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for Step

Auto Trait Implementations§

§

impl Freeze for Step

§

impl RefUnwindSafe for Step

§

impl Send for Step

§

impl Sync for Step

§

impl Unpin for Step

§

impl UnsafeUnpin for Step

§

impl UnwindSafe for Step

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> 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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.