Struct Quadratic 

#[non_exhaustive]
pub struct Quadratic {
    pub rows: Vec<u64>,
    pub columns: Vec<u64>,
    pub values: Vec<f64>,
    pub linear: Option<Linear>,
}

Quadratic function as a COO-style sparse matrix and linear sparse vector.

COOrdinate format, also known as triplet format, is a way to represent sparse matrices as a list of non-zero elements. It consists of three lists: the row indices, the column indices, and the values of the non-zero elements with following constraints:

• Entries and coordinates sorted by row, then column.
• There are no duplicate entries (i.e. duplicate (i,j) locations)
• Data arrays MAY have explicit zeros.

Note that this matrix is not assured to be symmetric nor upper triangular. For example, a quadratic function x1^2 + x2^2 + 2x1*x2 can be represented as:

• { rows: \[0, 0, 1\], columns: \[0, 1, 1\], values: \[1, 2, 1\] }, i.e. an upper triangular matrix \[[1, 2\], \[0, 1\]
• { rows: \[0, 0, 1, 1\], columns: \[0, 1, 0, 1\], values: \[1, 1, 1, 1\] }, i.e. a symmetric matrix \[[1, 1\], \[1, 1]\]

or even a non-symmetric, non-trianglar matrix as x1^2 + 3x1*x2 - x2*x1 + x2^2:

• { rows: \[0, 0, 1, 1\], columns: \[0, 1, 0, 1\], values: \[1, 3, -1, 1\] }, i.e. a non-symmetric matrix \[[1, 3\], \[-1, 1]\]

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

rows: Vec<u64>

columns: Vec<u64>

values: Vec<f64>

linear: Option<Linear>

Implementations

impl Quadratic

pub fn quad_iter(&self) -> impl Iterator<Item = ((u64, u64), f64)> + '_

pub fn as_linear(self) -> Option<Linear>

Downcast to a linear function if the quadratic function is linear.

pub fn as_constant(self) -> Option<f64>

Downcast to a constant if the quadratic function is constant.

pub fn degree(&self) -> u32

pub fn get_constant(&self) -> f64

Trait Implementations

impl AbsDiffEq for Quadratic

Compare coefficients in sup-norm.

type Epsilon = ATol

Used for specifying relative comparisons.

fn default_epsilon() -> Self::Epsilon

The default tolerance to use when testing values that are close together.

fn abs_diff_eq(&self, other: &Self, epsilon: Self::Epsilon) -> bool

A test for equality that uses the absolute difference to compute the approximate equality of two numbers.

fn abs_diff_ne(&self, other: &Rhs, epsilon: Self::Epsilon) -> bool

The inverse of AbsDiffEq::abs_diff_eq.

impl Add<&DecisionVariable> for Quadratic

type Output = <Linear as Add<Quadratic>>::Output

The resulting type after applying the + operator.

fn add(self, rhs: &DecisionVariable) -> Self::Output

Performs the + operation.

impl Add<&Parameter> for Quadratic

type Output = <Linear as Add<Quadratic>>::Output

The resulting type after applying the + operator.

fn add(self, rhs: &Parameter) -> Self::Output

Performs the + operation.

impl Add<Function> for Quadratic

type Output = <Function as Add<Quadratic>>::Output

The resulting type after applying the + operator.

fn add(self, rhs: Function) -> Self::Output

Performs the + operation.

impl Add<Linear> for Quadratic

type Output = Quadratic

The resulting type after applying the + operator.

fn add(self, rhs: Linear) -> Self

Performs the + operation.

impl Add<Polynomial> for Quadratic

type Output = <Polynomial as Add<Quadratic>>::Output

The resulting type after applying the + operator.

fn add(self, rhs: Polynomial) -> Self::Output

Performs the + operation.

impl Add<Quadratic> for &DecisionVariable

type Output = <Linear as Add<Quadratic>>::Output

The resulting type after applying the + operator.

fn add(self, rhs: Quadratic) -> Self::Output

Performs the + operation.

impl Add<Quadratic> for &Parameter

type Output = <Linear as Add<Quadratic>>::Output

The resulting type after applying the + operator.

fn add(self, rhs: Quadratic) -> Self::Output

Performs the + operation.

impl Add<Quadratic> for Function

type Output = Function

The resulting type after applying the + operator.

fn add(self, rhs: Quadratic) -> Self::Output

Performs the + operation.

impl Add<Quadratic> for Linear

type Output = <Quadratic as Add<Linear>>::Output

The resulting type after applying the + operator.

fn add(self, rhs: Quadratic) -> Self::Output

Performs the + operation.

impl Add<Quadratic> for Polynomial

type Output = Polynomial

The resulting type after applying the + operator.

fn add(self, rhs: Quadratic) -> Self::Output

Performs the + operation.

impl Add<Quadratic> for f64

type Output = <Quadratic as Add<f64>>::Output

The resulting type after applying the + operator.

fn add(self, rhs: Quadratic) -> Self::Output

Performs the + operation.

impl Add<f64> for Quadratic

type Output = Quadratic

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add for Quadratic

type Output = Quadratic

The resulting type after applying the + operator.

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

Performs the + operation.

impl Arbitrary for Quadratic

type Parameters = FunctionParameters

The type of parameters that arbitrary_with accepts for configuration of the generated Strategy. Parameters must implement Default.

type Strategy = BoxedStrategy<Quadratic>

The type of Strategy used to generate values of type Self.

fn arbitrary_with(p: Self::Parameters) -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self). The strategy is passed the arguments given in args.

