Initializing help system before first use

XPRSprob.RowCreator Class

Create rows in chunks. Collects row data internally and commits data from time to time. Assumes that rows are not created in other ways while this instance is active.
Inheritance Hierarchy
System.Object
   Optimizer.XPRSprob.RowCreator
     Optimizer.XPRSprob.ConstraintCreator

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

The XPRSprob.RowCreator type exposes the following members.

Constructors
  Name Description
Public method XPRSprob.RowCreator
Create a new instance.
Top
Methods
  Name Description
Public method AddNonzero(Int32, Double)
Add a single non-zero to the current row.
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.
Public method AddNonzeros
Add coefficients to the current row.
Public method AddRhs
Add a value to the right-hand side of the current row.
Public method AddRow
Add a row in a single shot.
Public method AddToken
Append a token to this extractor.
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.
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.
Public method Commit
Flush all buffers.
Public method ConditionalCommit
Check whether buffers are very big and need committing. If the buffer sizes exceed the thresholds then call commit.
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.
Public method EndExpression
Signal that a (sub)expression has been extracted.
Public method Equals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodStatic member EstimateLinearNonzeros
Estimate the number of non-zeros that we will have to add when creating rows new rows. This can be used to compute an initial size for the rowcoef and colinds buffers.
Protected method Finalize
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
Public method FinishRow
Tell this instance that all data for the current rows has been added. This calls ConditionalCommit().
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.
Public method GetRowCount
Get the current row count, including buffered rows that are not yet committed.
Public method GetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected method MemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public method NormalizeCurrentRow
Sort and merge duplicates in the current row. Must be called before FinishRow() is called.
Public method SetName
Set the name of the current row.
Public methodStatic member SetNonzerosPerInequality
Set the estimate for number of non-zeros per row. In some cases we know how many rows we want to create but not how many non-zeros they will have. To avoid excessive reallocations this class attempts to guess the number of non-zeros that will created using the estimate set by this function. Usually you should not need to call this function but in some corner cases performance can be improved by tweaking this estimate. The function returns the previous estimate. If the function is called with a negative estimate argument then the estimate is not changed. So SetNonzerosPerInequality(-1) queris the current estimate.
Public methodStatic member SetNonzeroThreshold
Set the threshold value for non-zeros. If the number of non-zeros in the internal buffer exceeds the threshold then all rows currently in this instance are flushed to the corresponding Xpress problem instance. Usually you should not need to call this function but in rare cases performance may be improved by tweaking this value. The function returns the previous threshold value. If the threshold argument is negative then the threshold is not changed. So SetNonzeroThreshold(-1) just queries the current threshold.
Public method SetType
Set the type of the current row.
Public method StartExpression
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.
Top
Fields
  Name Description
Public field colinds
Non-zero indices.
Public field created
The number of rows this instance created.
Public field firstRow
objects.Index of first row this instance will create.
Protected field flags
Flags that indicate what properties are set on at least one row.
Public field formulaRows
Indices of rows that contain formulas. This can be null if no formulas have been collected so far.
Public fieldStatic member nonzeroThreshold
Public field prob
The problem instance to which things are added.
Public field qcoef
Value of quadratic non-zero triplets. This may be null if there are no quadratic triples.
Public field qind1
First variable of quadratic non-zero triplets. This may be null if there are no quadratic triples.
Public field qind2
Second variable of quadratic non-zero triplets. This may be null if there are no quadratic triples.
Public field rhsvals
Inequality right-hand side value. This is always one element more than the number of rows actually completed so far.
Public field rowcoefs
Non-zero coefficients.
Public field start
Inequality starting offsets. This is always one element more than the number of rows actually completed so far.
Top
See Also
Covered Topics
Parent Topic Optimizer

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