QuadTermList Class
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.
Inheritance Hierarchy
System.Object
Optimizer.Objects.Expression
Optimizer.Objects.AbstractExpression
Optimizer.Objects.QuadExpression
Optimizer.Objects.QuadTermList
Optimizer.Objects.Expression
Optimizer.Objects.AbstractExpression
Optimizer.Objects.QuadExpression
Optimizer.Objects.QuadTermList
Namespace: Optimizer.Objects
Assembly: xprsdn (in xprsdn.dll) Version: 44.01.01
Syntax
C#
public sealed class QuadTermList : QuadExpression
The QuadTermList type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 |
QuadTermList() |
Create a new empty expression.
|
|
QuadTermList(Double) |
Create a new expression that represents a constant term.
|
|
QuadTermList(Double, Int32) |
Create a new expression with a constant term and an initial capacity.
|
Methods
| Name | Description | |
|---|---|---|
|
AddConstant |
Add a value to the constant term of this expression.
(Overrides QuadExpression.AddConstant(Double).) |
|
AddTerm(LinTerm) |
Add
term to this expression.
(Inherited from QuadExpression.) |
|
AddTerm(QuadTerm) |
Add
term to this expression.
(Inherited from QuadExpression.) |
|
AddTerm(Variable) |
Add term
1.0*x to this expression. If the expression already has a coefficient for
x then the old and the new coefficients will be added.
(Overrides QuadExpression.AddTerm(Variable).) |
|
AddTerm(Double, Variable) |
Add a term to this expression. If the expression already has a coefficient for
variable then the old and the new coefficients will be added.
(Overrides QuadExpression.AddTerm(Double, Variable).) |
|
AddTerm(Variable, Variable) |
Add term
1.0*x1*x2 to this expression. If the expression already has a coefficient for
x then the old and the new coefficients will be added.
(Overrides QuadExpression.AddTerm(Variable, Variable).) |
|
AddTerm(Variable, Double) |
Add a term to this expression. If the expression already has a coefficient for
variable then the old and the new coefficients will be added.
(Overrides QuadExpression.AddTerm(Variable, Double).) |
|
AddTerm(Double, Variable, Variable) |
Add a term to this expression. If the expression already has a coefficient for
variable1*variable2 then the old and the new coefficients will be added.
(Overrides QuadExpression.AddTerm(Double, Variable, Variable).) |
|
AddTerm(Variable, Variable, Double) |
Add a term to this expression. If the expression already has a coefficient for
variable1*variable2 then the old and the new coefficients will be added.
(Overrides QuadExpression.AddTerm(Variable, Variable, Double).) |
|
AddTerms(LinExpression) |
Add another linear expression to this expression.
(Overrides QuadExpression.AddTerms(LinExpression).) |
|
AddTerms(QuadExpression) |
Add another quadratic expression to this expression.
(Overrides QuadExpression.AddTerms(QuadExpression).) |
|
AddTerms(LinExpression, Double) |
Add another linear expression to this expression.
(Overrides QuadExpression.AddTerms(LinExpression, Double).) |
|
AddTerms(QuadExpression, Double) |
Add another quadratic expression to this expression.
(Overrides QuadExpression.AddTerms(QuadExpression, Double).) |
|
AddTerms(IEnumerable<Variable>, IEnumerable<Double>) |
Add multiple linear terms to this expression. Adds the scalar product defined by the element-wise multiplication of
variables and
coefficients.
(Inherited from QuadExpression.) |
|
AddTerms(IEnumerable<Variable>, IEnumerable<Variable>, IEnumerable<Double>) |
Add multiple quadratic terms to this expression. Adds the scalar product defined by the element-wise multiplication of
variables1,
variables2 and
coefficients.
(Inherited from QuadExpression.) |
|
AddTerms(Variable, Double, Int32, Int32) |
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.
(Inherited from QuadExpression.) |
|
AddTerms(Variable, Variable, Double, Int32, Int32) |
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.
(Inherited from QuadExpression.) |
|
Compress |
Compress duplicate terms. Sorts the terms and merges any terms for the same variable into a single term.
|
|
DeepCopy() |
Get a deep copy of this expression.
(Overrides QuadExpression.DeepCopy().) |
|
DeepCopy(Double) |
Get a deep copy of this expression multiplied by a constant
(Overrides QuadExpression.DeepCopy(Double).) |
|
Div(Double) |
Create a new expression that represents the quotient of
this and
arg.
(Inherited from Expression.) |
|
Div(Expression) |
Create a new expression that represents the quotient of
this and
arg.
(Inherited from Expression.) |
|
Eq(Double) |
Create an "equals" constraint with this expression as left-hand side.
(Inherited from AbstractExpression.) |
|
Eq(Expression) |
Create an "equals" constraint with this expression as left-hand side.
(Inherited from AbstractExpression.) |
|
Equals | (Inherited from Object.) |
|
Evaluate |
Compute the value of this expression with respect to the given solution Vector (which is not required to be feasible).
(Overrides Expression.Evaluate(Double).) |
|
Extract(Double, IPostfixExtractor) |
Extract this expression into postfix notation.
(Overrides Expression.Extract(Double, IPostfixExtractor).) |
|
Extract(Double, XPRSprob.RowCreator) |
Extract this expression into a row. This is for internal use only, you should never have to call this function explicitly.
(Overrides Expression.Extract(Double, XPRSprob.RowCreator).) |
|
Geq(Double) |
Create a "greater than or equal" constraint with this expression as left-hand side.
(Inherited from AbstractExpression.) |
|
Geq(Expression) |
Create a "greater than or equal" constraint with this expression as left-hand side.
(Inherited from AbstractExpression.) |
|
GetConstant |
Get the constant value in this expression.
(Overrides QuadExpression.GetConstant().) |
|
GetConstantView |
Get the constant value to which this expression evaluates. If this expression can be treated as a constant value then the function returns the constant value. If the expression cannot be treated as a constant then an exception is raised. In order to test whether the expression can be treated as constant, use function .GetMaxDegree() and check whether it returns 0.
(Inherited from AbstractExpression.) |
|
GetHashCode |
Serves as a hash function for a particular type.
(Inherited from Object.) |
|
GetLinearView |
Get a linear read-only view on this expression. If this expression can be treated as a linear expression then the function returns a readonly view on the linear terms (including the constant term if there is any). If the expression cannot be treated as a linear expression then an exception is raised. In order to test this expression can be treated as linear, use function .GetMaxDegree() and check whether it returns 0 or 1. In the returned
System.Collections.Generic.KeyValuePair instances the constant term is indicated with a key of Optimizer.Objects.XpressProblem.NULL_VARIABLE. Note that depending on the actual expression class and its implementation, the terms may not be presented in the same order in which you added them. There may also be multiple elements with the same key (again depending on the implementation of the actual object).
(Inherited from AbstractExpression.) |
|
GetMaxDegree |
Get the maximum degree of any of the terms/monomials that appear in the symbolic representation of all parenthesized sub-expressions are fully expanded. The maximum degree is
(Inherited from QuadExpression.)
|
|
GetQuadView |
Get a quadratic read-only view on this expression. If this expression can be treated as a quadratic expression then the function returns a readonly view on the quadratic terms (including the constant term and linear terms if there are any). If the expression cannot be treated as a linear expression then an exception is raised. In order to test this expression can be treated as quadratic, use function .GetMaxDegree() and check whether it returns 0, 1, or 2. In the returned
System.Collections.Generic.KeyValuePair instances the constant term is indicated with a key with two Optimizer.Objects.XpressProblem.NULL_VARIABLEs. Linear terms are represented by a
QPair with Optimizer.Objects.XpressProblem.NULL_VARIABLE as second variable. Note that depending on the actual expression class and its implementation, the terms may not be presented in the same order in which you added them. There may also be multiple elements with the same key (again depending on the implementation of the actual object).
(Overrides AbstractExpression.GetQuadView().) |
|
GetRTTI |
Get runtime type identification.
(Inherited from QuadExpression.) |
|
GetType |
Gets the
Type of the current instance.
(Inherited from Object.) |
|
In |
Create a range constraint that bounds this expression from below and above.
(Inherited from AbstractExpression.) |
 |
