Struct ddo::common::Variable

pub struct Variable(pub usize);

This type denotes a variable from the optimization problem at hand. In this case, each variable is assumed to be identified with an integer ranging from 0 until problem.nb_vars()

Implementations

impl Variable

pub fn id(self) -> usize

This function retruns the id (numeric value) of the variable.

Examples:

assert_eq!(0, Variable(0).id());
assert_eq!(1, Variable(1).id());
assert_eq!(2, Variable(2).id());
assert_eq!(3, Variable(3).id());

Trait Implementations

impl Clone for Variable

fn clone(&self) -> Variable

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Variable

impl Debug for Variable

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

Formats the value using the given formatter.

impl Eq for Variable

impl Hash for Variable

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl Ord for Variable

fn cmp(&self, other: &Variable) -> Ordering

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<Variable> for Variable

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<Variable> for Variable

fn partial_cmp(&self, other: &Variable) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Variable) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Variable) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Variable) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Variable) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for Variable

impl StructuralPartialEq for Variable