.NET class reference
The complete set of classes of the BCL .NET interface is summarized in the following list. For a detailed documentation of the .NET interface the reader is referred to the BCL .NET HTML NDoc that is part of the Xpress distribution (located in subdirectory docs/bcl/bcl.net/HTML of the Xpress installation directory).
- XPRB
- Initialization and general settings, definition of all parameters.
- XPRBprob
- Problem definition, including methods for creating and deleting the modeling objects, problem solving, changing settings, and retrieving solution information.
- XPRBvar
- Methods for modifying and accessing variables.
- XPRBctr
- Methods for constructing, modifying and accessing constraints.
- XPRBcut
- Methods for constructing, modifying and accessing cuts.
- XPRBsol
- Methods for constructing, modifying and accessing solutions.
- XPRBsos
- Methods for constructing, modifying and accessing Special Ordered Sets.
- XPRBindexSet
- Methods for constructing and accessing index sets and accessing set elements.
- XPRBbasis
- Methods for accessing bases.
- XPRBexpr
- Methods for constructing linear and quadratic expressions.
- XPRBrelation
- Methods for constructing linear or quadratic relations from expressions (extends XPRBexpr).
- XPRBterm
- Methods for initialisation and handling of XPRBterm objects.
- XPRBVersion
- Version number in its encoded form.
- BCLconstant
- All BCL related constants.
- BCLExceptions
- Methods for BCL Exceptions.
- Scanner
- Class for reading file data in to objects in a similar manner to scanf().
All .NET classes that have a direct correspondence with modeling objects in BCL (namely XPRBprob, XPRBvar, XPRBctr, XPRBcut, XPRBsol, XPRBsos, XPRBindexSet, XPRBbasis) take the same names, with the exception of XPRBindexSet. It is possible to obtain the Xpress Optimizer problem corresponding to a BCL .NET problem by using method getXPRSprob of class XPRBprob, please see Section Using the Optimizer with BCL .NET for further detail on using BCL with the Optimizer library.
Most of the methods of the classes with direct correspondence with C modeling objects call standard BCL C functions and return the same result codes.
Two important classes that do not correspond to any standard BCL modeling object is class XPRB that contains methods relating to the initialization and the general status of the software and class BCLconstant that contains the definition of all constant parameters. This means, any parameter with the prefix XPRB_ in standard BCL is referred to as a constant member of the .NET class BCLconstant. For example, XPRB_BV in standard BCL becomes BCLconstant.XPRB_BV in .NET.
In .NET, some additional classes have been introduced to aid the termwise definition of constraints. Linear and quadratic expressions (class XPRBexpr) are required in the definition of constraints and Special Ordered Sets. Linear or quadratic relations (class XPRBrelation), may be used as an intermediary in the definition of constraints.
A couple of other additional classes are related to error handling and data input, namely BCLExceptions which represent exceptions raised when errors occur while building constraints; and Scanner which is used internally to implement the XPRBprob.XPRBreadline and XPRBprob.XPRBreadarrline methods.
© 2001-2019 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.