QuadTermList

A quadratic expression that is represented as a list of terms. More...

#include <xpress_objects.hpp>

Inheritance diagram for xpress::objects::QuadTermList:

Public Member Functions

QuadTermList ()

Create a empty expression.

QuadTermList (double c)

Create a expression that represents a constant term.

QuadTermList (double c, int capacity)

Create a expression with a constant term and an initial capacity.

virtual auto addConstant (double c) -> QuadTermList &override

Add a value to the constant term of this expression.

Parameters

c	The constant to add.

Returns: Always returns this.

Since: 44.00

virtual auto addTerm (double const &coefficient, Variable const &variable) -> QuadTermList &override

Add a term to this expression.If the expression already has a coefficient for variable then the old and the coefficients will be added.

Parameters

coefficient	Coefficient to add for `variable`.
variable	Variable.

Returns: Always returns this.

Since: 44.00

virtual auto addTerm (double const &coefficient, Variable const &variable1, Variable const &variable2) -> QuadTermList &override

Add a term to this expression.If the expression already has a coefficient for variable1*variable2 then the old and the coefficients will be added.

Parameters

coefficient	Coefficient to add for `variable1*variable2`.
variable1	First variable.
variable2	Second variable.

Returns: Always returns this.

Since: 44.00

auto addTerm (LinTerm const &term) -> QuadExpression &

Add term to this expression.

auto addTerm (QuadTerm const &term) -> QuadExpression &

Add term to this expression.

virtual auto addTerm (Variable const &variable, double const &coefficient) -> QuadTermList &override

Add a term to this expression.If the expression already has a coefficient for variable then the old and the coefficients will be added.

Parameters

variable	Variable.
coefficient	Coefficient to add for `variable`.

Returns: Always returns this.

Since: 44.00

virtual auto addTerm (Variable const &variable1, Variable const &variable2, double const &coefficient) -> QuadTermList &override

Add a term to this expression.If the expression already has a coefficient for variable1*variable2 then the old and the coefficients will be added.

Parameters

variable1	First variable.
variable2	Second variable.
coefficient	Coefficient to add for `variable1*variable2`.

Returns: Always returns this.

Since: 44.00

virtual auto addTerm (Variable const &x) -> QuadTermList &override

Add term 1.0*x to this expression.If the expression already has a coefficient for x then the old and the coefficients will be added.

Parameters

x Variable.

Returns: Always returns this.

Since: 44.00

virtual auto addTerm (Variable const &x1, Variable const &x2) -> QuadTermList &override

Add term 1.0*x1*x2 to this expression.If the expression already has a coefficient for x then the old and the coefficients will be added.

Parameters

x1	First variable.
x2	Second variable.

Returns: Always returns this.

Since: 44.00

virtual auto addTerms (LinExpression const &expr) -> QuadTermList &override

Add another linear expression to this expression.

Parameters

expr	The expression to add

Returns: Always returns this.

Since: 44.00

virtual auto addTerms (LinExpression const &expr, double const &factor) -> QuadTermList &override

Add another linear expression to this expression.

Parameters

expr	The expression to add.
factor	Factor by which to multiply elements in `expr` before adding.

Returns: Always returns this.

Since: 44.00

virtual auto addTerms (QuadExpression const &expr) -> QuadTermList &override

Add another quadratic expression to this expression.

Parameters

expr	The expression to add

Returns: Always returns this.

Since: 44.00

virtual auto addTerms (QuadExpression const &expr, double const &factor) -> QuadTermList &override

Add another quadratic expression to this expression.

Parameters

expr	The expression to add.
factor	Factor by which to multiply elements in `expr` before adding.

Returns: Always returns this.

Since: 44.00

template<typename Strm0 , typename Strm1 , typename Strm0IsStream = typename std::enable_if<xpress::is_stream<Strm0>::value>::type, typename Strm1IsStream = typename std::enable_if<xpress::is_stream<Strm1>::value>::type>

auto addTerms (Strm0 const &variables, Strm1 const &coefficients) -> QuadExpression &

Add multiple linear terms to this expression.

