Initializing help system before first use

LinTermList Class

A linear expression that is represented as a list of terms. Instances of this class represent a linear 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 variable. 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.LinExpression
         Optimizer.Objects.LinTermList

Namespace:   Optimizer.Objects
Assembly:  xprsdn (in xprsdn.dll) Version: 44.01.04
Syntax
C# 
public sealed class LinTermList : LinExpression

The LinTermList type exposes the following members.

Constructors
  Name Description
Public method LinTermList()
Create a new empty expression.
Public method LinTermList(Double)
Create a new expression that represents a constant term.
Public method LinTermList(Double, Int32)
Create a new expression with a constant term and an initial capacity.
Top
Methods
  Name Description
Public method AddConstant
Add a value to the constant term of this expression.
(Overrides LinExpression.AddConstant(Double).)
Public method AddTerm(LinTerm)
Add term term to this expression.
(Inherited from LinExpression.)
Public method AddTerm(Variable)
Add term 1*x to this expression. If the expression already has a coefficient for x then the old and the new coefficients will be added.
(Overrides LinExpression.AddTerm(Variable).)
Public method 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 LinExpression.AddTerm(Double, Variable).)
Public method 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 LinExpression.AddTerm(Variable, Double).)
Public method AddTerms(LinExpression)
Add another linear expression to this expression.
(Overrides LinExpression.AddTerms(LinExpression).)
Public method AddTerms(LinExpression, Double)
Add another linear expression to this expression.
(Overrides LinExpression.AddTerms(LinExpression, Double).)
Public method AddTerms(IEnumerable<Variable>, IEnumerable<Double>)
Add multiple terms to this expression. Adds the scalar product defined by the element-wise multiplication of variables and coefficients.
(Inherited from LinExpression.)
Public method Compress
Compress duplicate terms. Sorts the terms and merges any terms for the same variable into a single term.
Public method DeepCopy()
Get a deep copy of this expression.
(Overrides LinExpression.DeepCopy().)
Public method DeepCopy(Double)
Get a deep copy of this expression multiplied by a constant
(Overrides LinExpression.DeepCopy(Double).)
Public method Div(Double)
Create a new expression that represents the quotient of this and arg.
(Inherited from Expression.)
Public method Div(Expression)
Create a new expression that represents the quotient of this and arg.
(Inherited from Expression.)
Public method Eq(Double)
Create an "equals" constraint with this expression as left-hand side.
(Inherited from AbstractExpression.)
Public method Eq(Expression)
Create an "equals" constraint with this expression as left-hand side.
(Inherited from AbstractExpression.)
Public method Equals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public method 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).)
Public method Extract(Double, IPostfixExtractor)
Extract this expression into postfix notation.
(Overrides Expression.Extract(Double, IPostfixExtractor).)
Public method 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).)
Public method Geq(Double)
Create a "greater than or equal" constraint with this expression as left-hand side.
(Inherited from AbstractExpression.)
Public method Geq(Expression)
Create a "greater than or equal" constraint with this expression as left-hand side.
(Inherited from AbstractExpression.)
Public method GetConstant
Get the constant value in this expression.
(Overrides LinExpression.GetConstant().)
Public method 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.)
Public method GetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public method 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).
(Overrides AbstractExpression.GetLinearView().)
Public method 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
  • 0 for constant expressions.
  • 1 for linear expressions.
  • 2 for quadratic expressions.
  • Int32.MaxValue for function calls or formulas.
(Inherited from LinExpression.)
Public method 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).
(Inherited from LinExpression.)
Public method GetRTTI
Get runtime type identification.
(Inherited from LinExpression.)
Public method GetType
Gets the Type of the current instance.
(Inherited from Object.)
Public method In
Create a range constraint that bounds this expression from below and above.
(Inherited from AbstractExpression.)
Public methodStatic member IsAutoCompress
Test whether auto-compression is enabled for this class.
Public method Leq(Double)
Create a "less than or equal" constraint with this expression as left-hand side.
(Inherited from AbstractExpression.)
Public method Leq(Expression)
Create a "less than or equal" constraint with this expression as left-hand side.
(Inherited from AbstractExpression.)
Public method Minus(Double)
Create a new expression that represents the difference of this and arg.
(Inherited from Expression.)
Public method Minus(Expression)
Create a new expression that represents the difference of this and arg.
(Inherited from Expression.)
Public method Mul(Double)
Create a new expression that represents the product of this and arg.
(Inherited from Expression.)
Public method Mul(Expression)
Create a new expression that represents the product of this and arg.
(Inherited from Expression.)
Public method Plus(Double)
Create a new expression that represents the sum of this and arg.
(Inherited from Expression.)
Public method Plus(Expression)
Create a new expression that represents the sum of this and arg.
(Inherited from Expression.)
Public method Reserve
Reserve a maximum number of elements in this expression.
Public method Reset
Clear this expression. Removes all terms and sets the constant to 0.
(Overrides LinExpression.Reset().)
Public methodStatic member 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 variable.
Public method SetConstant
Set the constant term in this expression. Any existing constant term will be overwritten.
(Overrides LinExpression.SetConstant(Double).)
Public method Square
Create a QuadExpression by multiplying this expression by itself.
(Inherited from LinExpression.)
Public method ToString
Returns a String that represents the current Object.
(Overrides Object.ToString().)
Public method Uminus
Create a new expression that represents the unary minus of this one.
(Inherited from Expression.)
Top
See Also
Covered Topics
Parent Topic Optimizer.Objects

© 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.