FLOPC++
Class List
Here are the classes, structs, unions and interfaces with brief descriptions:
[detail level 123]
 NflopcAll flopc++ code is contained within the flopc namespace
 CBoolean_and
 CBoolean_base
 CBoolean_bool
 CBoolean_Constant
 CBoolean_equal
 CBoolean_greater
 CBoolean_greaterEq
 CBoolean_less
 CBoolean_lessEq
 CBoolean_negate
 CBoolean_not_equal
 CBoolean_or
 CBoolean_SUBSETREF
 CComparison
 CConstantReference counted class for all "constant" types of data
 CConstant_abs
 CConstant_baseBase class for all "constant" types of data
 CConstant_ceil
 CConstant_div
 CConstant_double
 CConstant_exp
 CConstant_floor
 CConstant_if
 CConstant_index
 CConstant_max
 CMaxFunctor
 CConstant_max_2
 CConstant_min
 CConstant_min_2
 CConstant_minus
 CConstant_mult
 CConstant_plus
 CConstant_pos
 CConstant_product
 CConstant_sum
 CConstant_unary_minus
 CConstraint
 CConstraint_base
 CDataRefReference to a set of data
 CExpression_constant
 CExpression_div
 CExpression_minus
 CExpression_mult
 CExpression_operator
 CExpression_plus
 CExpression_sum
 CSumFunctor
 CFunctorFunction object. Often used
 CFunctor_conditional
 CHandleUtility for doing reference counted pointers
 CInsertFunctorInternal representation of a "set"
 CinsertFunctorInserter for construction of a subset
 CMessengerInteface for hooking up to internal flopc++ message handling.In more advanced use of FlopC++, it may be desirable to get access to internal calls for messages. In essence, sub-class this Messenger class, and register it with the MP_model. Also overload whichever message events you wish to handle
 CMP
 CCoef
 CCoefLess
 CGenerateFunctor
 CMP_binary_variable
 CMP_booleanReference counted class for all "boolean" types of data.This contains counters to ConstantBase pointers. These pointers may be of any of the Boolean_base * type. This can be a constant valued boolean as well. explain SUBSETREF
 CMP_constraintSemantic representation of a linear constraint.This is one of the main public interface classes. It is always constructed through operator overloading between expressions, constants, and variables. There are many 'friend' overloaded operators to do the constuction. The basic idea is to make the constraint look like a paper-model constraint in C++ code. Once constructed, it should be added to the model
 CMP_dataInput data set.This is one of the main public interface classes. It is normally directly constructed given a set of indices (domain) over which it is valid. If the data is not bound at construction, either the value() or initialize() method must be called which (deep) copies in the actual data. If one wishes to refer to external data instead rather than doing a deep copy, use the constructor which takes the value pointer as an argument. This copies the original data pointer value (rather than a deep copy).
This is used for construction of :
 CMP_domainRange over which some other constuct is defined.This is one of the main public interface classes. One uses this in the context of a constraint, objective, variable, or data. It is usually used in conjunction with an MP_set, or a subset, but can be used without one. It is the range over which the other construct is defined
 CMP_domain_baseReference to a set of index values
 CMP_domain_setRange over which some other constuct is defined.This is one of the main public interface classes. One uses this in the context of a constraint, objective, variable, or data. This class in the MP_domain family uses an MP_set and and index for defining the Range over which the construct is defined
 CMP_domain_subsetRange over which some other constuct is defined. Uses subsetting.This is one of the main public interface classes. One uses this in the context of a constraint, objective, variable, or data. This class in the MP_domain family uses an MP_subset and a vector of indexes for defining the Range over which the construct is defined
 CMP_expressionSymbolic representation of a linear expression.This is one of the main public interface classes. It is the basis for all linear expressions, including constraints, objective function, and expressions involving indexes.
Although these can be created directly and independently, it is expected these will be created through the use of the operators which are later in this file. (operator+, operator-, etc.)
 CMP_expression_baseThe base class for all expressions
 CMP_indexRepresentation of an index.This is one of the main public interface classes. It is used to iterate through, or index into an MP_domain. It is also used to share the 'current' index offsets between expressions which share an index
 CMP_index_baseInternal representation of a index
 CMP_index_constant
 CMP_index_difInternal representation of an index expression
 CMP_index_expRepresentation of an expression involving an index.This is one of the main public interface classes. It is used to create complex arrangements of index values.
Index expressions can involve:
 CMP_index_multInternal representation of an index expression
 CMP_index_subsetRef
 CMP_index_sumInternal representation of an index expression
 CMP_modelThis is the anchor point for all constructs in a FlopC++ model.The constructors take an OsiSolverInterface, and (optionally) a replacemente for the Messenger class. There are some built-in changes to the verbosity for output.
The main methods to use are:
 CMP_setRepresentation of a set for indexing into some other construct.This is one of the main public interface classes. One uses this when constructing MP_domains, and subsets. It is frequent that one would directly construct sets of indices, then use expressions to subset or slice the data
 CMP_set_baseInternal representation of a "set"
 CMP_stage
 CMP_stochastic_data
 CMP_subsetInternal representation of a "set"
 CMP_variableSymantic representation of a variable.This is one of the main public interface classes. It should be directly declared by clients of the FlopC++. The parametersof construction are MP_set s which specify the indexes over which the variable is defined
 CNamedUtility interface class for adding a string name onto a structure
 CNormalMessenger
 CRowMajor
 CSUBSETREFInternal representation of a "set"
 CSubsetRefInternal representation of a "set"
 CTerminalExpressionThe base class for all expressions
 CVariableRef
 CVerboseMessenger