template<typename Strm0 , typename Strm1 , typename Strm2 , typename Strm0IsStream = typename std::enable_if<xpress::is_stream<Strm0>::value>::type, typename Strm1IsStream = typename std::enable_if<xpress::is_stream<Strm1>::value>::type, typename Strm2IsStream = typename std::enable_if<xpress::is_stream<Strm2>::value>::type>

auto addTerms (Strm0 const &variables1, Strm1 const &variables2, Strm2 const &coefficients) -> QuadExpression &

Add multiple quadratic terms to this expression.

auto addTerms (xpress::SizedArray< Variable const > const &variables, xpress::SizedArray< double const > const &coefficients, int offset, int count) -> QuadExpression &

Add multiple terms to this expression.

auto addTerms (xpress::SizedArray< Variable const > const &variables1, xpress::SizedArray< Variable const > const &variables2, xpress::SizedArray< double const > const &coefficients, int offset, int count) -> QuadExpression &

Add multiple terms to this expression.

auto compress () const -> void

Compress duplicate terms.

virtual auto deepCopy () -> xpress::objects::QuadExpression override

Get a deep copy of this expression.

Returns: A deep copy of this expression.

Since: 44.00

virtual auto deepCopy (double factor) -> xpress::objects::QuadExpression override

Get a deep copy of this expression multiplied by a constant.

Parameters

factor Factor to scale this with.

Returns: A deep copy of this expression multiplied by factor.

Since: 44.00

virtual auto evaluate (xpress::SizedArray< double const > const &solution) const -> double override

Compute the value of this expression with respect to the given solution vector (which is not required to be feasible).

Parameters

solution Solution values for which the expression is evaluated.

Returns: The value of this expression evaluated at solution.

Since: 44.00

virtual auto extract (double factor, xpress::XPRSProblem::RowCreator *creator) const -> bool override

virtual auto getConstant () const -> double override

Get the constant value in this expression.

Returns: The constant value in this expression.

Since: 44.00

auto reserve (int l) -> QuadTermList &

Reserve a maximum number of elements in this expression.

virtual auto reset () -> QuadTermList &override

Clear this expression.Removes all terms and sets the constant to 0.

Returns: Always returns this.

Since: 44.00

virtual auto setConstant (double c) -> QuadTermList &override

Set the constant term in this expression.Any existing constant term will be overwritten.

Parameters

c	New constant term for this expression

Returns: Always returns this.

Since: 44.00

virtual auto toString () const -> std::string override

Get a string representation of this expression.

Returns: A string representing this expression.

Since: 44.00

Public Member Functions inherited from xpress::objects::QuadExpression

auto addTerm (LinTerm const &term) -> QuadExpression &

Add term to this expression.

auto addTerm (QuadTerm const &term) -> QuadExpression &

Add term to this expression.

auto addTerms (Strm0 const &variables, Strm1 const &coefficients) -> QuadExpression &

Add multiple linear terms to this expression.

auto addTerms (Strm0 const &variables1, Strm1 const &variables2, Strm2 const &coefficients) -> QuadExpression &

Add multiple quadratic terms to this expression.

auto addTerms (xpress::SizedArray< Variable const > const &variables, xpress::SizedArray< double const > const &coefficients, int offset, int count) -> QuadExpression &

Add multiple terms to this expression.

Public Member Functions inherited from xpress::objects::AbstractExpression

virtual auto eq (double rhs) const -> xpress::objects::InequalityDefinition override

Create an "equals" constraint with this expression as left-hand side.

Parameters

rhs	Right-hand side of constraint.

Returns: The constraint.

Since: 44.00

virtual auto eq (Expression const &rhs) const -> xpress::objects::InequalityDefinition override

Create an "equals" constraint with this expression as left-hand side.

Parameters

rhs	Right-hand side of constraint.

Returns: The constraint.

Since: 44.00

virtual auto geq (double rhs) const -> xpress::objects::InequalityDefinition override

Create a "greater than or equal" constraint with this expression as left-hand side.

Parameters

rhs	Right-hand side of constraint.

Returns: The constraint.

Since: 44.00

virtual auto geq (Expression const &rhs) const -> xpress::objects::InequalityDefinition override

Create a "greater than or equal" constraint with this expression as left-hand side.

Parameters

