Struct Variable 

pub struct Variable { /* private fields */ }

A lightweight handle to a decision variable.

Variable is Copy, so it can be used in expressions multiple times without being consumed: x + y does not move x.

Internally, a Variable carries its index and the ID of the model that created it. The model ID is used by checked variants such as crate::Model::try_var_name and crate::ModelResult::try_value to detect cross-model variable misuse at runtime.

Implementations

impl Variable

pub fn pow2(self) -> QuadExpr

Returns x² as a QuadExpr.

Trait Implementations

impl Add for Variable

type Output = Expression

The resulting type after applying the + operator.

fn add(self, rhs: Variable) -> Expression

Performs the + operation.

impl Add<Expression> for Variable

type Output = Expression

The resulting type after applying the + operator.

fn add(self, rhs: Expression) -> Expression

Performs the + operation.

impl Add<QuadExpr> for Variable

type Output = QuadExpr

The resulting type after applying the + operator.

fn add(self, rhs: QuadExpr) -> QuadExpr

Performs the + operation.

impl Add<Variable> for Expression

type Output = Expression

The resulting type after applying the + operator.

fn add(self, rhs: Variable) -> Expression

Performs the + operation.

impl Add<Variable> for QuadExpr

type Output = QuadExpr

The resulting type after applying the + operator.

fn add(self, rhs: Variable) -> QuadExpr

Performs the + operation.

impl Add<Variable> for f64

type Output = Expression

The resulting type after applying the + operator.

fn add(self, rhs: Variable) -> Expression

Performs the + operation.

impl Add<f64> for Variable

type Output = Expression

The resulting type after applying the + operator.

fn add(self, rhs: f64) -> Expression

Performs the + operation.

impl Clone for Variable

fn clone(&self) -> Variable

Returns a duplicate 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 From<Variable> for Expression

fn from(var: Variable) -> Self

Converts to this type from the input type.

impl From<Variable> for QuadExpr

fn from(v: Variable) -> Self

Converts to this type from the input type.

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Index<Variable> for ModelResult

Index a ModelResult by Variable to get the primal solution value.

Example

println!("x = {}", result[x]);

type Output = f64

The returned type after indexing.

fn index(&self, var: Variable) -> &f64

Performs the indexing (container[index]) operation.

impl Mul for Variable

type Output = QuadExpr

The resulting type after applying the * operator.

fn mul(self, rhs: Variable) -> QuadExpr

Performs the * operation.

impl Mul<Expression> for Variable

type Output = QuadExpr

The resulting type after applying the * operator.

fn mul(self, rhs: Expression) -> QuadExpr

Performs the * operation.

impl Mul<Variable> for Expression

type Output = QuadExpr

The resulting type after applying the * operator.

fn mul(self, var: Variable) -> QuadExpr

Performs the * operation.

impl Mul<Variable> for f64

type Output = Expression

The resulting type after applying the * operator.

fn mul(self, rhs: Variable) -> Expression

Performs the * operation.

impl Mul<f64> for Variable

type Output = Expression

The resulting type after applying the * operator.

fn mul(self, rhs: f64) -> Expression

Performs the * operation.

impl Neg for Variable

type Output = Expression

The resulting type after applying the - operator.

fn neg(self) -> Expression

Performs the unary - operation.

impl PartialEq for Variable

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

impl Sub for Variable

type Output = Expression

The resulting type after applying the - operator.

fn sub(self, rhs: Variable) -> Expression

Performs the - operation.

impl Sub<Expression> for Variable

type Output = Expression

The resulting type after applying the - operator.

fn sub(self, rhs: Expression) -> Expression

Performs the - operation.

impl Sub<QuadExpr> for Variable

type Output = QuadExpr

The resulting type after applying the - operator.

fn sub(self, rhs: QuadExpr) -> QuadExpr

Performs the - operation.

impl Sub<Variable> for Expression

type Output = Expression

The resulting type after applying the - operator.

fn sub(self, rhs: Variable) -> Expression

Performs the - operation.

impl Sub<Variable> for QuadExpr

type Output = QuadExpr

The resulting type after applying the - operator.

fn sub(self, rhs: Variable) -> QuadExpr

Performs the - operation.

impl Sub<Variable> for f64

type Output = Expression

The resulting type after applying the - operator.

fn sub(self, rhs: Variable) -> Expression

Performs the - operation.

impl Sub<f64> for Variable

type Output = Expression

The resulting type after applying the - operator.

fn sub(self, rhs: f64) -> Expression

Performs the - operation.