Enum Termination 

#[non_exhaustive]
pub enum Termination {
    Converged,
    IterationLimit,
    Infeasible,
    Unbounded,
    Failed,
    NotReported,
}

The calculation types used by solver consumers. The full problem vocabulary lives in powerio_prob; these types sit at the facade root so a consumer does not need a second PowerIO dependency to name its boundary. How the producing calculation ended.

Variants (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.

Converged

The calculation converged to its stated tolerance.

IterationLimit

The iteration limit ended the calculation before convergence.

Infeasible

The solver proved the constraints admit no solution. The optimization outcome an OPF consumer acts on differently from a numerical failure: the case is overconstrained, and no retry or setting change fixes it.

Unbounded

The solver proved the objective unbounded over the feasible set.

Failed

The calculation failed.

NotReported

The source records a solved calculation without termination information (DeepMind OPFData does).

Trait Implementations

impl Clone for Termination

fn clone(&self) -> Termination

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Termination

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

Formats the value using the given formatter.

impl Default for Termination

fn default() -> Termination

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Termination

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Termination

impl JsonSchema for Termination

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for Termination

fn eq(&self, other: &Termination) -> 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 Serialize for Termination

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Termination