rhs	Right-hand side of constraint.

Returns: The constraint.

Since: 44.00

virtual auto in (double lb, double ub) -> xpress::objects::InequalityDefinition override

Create a range constraint that bounds this expression from below and above.

Parameters

lb	Lower bound for this expression.
ub	Upper bound for this expression.

Returns: The constraint.

Since: 44.00

virtual auto leq (double rhs) const -> xpress::objects::InequalityDefinition override

Create a "less than or equal" constraint with this expression as left-hand side.

Parameters

rhs	Right-hand side of constraint.

Returns: The constraint.

Since: 44.00

virtual auto leq (Expression const &rhs) const -> xpress::objects::InequalityDefinition override

Create a "less than or equal" constraint with this expression as left-hand side.

Parameters

rhs	Right-hand side of constraint.

Returns: The constraint.

Since: 44.00

Public Member Functions inherited from xpress::objects::Expression

virtual auto div (double arg) const -> xpress::objects::Expression

Create a expression that represents the quotient of this and arg.

virtual auto div (Expression arg) const -> xpress::objects::Expression

Create a expression that represents the quotient of this and arg.

virtual auto minus (double arg) const -> xpress::objects::Expression

Create a expression that represents the difference of this and arg.

virtual auto minus (xpress::objects::Expression arg) const -> xpress::objects::Expression

Create a expression that represents the difference of this and arg.

virtual auto mul (double arg) const -> xpress::objects::Expression

Create a expression that represents the product of this and arg.

virtual auto mul (Expression arg) const -> xpress::objects::Expression

Create a expression that represents the product of this and arg.

virtual auto plus (double arg) const -> xpress::objects::Expression

Create a expression that represents the sum of this and arg.

virtual auto plus (xpress::objects::Expression arg) const -> xpress::objects::Expression

Create a expression that represents the sum of this and arg.

virtual auto uminus () const -> xpress::objects::Expression

Create a expression that represents the unary minus of this one.

Static Public Member Functions
static auto	isAutoCompress () -> bool
	Test whether auto-compression is enabled for this class.

static auto	setAutoCompress (bool compress) -> void
	Enable/disable auto-compression for instances of this class.

Static Public Member Functions inherited from xpress::objects::QuadExpression
static auto	create () -> xpress::objects::QuadExpression
	Create a empty quadratic expression.

static auto	create (double constant) -> xpress::objects::QuadExpression
	Create a quadratic expression with the specified constant term.

Detailed Description

A quadratic expression that is represented as a list of terms.

Instances of this class represent a quadratic expression as a list of terms. This is the most efficient way to represent a list. By default, the implementation assumes that there are no two terms in the list that refer to the same pair of variables. If there are you must either explicitly call compress() or set the autoCompress property to true.

Since: 44.00

Constructor & Destructor Documentation

QuadTermList() [1/3]

xpress::objects::QuadTermList::QuadTermList ( )

inline

Create a empty expression.

Since: 44.00

QuadTermList() [2/3]

xpress::objects::QuadTermList::QuadTermList ( double c )

inline

Create a expression that represents a constant term.

Parameters

c	The constant term.

Since: 44.00

QuadTermList() [3/3]

xpress::objects::QuadTermList::QuadTermList	(	double	c,
		int	capacity )

inline

Create a expression with a constant term and an initial capacity.

Parameters

c	The constant term.
capacity	The initial capacity.

Since: 44.00

Member Function Documentation

addConstant()

auto xpress::objects::QuadTermList::addConstant ( double c ) -> QuadTermList&

inlineoverridevirtual

Add a value to the constant term of this expression.

Parameters

c	The constant to add.

Returns: Always returns this.

Since: 44.00

Since: 44.00

Reimplemented from xpress::objects::QuadExpression.

addTerm() [1/8]

auto xpress::objects::QuadTermList::addTerm	(	double const &	coefficient,
		Variable const &	variable ) -> QuadTermList&

inlineoverridevirtual

Add a term to this expression.If the expression already has a coefficient for variable then the old and the coefficients will be added.

Parameters

coefficient	Coefficient to add for `variable`.
variable	Variable.

Returns: Always returns this.

Since: 44.00

Since: 44.00