fn arbitrary() -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self).

impl Clone for Quadratic

fn clone(&self) -> Quadratic

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Quadratic

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

Formats the value using the given formatter.

impl Default for Quadratic

fn default() -> Self

Returns the “default value” for a type.

impl Display for Quadratic

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

Formats the value using the given formatter.

impl Evaluate for Quadratic

type Output = f64

type SampledOutput = SampledValues

fn evaluate(&self, solution: &State, atol: ATol) -> Result<f64>

Evaluate to return the output with used variable ids

fn partial_evaluate(&mut self, state: &State, _atol: ATol) -> Result<()>

Partially evaluate the function to return the used variable ids

fn evaluate_samples( &self, samples: &Samples, atol: ATol, ) -> Result<Self::SampledOutput>

Evaluate for each sample

fn required_ids(&self) -> VariableIDSet

Decision variable IDs required for evaluation

impl From<&DecisionVariable> for Quadratic

fn from(dv: &DecisionVariable) -> Self

Converts to this type from the input type.

impl From<&Parameter> for Quadratic

fn from(dv: &Parameter) -> Self

Converts to this type from the input type.

impl From<Linear> for Quadratic

fn from(l: Linear) -> Self

Converts to this type from the input type.

impl From<PolynomialBase<QuadraticMonomial>> for Quadratic

fn from(value: Quadratic) -> Self

Converts to this type from the input type.

impl From<Quadratic> for Function

fn from(q: Quadratic) -> Self

Converts to this type from the input type.

impl From<Quadratic> for Polynomial

fn from(q: Quadratic) -> Self

Converts to this type from the input type.

impl From<f64> for Quadratic

fn from(c: f64) -> Self

Converts to this type from the input type.

impl FromIterator<((u64, u64), f64)> for Quadratic

fn from_iter<I: IntoIterator<Item = ((u64, u64), f64)>>(iter: I) -> Self

Creates a value from an iterator.

impl<'a> IntoIterator for &'a Quadratic

type Item = (MonomialDyn, f64)

The type of the elements being iterated over.

type IntoIter = Box<dyn Iterator<Item = <&'a Quadratic as IntoIterator>::Item> + 'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl Message for Quadratic

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl Mul<&DecisionVariable> for Quadratic

type Output = <Linear as Mul<Quadratic>>::Output

The resulting type after applying the * operator.

fn mul(self, rhs: &DecisionVariable) -> Self::Output

Performs the * operation.

impl Mul<&Parameter> for Quadratic