IsAutoCompress |
Test whether auto-compression is enabled for this class.
|
|
Leq(Double) |
Create a "less than or equal" constraint with this expression as left-hand side.
(Inherited from AbstractExpression.) |
|
Leq(Expression) |
Create a "less than or equal" constraint with this expression as left-hand side.
(Inherited from AbstractExpression.) |
|
Minus(Double) |
Create a new expression that represents the difference of
this and
arg.
(Inherited from Expression.) |
|
Minus(Expression) |
Create a new expression that represents the difference of
this and
arg.
(Inherited from Expression.) |
|
Mul(Double) |
Create a new expression that represents the product of
this and
arg.
(Inherited from Expression.) |
|
Mul(Expression) |
Create a new expression that represents the product of
this and
arg.
(Inherited from Expression.) |
|
Plus(Double) |
Create a new expression that represents the sum of
this and
arg.
(Inherited from Expression.) |
|
Plus(Expression) |
Create a new expression that represents the sum of
this and
arg.
(Inherited from Expression.) |
|
Reserve |
Reserve a maximum number of elements in this expression.
|
|
Reset |
Clear this expression. Removes all terms and sets the constant to 0.
(Overrides QuadExpression.Reset().) |
|
SetAutoCompress |
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.
|
|
SetConstant |
Set the constant term in this expression. Any existing constant term will be overwritten.
(Overrides QuadExpression.SetConstant(Double).) |
|
ToString | (Overrides Object.ToString().) |
|
Uminus |
Create a new expression that represents the unary minus of this one.
(Inherited from Expression.) |
See Also
Reference
© 2001-2024 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.