Reimplemented from xpress::objects::QuadExpression.

addTerm() [2/8]

auto xpress::objects::QuadTermList::addTerm	(	double const &	coefficient,
		Variable const &	variable1,
		Variable const &	variable2 ) -> QuadTermList&

inlineoverridevirtual

Add a term to this expression.If the expression already has a coefficient for variable1*variable2 then the old and the coefficients will be added.

Parameters

coefficient	Coefficient to add for `variable1*variable2`.
variable1	First variable.
variable2	Second variable.

Returns: Always returns this.

Since: 44.00

Since: 44.00

Reimplemented from xpress::objects::QuadExpression.

addTerm() [3/8]

auto xpress::objects::QuadExpression::addTerm ( LinTerm const & term ) -> QuadExpression&

inline

Add term to this expression.

Parameters

term	The term to add.

Returns: Always returns this.

Since: 44.00

addTerm() [4/8]

auto xpress::objects::QuadExpression::addTerm ( QuadTerm const & term ) -> QuadExpression&

inline

Add term to this expression.

Parameters

term	The term to add.

Returns: Always returns this.

Since: 44.00

addTerm() [5/8]

auto xpress::objects::QuadTermList::addTerm	(	Variable const &	variable,
		double const &	coefficient ) -> QuadTermList&

inlineoverridevirtual

Add a term to this expression.If the expression already has a coefficient for variable then the old and the coefficients will be added.

Parameters

variable	Variable.
coefficient	Coefficient to add for `variable`.

Returns: Always returns this.

Since: 44.00

Since: 44.00

Reimplemented from xpress::objects::QuadExpression.

addTerm() [6/8]

auto xpress::objects::QuadTermList::addTerm	(	Variable const &	variable1,
		Variable const &	variable2,
		double const &	coefficient ) -> QuadTermList&

inlineoverridevirtual

Add a term to this expression.If the expression already has a coefficient for variable1*variable2 then the old and the coefficients will be added.

Parameters

variable1	First variable.
variable2	Second variable.
coefficient	Coefficient to add for `variable1*variable2`.

Returns: Always returns this.

Since: 44.00

Since: 44.00

Reimplemented from xpress::objects::QuadExpression.

addTerm() [7/8]

auto xpress::objects::QuadTermList::addTerm ( Variable const & x ) -> QuadTermList&

inlineoverridevirtual

Add term 1.0*x to this expression.If the expression already has a coefficient for x then the old and the coefficients will be added.

Parameters

x Variable.

Returns: Always returns this.

Since: 44.00

Since: 44.00

Reimplemented from xpress::objects::QuadExpression.

addTerm() [8/8]

auto xpress::objects::QuadTermList::addTerm	(	Variable const &	x1,
		Variable const &	x2 ) -> QuadTermList&

inlineoverridevirtual

Add term 1.0*x1*x2 to this expression.If the expression already has a coefficient for x then the old and the coefficients will be added.

Parameters

x1	First variable.
x2	Second variable.

Returns: Always returns this.

Since: 44.00

Since: 44.00

Reimplemented from xpress::objects::QuadExpression.

addTerms() [1/8]

auto xpress::objects::QuadTermList::addTerms ( LinExpression const & expr ) -> QuadTermList&

inlineoverridevirtual

Add another linear expression to this expression.

Parameters

expr	The expression to add

Returns: Always returns this.

Since: 44.00

Since: 44.00

Reimplemented from xpress::objects::QuadExpression.

addTerms() [2/8]

auto xpress::objects::QuadTermList::addTerms	(	LinExpression const &	expr,
		double const &	factor ) -> QuadTermList&

inlineoverridevirtual

Add another linear expression to this expression.

Parameters

expr	The expression to add.
factor	Factor by which to multiply elements in `expr` before adding.

Returns: Always returns this.

Since: 44.00

Since: 44.00

Reimplemented from xpress::objects::QuadExpression.

addTerms() [3/8]

auto xpress::objects::QuadTermList::addTerms ( QuadExpression const & expr ) -> QuadTermList&

inlineoverridevirtual

Add another quadratic expression to this expression.

Parameters

expr	The expression to add

Returns: Always returns this.