type Output = <Linear as Mul<Quadratic>>::Output

The resulting type after applying the * operator.

fn mul(self, rhs: &Parameter) -> Self::Output

Performs the * operation.

impl Mul<Function> for Quadratic

type Output = <Function as Mul<Quadratic>>::Output

The resulting type after applying the * operator.

fn mul(self, rhs: Function) -> Self::Output

Performs the * operation.

impl Mul<Linear> for Quadratic

type Output = Polynomial

The resulting type after applying the * operator.

fn mul(self, rhs: Linear) -> Self::Output

Performs the * operation.

impl Mul<Polynomial> for Quadratic

type Output = <Polynomial as Mul<Quadratic>>::Output

The resulting type after applying the * operator.

fn mul(self, rhs: Polynomial) -> Self::Output

Performs the * operation.

impl Mul<Quadratic> for &DecisionVariable

type Output = <Linear as Mul<Quadratic>>::Output

The resulting type after applying the * operator.

fn mul(self, rhs: Quadratic) -> Self::Output

Performs the * operation.

impl Mul<Quadratic> for &Parameter

type Output = <Linear as Mul<Quadratic>>::Output

The resulting type after applying the * operator.

fn mul(self, rhs: Quadratic) -> Self::Output

Performs the * operation.

impl Mul<Quadratic> for Function

type Output = Function

The resulting type after applying the * operator.

fn mul(self, rhs: Quadratic) -> Self::Output

Performs the * operation.

impl Mul<Quadratic> for Linear

type Output = <Quadratic as Mul<Linear>>::Output

The resulting type after applying the * operator.

fn mul(self, rhs: Quadratic) -> Self::Output

Performs the * operation.

impl Mul<Quadratic> for Polynomial

type Output = Polynomial

The resulting type after applying the * operator.

fn mul(self, rhs: Quadratic) -> Self::Output

Performs the * operation.

impl Mul<Quadratic> for f64

type Output = <Quadratic as Mul<f64>>::Output

The resulting type after applying the * operator.

fn mul(self, rhs: Quadratic) -> Self::Output

Performs the * operation.

impl Mul<f64> for Quadratic

type Output = Quadratic

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul for Quadratic

type Output = Polynomial

The resulting type after applying the * operator.

fn mul(self, rhs: Self) -> Self::Output

Performs the * operation.

impl Neg for &Quadratic

type Output = Quadratic

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl Neg for Quadratic

type Output = Quadratic

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl Parse for Quadratic

type Output = PolynomialBase<QuadraticMonomial>

type Context = ()

fn parse(self, _: &Self::Context) -> Result<Self::Output, ParseError>

fn parse_as( self, context: &Self::Context, message: &'static str, field: &'static str, ) -> Result<Self::Output, ParseError>

impl PartialEq for Quadratic

fn eq(&self, other: &Quadratic) -> 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 Sub<Linear> for Quadratic

type Output = Quadratic

The resulting type after applying the - operator.

fn sub(self, rhs: Linear) -> Self::Output

Performs the - operation.

impl Sub<Quadratic> for Function

type Output = Function

The resulting type after applying the - operator.

fn sub(self, rhs: Quadratic) -> Self::Output

Performs the - operation.

impl Sub<f64> for Quadratic

type Output = Quadratic

The resulting type after applying the - operator.

fn sub(self, rhs: f64) -> Self::Output

Performs the - operation.

impl Sub for Quadratic

type Output = Quadratic

The resulting type after applying the - operator.

fn sub(self, rhs: Quadratic) -> Self::Output

Performs the - operation.

impl TryFrom<Quadratic> for Quadratic

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from(value: Quadratic) -> Result<Self, Self::Error>

Performs the conversion.

impl Zero for Quadratic

fn zero() -> Self

Returns the additive identity element of Self, 0.

fn is_zero(&self) -> bool

Returns true if self is equal to the additive identity.

fn set_zero(&mut self)

Sets self to the additive identity element of Self, 0.

impl StructuralPartialEq for Quadratic