Skip to main content

LinearExpr

Struct LinearExpr 

Source
pub struct LinearExpr {
    pub constant: Rational,
    pub coefficients: BTreeMap<i64, Rational>,
}
Expand description

A linear expression of the form c₀ + c₁x₁ + c₂x₂ + … + cₙxₙ.

Stored as a constant term plus a sparse map of variable coefficients. Variables with coefficient 0 are automatically removed.

§Representation

The expression 3 + 2x - y is stored as:

  • constant = 3
  • coefficients = {0: 2, 1: -1} (assuming x is var 0, y is var 1)

Fields§

§constant: Rational

The constant term c₀.

§coefficients: BTreeMap<i64, Rational>

Maps variable index to its coefficient (sparse representation).

Implementations§

Source§

impl LinearExpr

Source

pub fn constant(c: Rational) -> Self

Create a constant expression

Source

pub fn var(idx: i64) -> Self

Create a single variable expression: 1*x_idx + 0

Source

pub fn add(&self, other: &LinearExpr) -> LinearExpr

Add two linear expressions

Source

pub fn neg(&self) -> LinearExpr

Negate a linear expression

Source

pub fn sub(&self, other: &LinearExpr) -> LinearExpr

Subtract two linear expressions

Source

pub fn scale(&self, c: &Rational) -> LinearExpr

Scale a linear expression by a rational constant

Source

pub fn is_constant(&self) -> bool

Check if this is a constant expression (no variables)

Source

pub fn get_coeff(&self, var: i64) -> Rational

Get coefficient of a variable (0 if not present)

Trait Implementations§

Source§

impl Clone for LinearExpr

Source§

fn clone(&self) -> LinearExpr

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for LinearExpr

Source§

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

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

impl PartialEq for LinearExpr

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Eq for LinearExpr

Source§

impl StructuralPartialEq for LinearExpr

Auto Trait Implementations§

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> 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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.