Initializing help system before first use

XPRSprob.ConstraintCreator Class

Class to buffer constraints and create them in chunks.
Inheritance Hierarchy
SystemObject
   OptimizerXPRSprobRowCreator
     OptimizerXPRSprobConstraintCreator

Namespace:  Optimizer
Assembly: xprsdn (in xprsdn.dll) Version: 46.01.01+a3a330cd064168136e2506c7bff46e7bb9a4854d
Syntax
C# 
public sealed class ConstraintCreator : XPRSprobRowCreator

The XPRSprobConstraintCreator type exposes the following members.

Constructors
  Name Description
Public method XPRSprobConstraintCreator(XPRSprob, Boolean, Boolean) Create a new creator with default buffer sizes.
Public method XPRSprobConstraintCreator(XPRSprob, Int32, Int32, Boolean, Boolean) 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 XPRSprobRowCreator)
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 XPRSprobRowCreator)
Public method AddNonzeros Add coefficients to the current row.
(Inherited from XPRSprobRowCreator)
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 XPRSprobRowCreator)
Public method AddRow Add a row in a single shot.
(Inherited from XPRSprobRowCreator)
Public method AddSet Add a new SOS constraint.
Public method AddToken Append a token to this extractor.
(Inherited from XPRSprobRowCreator)
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 XPRSprobRowCreator)
Public method CheckForVariables Check whether referencing Variable instances should raise an exception. If it should, then raise the required exception.
(Inherited from XPRSprobRowCreator)
Public method Commit Flush all buffers.
(Overrides XPRSprobRowCreatorCommit)
Public method ConditionalCommit Check whether buffers are very big and need committing. If the buffer sizes exceed the thresholds then call commit.
(Overrides XPRSprobRowCreatorConditionalCommit)
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 XPRSprobRowCreator)
Public method EndExpression Signal that a (sub)expression has been extracted.
(Inherited from XPRSprobRowCreator)
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 XPRSprobRowCreator)
Public method GetHashCode Serves as the default hash function.
(Inherited from Object)
Public method GetPostfixExtractor Get a IPostfixExtractor that can extract formulas into this RowCreator.
(Inherited from XPRSprobRowCreator)
Public method GetRowCount Get the current row count, including buffered rows that are not yet committed.
(Inherited from XPRSprobRowCreator)
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 XPRSprobRowCreator)
Public methodStatic member SetInitialInequalities Set the default number of inequalities we expect a single instance of a constraint creator to create. This can be adjusted to improve memory performance.
Public methodStatic member SetInitialNonzeros Set the default number of non-zeros we expect a single instance of a constraint creator to create. This can be adjusted to improve memory performance.
Public method SetName Set the name of the current row.
(Inherited from XPRSprobRowCreator)
Public method SetType Set the type of the current row.
(Inherited from XPRSprobRowCreator)
Public method StartExpression
(Inherited from XPRSprobRowCreator)
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 XPRSprobRowCreatorUndo)
Top
Fields
  Name Description
Public field colinds Non-zero indices.
(Inherited from XPRSprobRowCreator)
Public field created The number of rows this instance created.
(Inherited from XPRSprobRowCreator)
Public field firstRow objects.Index of first row this instance will create.
(Inherited from XPRSprobRowCreator)
Public field formulaRows Indices of rows that contain formulas. This can be null if no formulas have been collected so far.
(Inherited from XPRSprobRowCreator)
Public field prob The problem instance to which things are added.
(Inherited from XPRSprobRowCreator)
Public field qcoef Value of quadratic non-zero triplets. This may be null if there are no quadratic triples.
(Inherited from XPRSprobRowCreator)
Public field qind1 First variable of quadratic non-zero triplets. This may be null if there are no quadratic triples.
(Inherited from XPRSprobRowCreator)
Public field qind2 Second variable of quadratic non-zero triplets. This may be null if there are no quadratic triples.
(Inherited from XPRSprobRowCreator)
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 XPRSprobRowCreator)
Public field rowcoefs Non-zero coefficients.
(Inherited from XPRSprobRowCreator)
Public field start Inequality starting offsets. This is always one element more than the number of rows actually completed so far.
(Inherited from XPRSprobRowCreator)
Public field types objects.Inequality types. It is assumed that this is called at least one for each row before FinishRow() is called. If you don't do that then the created row data will be off.
(Inherited from XPRSprobRowCreator)
Top
See Also
Covered Topics
Parent Topic Optimizer

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