Initializing help system before first use

Inequality Methods

The Inequality type exposes the following members.

Methods
  Name Description
Public method ChgCoef
Change the coefficient for a variable in this row.
Public method ChgCoefs
Change the coefficients for multiple variables in this row.
Public method CompareTo
Compares the current object with another object of the same type.
Public method Equals
Determines whether the specified Object is equal to the current Object.
(Overrides Object.Equals(Object).)
Public method GetCallbackDual
Get the dual value value for this row from the solution associated with the current callback.

Note: This function uses under the hood.

Note: Calling this function for multiple rows is not efficient. If you need to get values for multiple rows then consider using to get the values for all rows and then use to extract the value for a particular row.

Public method GetCallbackSlack
Get the slack value for this row from the solution associated with the current callback.

Note: This function uses under the hood.

Note: Calling this function for multiple rows is not efficient. If you need to get values for multiple rows then consider using to get the values for all rows and then use to extract the value for a particular row.

Public method GetDual
Get the current dual value value for this row.

Note: This function uses under the hood. This is only valid to call if the `Optimizer.Objects.XpressProblem` instance owning this row is currently not under optimization.

Note: Calling this function for multiple rows is not efficient. If you need to get values for multiple rows then consider using to get the values for all rows and then use to extract the value for a particular row. This strategy is also valid from callbacks.

Public method GetHashCode
Serves as a hash function for a particular type.
(Overrides Object.GetHashCode().)
Public method GetIndex
Get the index that this object has in the underlying model. Attention: this is a very advanced function. Use it only if you know exactly what you are doing.
Public method GetIndexForProb
Get the index stored in this object but raise an exception if the problem that created this object is not prob.
Public method GetLhs
Get the left-hand side of this inequality.
Public method GetName
Get the name of this object. Queries the problem instance that owns this object and returns the name from that instance.
Public method GetProblem
Get the problem to which this element belongs.
Public method GetRhs
Get the right-hand side for this row. Queries the Optimizer.Objects.XpressProblem instance to which this row belongs and returns the right-hand side from that instance.
Public method GetRhsRange
Get the right-hand side range for this row. Queries the Optimizer.Objects.XpressProblem instance to which this row belongs and returns the right-hand side range from that instance.
Public method GetSerial
Get the serial number of this object.
Public method GetSlack
Get the current slack value for this row.

Note: This function uses under the hood. This is only valid to call if the `Optimizer.Objects.XpressProblem` instance owning this row is currently not under optimization.

Note: Calling this function for multiple rows is not efficient. If you need to get values for multiple rows then consider using to get the values for all rows and then use to extract the value for a particular row. This strategy is also valid from callbacks.

Public method GetType
Get the type for this row. Queries the Optimizer.Objects.XpressProblem instance to which this row belongs and returns the name obtained from that instance.
Public method GetValue
Get the value of this row from an array. The function assumes that data is an array that stores a value for each row in the underlying problem and returns the value from this array that corresponds to this row. data arrays can be obtained for example from prob.GetSlacks() or prob.GetCallbackSlacks().
Public method MarkDeleted
Public method SetName
Set the name of this inequality. Sets the name of this inequality in the problem instance that owns the object.
Public method SetRhs
Set the right-hand side for this row. Set the right-hand side in the Optimizer.Objects.XpressProblem instance to which this row belongs.
Public method SetRhsRange
Set the right-hand side range for this row. Sets the right-hand side range value in the Optimizer.Objects.XpressProblem instance to which this row belongs.
Public method SetType
Set the type for this row. Set the type in the Optimizer.Objects.XpressProblem instance to which this row belongs.
Public method ToString
Returns a String that represents the current Object.
(Inherited from Object.)
Public method UpdateIndex
Add delta to this object's index.
Top
See Also
Covered Topics
Parent Topic Inequality Class

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