Since: 44.00

Since: 44.00

Reimplemented from xpress::objects::QuadExpression.

addTerms() [4/8]

auto xpress::objects::QuadTermList::addTerms	(	QuadExpression const &	expr,
		double const &	factor ) -> QuadTermList&

inlineoverridevirtual

Add another quadratic expression to this expression.

Parameters

expr	The expression to add.
factor	Factor by which to multiply elements in `expr` before adding.

Returns: Always returns this.

Since: 44.00

Since: 44.00

Reimplemented from xpress::objects::QuadExpression.

addTerms() [5/8]

auto xpress::objects::QuadExpression::addTerms	(	Strm0 const &	variables,
		Strm1 const &	coefficients ) -> QuadExpression&

inline

Add multiple linear terms to this expression.

Adds the scalar product defined by the element-wise multiplication of variables and coefficients.

Parameters

variables	Variables.
coefficients	Coefficients.

Template Parameters

Strm0	Something that supports `begin()` and `end()` and contains values of type `Variable`.
Strm1	Something that supports `begin()` and `end()` and contains values of type `double`.

Returns: Always returns this.

Since: 44.00

addTerms() [6/8]

auto xpress::objects::QuadExpression::addTerms	(	Strm0 const &	variables1,
		Strm1 const &	variables2,
		Strm2 const &	coefficients ) -> QuadExpression&

inline

Add multiple quadratic terms to this expression.

Adds the scalar product defined by the element-wise multiplication of variables1, variables2 and coefficients.

Parameters

variables1	First variables.
variables2	Second variables.
coefficients	Coefficients.

Template Parameters

Strm0	Something that supports `begin()` and `end()` and contains values of type `Variable`.
Strm1	Something that supports `begin()` and `end()` and contains values of type `Variable`.
Strm2	Something that supports `begin()` and `end()` and contains values of type `double`.

Returns: Always returns this.

Since: 44.00

addTerms() [7/8]

auto xpress::objects::QuadExpression::addTerms	(	xpress::SizedArray< Variable const > const &	variables,
		xpress::SizedArray< double const > const &	coefficients,
		int	offset,
		int	count ) -> QuadExpression&

inline

Add multiple terms to this expression.

Adds the scalar product defined by the element-wise multiplication of variables and coefficients using count elements starting from offset.

Parameters

variables	Variables
coefficients	Coefficients
offset	Offset into arrays.
count	Number of elements to use from each array.

Returns: Always returns this.

Since: 44.00

addTerms() [8/8]

auto xpress::objects::QuadExpression::addTerms	(	xpress::SizedArray< Variable const > const &	variables1,
		xpress::SizedArray< Variable const > const &	variables2,
		xpress::SizedArray< double const > const &	coefficients,
		int	offset,
		int	count ) -> QuadExpression&

inline

Add multiple terms to this expression.

Adds the scalar product defined by the element-wise multiplication of variables1, variables2 and coefficients using count elements starting from offset.

Parameters

variables1	First variables
variables2	Second variables
coefficients	Coefficients
offset	Offset into arrays.
count	Number of elements to use from each array.

Returns: Always returns this.

Since: 44.00

compress()

auto xpress::objects::QuadTermList::compress ( ) const -> void

inline

Compress duplicate terms.

Sorts the terms and merges any terms for the same variable into a single term.

Since: 44.00

deepCopy() [1/2]

auto xpress::objects::QuadTermList::deepCopy ( ) -> xpress::objects::QuadExpression

inlineoverridevirtual

Get a deep copy of this expression.

Returns: A deep copy of this expression.

Since: 44.00

Since: 44.00

Reimplemented from xpress::objects::QuadExpression.

deepCopy() [2/2]

auto xpress::objects::QuadTermList::deepCopy ( double factor ) -> xpress::objects::QuadExpression

inlineoverridevirtual

Get a deep copy of this expression multiplied by a constant.

Parameters

factor Factor to scale this with.

Returns: A deep copy of this expression multiplied by factor.

Since: 44.00

Parameters

factor Factor to scale this with.

Since: 44.00

Reimplemented from xpress::objects::QuadExpression.

evaluate()

