BCL C library functions

A large number of routines are available within the Xpress Builder Component Library, BCL, ranging from simple routines for the creation and solution of problems to sophisticated callback functions and interaction with the Xpress Optimizer library.

In BCL, references to modeling objects (problem definitions, variables, constraints, sets, and bases) have the following types:

XPRBprob

a problem definition;

XPRBvar

a variable;

XPRBarrvar

a one-dimensional array, with elements of type XPRBvar;

XPRBctr

a constraint;

XPRBcut

a cut;

XPRBsol

a solution;

XPRBsos

a Special Ordered Set (SOS1 of SOS2);

XPRBidxset

an index set;

XPRBbasis

a basis.

Layout for function descriptions

All functions mentioned in this chapter are described under the following set of headings:

Function name

The description of each routine starts on a new page for the sake of clarity.

Purpose

A short description of the routine and its purpose begins the information section.

Synopsis

A synopsis of the syntax for usage of the routine is provided. 'Optional' arguments and flags may be specified as NULL if not required. Where this possibility exists, it will be described alongside the argument, or in the Further Information at the end of the routine's description.

Arguments

A list of arguments to the routine with a description of possible values for them follows.

Return value

A list of possible return values and their meaning.

Examples

One or two examples are provided which explain certain aspects of the routine's use.

Further information

Additional information not contained elsewhere in the routine's description is provided at the end.

Related topics

Finally a list of related routines and topics is provided for comparison and reference.