Initializing help system before first use

XPRSprob.ConstraintCreator Class

Class to buffer constraints and create them in chunks.
Inheritance Hierarchy
System.Object
   Optimizer.XPRSprob.RowCreator
     Optimizer.XPRSprob.ConstraintCreator

Namespace:   Optimizer
Assembly:  xprsdn (in xprsdn.dll) Version: 44.01.01
Syntax
C#
public sealed class ConstraintCreator : XPRSprob.RowCreator

The XPRSprob.ConstraintCreator type exposes the following members.

Constructors
  Name Description
Public method XPRSprob.ConstraintCreator(XPRSprob, Boolean, String)
Create a new creator with default buffer sizes.
Public method XPRSprob.ConstraintCreator(XPRSprob, Int32, Int32, Boolean, String)
Create a new creator with specified buffers sizes.
Top
Methods
  Name Description
Public method AddGeneralConstraint
Add a general constraint in a single shot.
Public method AddNonzero(Int32, Double)
Add a single non-zero to the current row.
(Inherited from XPRSprob.RowCreator.)
Public method AddNonzero(Int32, Int32, Double)
Add a single quadratic non-zero to the current row. Note: The information is passed to the low-level API as is! Check the C reference documentation for how constraints are represented there. In particular, check whether off-diagonal elements may have to be doubled or halved.
(Inherited from XPRSprob.RowCreator.)
Public method AddNonzeros
Add coefficients to the current row.
(Inherited from XPRSprob.RowCreator.)
Public method AddPWL
Add a piecewise linear constraint.
Public method AddRhs
Add a value to the right-hand side of the current row.
(Inherited from XPRSprob.RowCreator.)
Public method AddRow
Add a row in a single shot.
(Inherited from XPRSprob.RowCreator.)
Public method AddSet
Add a new SOS constraint.
Public method AddToken
Append a token to this extractor.
(Inherited from XPRSprob.RowCreator.)
Public method ApplyRange
Apply a range constraint to the row that is currently built. The function assumes that the right-hand side has already been setup. It is an error to modify type or right-hand side of the current row after calling this function.
(Inherited from XPRSprob.RowCreator.)
Public method CheckForVariables
Check whether referencing Variable instances should raise an exception. If it should, then raise the required exception. The text in this exception is the errorIfVariables field that was passed to the constructor.
(Inherited from XPRSprob.RowCreator.)
Public method Commit
Flush all buffers.
(Overrides XPRSprob.RowCreator.Commit().)
Public method ConditionalCommit
Check whether buffers are very big and need committing. If the buffer sizes exceed the thresholds then call commit.
(Overrides XPRSprob.RowCreator.ConditionalCommit().)
Public method DereferenceVariable
Derefence a value. Converts a variable object into a variable index. This is different from x.GetIndex() as it also checks whether the problem for which we are extracting the current formula is currently in a state in which variables can be Dereferenced (i.e. not in a callback and not in a presolved state). If it is not then an exception is raised.
(Inherited from XPRSprob.RowCreator.)
Public method EndExpression
Signal that a (sub)expression has been extracted.
(Inherited from XPRSprob.RowCreator.)
Public method Equals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public method FinishRow
Tell this instance that all data for the current rows has been added. This calls ConditionalCommit().
(Inherited from XPRSprob.RowCreator.)
Public method GetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public method GetPostfixExtractor
Get a IPostfixExtractor that can extract formulas into this RowCreator.
(Inherited from XPRSprob.RowCreator.)
Public method GetRowCount
Get the current row count, including buffered rows that are not yet committed.
(Inherited from XPRSprob.RowCreator.)
Public method GetType
Gets the Type of the current instance.
(Inherited from Object.)
Public method NormalizeCurrentRow
Sort and merge duplicates in the current row. Must be called before FinishRow() is called.
(Inherited from XPRSprob.RowCreator.)
Public method SetName
Set the name of the current row.
(Inherited from XPRSprob.RowCreator.)
Public method SetType
Set the type of the current row.
(Inherited from XPRSprob.RowCreator.)
Public method StartExpression
(Inherited from XPRSprob.RowCreator.)
Public method ToString
Returns a String that represents the current Object.
(Inherited from Object.)
Public method Undo
Undo all changes ever done by this instance. The creator should not be used after calling this function.
(Overrides XPRSprob.RowCreator.Undo().)
Top
Fields
  Name Description
Public field colinds
Non-zero indices.
(Inherited from XPRSprob.RowCreator.)
Public field created
The number of rows this instance created.
(Inherited from XPRSprob.RowCreator.)
Public field firstRow
objects.Index of first row this instance will create.
(Inherited from XPRSprob.RowCreator.)
Public field formulaRows
Indices of rows that contain formulas. This can be null if no formulas have been collected so far.
(Inherited from XPRSprob.RowCreator.)
Public field prob
The problem instance to which things are added.
(Inherited from XPRSprob.RowCreator.)
Public field qcoef
Value of quadratic non-zero triplets. This may be null if there are no quadratic triples.
(Inherited from XPRSprob.RowCreator.)
Public field qind1
First variable of quadratic non-zero triplets. This may be null if there are no quadratic triples.
(Inherited from XPRSprob.RowCreator.)
Public field qind2
Second variable of quadratic non-zero triplets. This may be null if there are no quadratic triples.
(Inherited from XPRSprob.RowCreator.)
Public field rhsvals
Inequality right-hand side value. This is always one element more than the number of rows actually completed so far.
(Inherited from XPRSprob.RowCreator.)
Public field rowcoefs
Non-zero coefficients.
(Inherited from XPRSprob.RowCreator.)
Public field start
Inequality starting offsets. This is always one element more than the number of rows actually completed so far.
(Inherited from XPRSprob.RowCreator.)
Top
See Also

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