auto xpress::objects::QuadTermList::evaluate ( xpress::SizedArray< double const > const & solution ) const -> double

inlineoverridevirtual

Compute the value of this expression with respect to the given solution vector (which is not required to be feasible).

Parameters

solution Solution values for which the expression is evaluated.

Returns: The value of this expression evaluated at solution.

Since: 44.00

Parameters

solution Solution values for which the expression is evaluated.

Since: 44.00

Reimplemented from xpress::objects::Expression.

extract()

auto xpress::objects::QuadTermList::extract	(	double	factor,
		xpress::XPRSProblem::RowCreator *	creator ) const -> bool

inlineoverridevirtual

Since: 44.00

Reimplemented from xpress::objects::Expression.

getConstant()

auto xpress::objects::QuadTermList::getConstant ( ) const -> double

inlineoverridevirtual

Get the constant value in this expression.

Returns: The constant value in this expression.

Since: 44.00

Since: 44.00

Reimplemented from xpress::objects::QuadExpression.

isAutoCompress()

auto xpress::objects::QuadTermList::isAutoCompress ( ) -> bool

inlinestatic

Test whether auto-compression is enabled for this class.

Returns: true if auto compression is enabled for all instances of this class.

Since: 44.00

reserve()

auto xpress::objects::QuadTermList::reserve ( int l ) -> QuadTermList&

inline

Reserve a maximum number of elements in this expression.

Parameters

l	The number of additional elements to reserve.

Returns: Always returns this instance.

Since: 44.00

reset()

auto xpress::objects::QuadTermList::reset ( ) -> QuadTermList&

inlineoverridevirtual

Clear this expression.Removes all terms and sets the constant to 0.

Returns: Always returns this.

Since: 44.00

Since: 44.00

Reimplemented from xpress::objects::QuadExpression.

setAutoCompress()

auto xpress::objects::QuadTermList::setAutoCompress ( bool compress ) -> void

inlinestatic

Enable/disable auto-compression for instances of this class.

With auto-compression disabled, any instance of this class assumes that expressions do not contain two terms with the same pair of variables.

Parameters

compress true to enable, false otherwise.

Since: 44.00

setConstant()

auto xpress::objects::QuadTermList::setConstant ( double c ) -> QuadTermList&

inlineoverridevirtual

Set the constant term in this expression.Any existing constant term will be overwritten.

Parameters

c	New constant term for this expression

Returns: Always returns this.

Since: 44.00

Since: 44.00

Reimplemented from xpress::objects::QuadExpression.

toString()

auto xpress::objects::QuadTermList::toString ( ) const -> std::string

inlineoverridevirtual

Get a string representation of this expression.

Returns: A string representing this expression.

Since: 44.00

Since: 44.00

Reimplemented from xpress::objects::Expression.

The documentation for this class was generated from the following file:

xpress_objects.hpp

© 2001-2025 Fair Isaac Corporation. All rights reserved. This documentation is the property of Fair Isaac Corporation (“FICO”). Receipt or possession of this documentation does not convey rights to disclose, reproduce, make derivative works, use, or allow others to use it except solely for internal evaluation purposes to determine whether to purchase a license to the software described in this documentation, or as otherwise set forth in a written software license agreement between you and FICO (or a FICO affiliate). Use of this documentation and the software described in it must conform strictly to the foregoing permitted uses, and no other use is permitted.

Contents

Index

Glossary

Search Results

QuadTermList

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

QuadTermList() [1/3]

QuadTermList() [2/3]

QuadTermList() [3/3]

Member Function Documentation

addConstant()

addTerm() [1/8]

addTerm() [2/8]

addTerm() [3/8]

addTerm() [4/8]

addTerm() [5/8]

addTerm() [6/8]

addTerm() [7/8]

addTerm() [8/8]

addTerms() [1/8]

addTerms() [2/8]

addTerms() [3/8]

addTerms() [4/8]

addTerms() [5/8]

addTerms() [6/8]

addTerms() [7/8]

addTerms() [8/8]

compress()

deepCopy() [1/2]

deepCopy() [2/2]

evaluate()

extract()

getConstant()

isAutoCompress()

reserve()

reset()

setAutoCompress()

setConstant()

toString()