FLOPC++
|
Classes in this group are for normal modeling purposes. They are intended for consumption outside the library. More...
Classes | |
class | flopc::MP_boolean |
Reference 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 explain using pointer in – should be private? More... | |
class | flopc::MP_constraint |
Semantic 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. More... | |
class | flopc::MP_data |
Input 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 : More... | |
class | flopc::MP_domain |
Range 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. More... | |
class | flopc::MP_domain_set |
Range 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. More... | |
class | flopc::MP_domain_subset< nbr > |
Range 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. More... | |
class | flopc::MP_expression |
Symbolic 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.) More... | |
class | flopc::MP_index |
Representation 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. More... | |
class | flopc::MP_index_exp |
Representation 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: More... | |
class | flopc::Messenger |
Inteface 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. More... | |
class | flopc::MP_model |
This 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: More... | |
class | flopc::MP_set |
Representation 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. More... | |
class | flopc::MP_variable |
Symantic 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. More... | |
class | flopc::MP_binary_variable |
Functions | |
void | flopc::forall (const MP_domain &d, const Functor &f) |
Global function for performing a Functor on each member of a MP_domain. More... | |
void | flopc::forall (const Functor &f) |
Global function for performing a Functor without having a set to operate on. More... | |
void | flopc::operator<<= (const MP_domain &s, const MP_domain &d) |
Global function which copies members of MP_domain d into another (possibly non-empty) MP_domain. More... | |
void | flopc::minimize (const MP_expression &obj) |
This is one of the main entry points for executionThis calls the OsiSolverInterface to execute the solver with the objective of MINIMIZING the argment MP_expression. More... | |
void | flopc::minimize_max (MP_set &d, const MP_expression &obj) |
This is one of the main entry points for executionThis calls the OsiSolverInterface to execute the solver with the objective of MINIMIZING THE MAXIMUM of the MP_expression evaluation of the MP_set. More... | |
void | flopc::maximize (const MP_expression &obj) |
This is one of the main entry points for executionThis calls the OsiSolverInterface to execute the solver with the objective of MAXIMIZING of the MP_expression. More... | |
MP_boolean | flopc::operator! (const MP_boolean &b) |
For computing the logical negation of a booleanThis is used in the normal formation of an expression. More... | |
MP_boolean | flopc::operator&& (const MP_boolean &e1, const MP_boolean &e2) |
For computing the logical AND of two booleansThis is used in the normal formation of an expression. More... | |
MP_boolean | flopc::operator|| (const MP_boolean &e1, const MP_boolean &e2) |
For computing the logical OR of two booleansThis is used in the normal formation of an expression. More... | |
MP_boolean | flopc::alltrue (const MP_domain &d, const MP_boolean &b) |
boolean which returns true if all in domain evaluate to true.This is used in the normal formation of an expression. More... | |
MP_boolean | flopc::operator<= (const MP_index_exp &e1, const MP_index_exp &e2) |
constructs a boolean evaluator using operator overloadingThis is used in the normal formation of an expression. This is useful when combining index expressions. More... | |
MP_boolean | flopc::operator<= (const Constant &e1, const Constant &e2) |
constructs a boolean evaluator by comparing two constants.This is used in the normal formation of an expression. This utility of this is when comparing constants More... | |
MP_boolean | flopc::operator< (const MP_index_exp &e1, const MP_index_exp &e2) |
constructs a boolean evaluator using operator overloadingThis is used in the normal formation of an expression. This is useful when combining index expressions. More... | |
MP_boolean | flopc::operator< (const Constant &e1, const Constant &e2) |
constructs a boolean evaluator by comparing two constants.This is used in the normal formation of an expression. This utility of this is when comparing constants More... | |
MP_boolean | flopc::operator>= (const MP_index_exp &e1, const MP_index_exp &e2) |
constructs a boolean evaluator using operator overloadingThis is used in the normal formation of an expression. This is useful when combining index expressions. More... | |
MP_boolean | flopc::operator>= (const Constant &e1, const Constant &e2) |
constructs a boolean evaluator by comparing two constants.This is used in the normal formation of an expression. This utility of this is when comparing constants More... | |
MP_boolean | flopc::operator> (const MP_index_exp &e1, const MP_index_exp &e2) |
constructs a boolean evaluator using operator overloadingThis is used in the normal formation of an expression. This is useful when combining index expressions. More... | |
MP_boolean | flopc::operator> (const Constant &e1, const Constant &e2) |
constructs a boolean evaluator by comparing two constants.This is used in the normal formation of an expression. This utility of this is when comparing constants More... | |
MP_boolean | flopc::operator== (const MP_index_exp &e1, const MP_index_exp &e2) |
constructs a boolean evaluator using operator overloadingThis is used in the normal formation of an expression. This is useful when combining index expressions. More... | |
MP_boolean | flopc::operator== (const Constant &e1, const Constant &e2) |
constructs a boolean evaluator by comparing two constants.This is used in the normal formation of an expression. This utility of this is when comparing constants More... | |
MP_boolean | flopc::operator!= (const MP_index_exp &e1, const MP_index_exp &e2) |
constructs a boolean evaluator using operator overloadingThis is used in the normal formation of an expression. This is useful when combining index expressions. More... | |
MP_boolean | flopc::operator!= (const Constant &e1, const Constant &e2) |
constructs a boolean evaluator by comparing two constants.This is used in the normal formation of an expression. This utility of this is when comparing constants More... | |
Constant | flopc::abs (const Constant &c) |
for computing the absolute value of a constant value.This is used in the normal formation of an expression such as abs(-5) More... | |
Constant | flopc::pos (const Constant &c) |
for returning non-negative value of the constant.This is used in the formation of an expression. It is used to return a non-negative value.. More... | |
Constant | flopc::ceil (const Constant &c) |
The ceiling integral value of the input constant.This is used in the formation of an expression. It is used to "round up" a numeric constant which is potentially non-integer. More... | |
Constant | flopc::floor (const Constant &c) |
The floor integral value of the input constant.This is used in the formation of an expression. It is used to "truncate" a numeric constant which is potentially non-integer. More... | |
Constant | flopc::minimum (const Constant &a, const Constant &b) |
Returns the smaller of two constants.This is used in the formation of an expression. More... | |
Constant | flopc::maximum (const Constant &a, const Constant &b) |
Returns the larger of two constants.This is used in the formation of an expression. More... | |
Constant | flopc::operator+ (const Constant &a, const Constant &b) |
Returns the sum of two constants.This is used in the formation of an expression. More... | |
Constant | flopc::operator- (const Constant &a, const Constant &b) |
Returns the difference of two constants.This is used in the formation of an expression. More... | |
Constant | flopc::operator* (const Constant &a, const Constant &b) |
Returns the product of two constants.This is used in the formation of an expression. More... | |
Constant | flopc::operator/ (const Constant &a, const Constant &b) |
Returns the quotient of two constants.This is used in the formation of an expression. More... | |
Constant | flopc::maximum (const MP_domain &i, const Constant &e) |
Returns the maximum over the domain of the constant. More... | |
Constant | flopc::minimum (const MP_domain &i, const Constant &e) |
Returns the sum of two constants. More... | |
Constant | flopc::sum (const MP_domain &i, const Constant &e) |
Returns the sum of two constants. More... | |
Constant | flopc::product (const MP_domain &i, const Constant &e) |
Returns the sum of two constants. More... | |
Constraint | flopc::operator<= (const MP_expression &l, const MP_expression &r) |
Uses operator overloading to construct an ConstraintConstucts a Constraint using operator overloading. More... | |
Constraint | flopc::operator<= (const Constant &l, const MP_expression &r) |
Uses operator overloading to construct an ConstraintConstucts a Constraint using operator overloading. More... | |
Constraint | flopc::operator<= (const MP_expression &l, const Constant &r) |
Uses operator overloading to construct an ConstraintConstucts a Constraint using operator overloading. More... | |
Constraint | flopc::operator<= (const VariableRef &l, const VariableRef &r) |
Uses operator overloading to construct an ConstraintConstucts a Constraint using operator overloading. More... | |
Constraint | flopc::operator>= (const MP_expression &l, const MP_expression &r) |
Uses operator overloading to construct an ConstraintConstucts a Constraint using operator overloading. More... | |
Constraint | flopc::operator>= (const Constant &l, const MP_expression &r) |
Uses operator overloading to construct an ConstraintConstucts a Constraint using operator overloading. More... | |
Constraint | flopc::operator>= (const MP_expression &l, const Constant &r) |
Uses operator overloading to construct an ConstraintConstucts a Constraint using operator overloading. More... | |
Constraint | flopc::operator>= (const VariableRef &l, const VariableRef &r) |
Uses operator overloading to construct an ConstraintConstucts a Constraint using operator overloading. More... | |
Constraint | flopc::operator== (const MP_expression &l, const MP_expression &r) |
Uses operator overloading to construct an ConstraintConstucts a Constraint using operator overloading. More... | |
Constraint | flopc::operator== (const Constant &l, const MP_expression &r) |
Uses operator overloading to construct an ConstraintConstucts a Constraint using operator overloading. More... | |
Constraint | flopc::operator== (const MP_expression &l, const Constant &r) |
Uses operator overloading to construct an ConstraintConstucts a Constraint using operator overloading. More... | |
Constraint | flopc::operator== (const VariableRef &l, const VariableRef &r) |
Uses operator overloading to construct an ConstraintConstucts a Constraint using operator overloading. More... | |
Classes in this group are for normal modeling purposes. They are intended for consumption outside the library.
for computing the absolute value of a constant value.This is used in the normal formation of an expression such as abs(-5)
Definition at line 53 of file MP_constant.cpp.
MP_boolean flopc::alltrue | ( | const MP_domain & | d, |
const MP_boolean & | b | ||
) |
boolean which returns true if all in domain evaluate to true.This is used in the normal formation of an expression.
d | MP_domain to evaluate with |
b | boolean expression to evaluate. |
Definition at line 152 of file MP_boolean.cpp.
The ceiling integral value of the input constant.This is used in the formation of an expression. It is used to "round up" a numeric constant which is potentially non-integer.
c | is a constant |
Definition at line 84 of file MP_constant.cpp.
Referenced by flopc::Constant_ceil::evaluate().
The floor integral value of the input constant.This is used in the formation of an expression. It is used to "truncate" a numeric constant which is potentially non-integer.
c | is a constant |
Definition at line 97 of file MP_constant.cpp.
Referenced by flopc::Constant_floor::evaluate().
|
inline |
Global function for performing a Functor on each member of a MP_domain.
Definition at line 55 of file flopc.hpp.
References flopc::MP_domain::Forall().
Referenced by flopc::forall().
|
inline |
Global function for performing a Functor without having a set to operate on.
Definition at line 64 of file flopc.hpp.
References flopc::forall(), and flopc::MP_domain::getEmpty().
|
inline |
This is one of the main entry points for executionThis calls the OsiSolverInterface to execute the solver with the objective of MAXIMIZING of the MP_expression.
Definition at line 107 of file flopc.hpp.
References flopc::MP_model::getDefaultModel(), and flopc::MP_model::maximize().
Returns the larger of two constants.This is used in the formation of an expression.
a | first constant |
b | second constant |
Definition at line 129 of file MP_constant.cpp.
Returns the maximum over the domain of the constant.
i | MP_domain used in evaluation |
e | constant |
Definition at line 272 of file MP_constant.cpp.
|
inline |
This is one of the main entry points for executionThis calls the OsiSolverInterface to execute the solver with the objective of MINIMIZING the argment MP_expression.
Definition at line 83 of file flopc.hpp.
References flopc::MP_model::getDefaultModel(), and flopc::MP_model::minimize().
|
inline |
This is one of the main entry points for executionThis calls the OsiSolverInterface to execute the solver with the objective of MINIMIZING THE MAXIMUM of the MP_expression evaluation of the MP_set.
Definition at line 96 of file flopc.hpp.
References flopc::MP_model::getDefaultModel(), and flopc::MP_model::minimize_max().
Returns the smaller of two constants.This is used in the formation of an expression.
a | first constant |
b | second constant |
Definition at line 116 of file MP_constant.cpp.
Returns the sum of two constants.
i | MP_domain used in evaluation |
e | second constant |
Definition at line 275 of file MP_constant.cpp.
MP_boolean flopc::operator! | ( | const MP_boolean & | b | ) |
For computing the logical negation of a booleanThis is used in the normal formation of an expression.
b | boolean |
Definition at line 156 of file MP_boolean.cpp.
MP_boolean flopc::operator!= | ( | const MP_index_exp & | e1, |
const MP_index_exp & | e2 | ||
) |
constructs a boolean evaluator using operator overloadingThis is used in the normal formation of an expression. This is useful when combining index expressions.
e1 | is an index expression involving an MP_index |
e2 | second index expression
|
Definition at line 192 of file MP_boolean.cpp.
MP_boolean flopc::operator!= | ( | const Constant & | e1, |
const Constant & | e2 | ||
) |
constructs a boolean evaluator by comparing two constants.This is used in the normal formation of an expression. This utility of this is when comparing constants
e1 | first constant expression |
e2 | second constant expression |
Definition at line 198 of file MP_boolean.cpp.
MP_boolean flopc::operator&& | ( | const MP_boolean & | e1, |
const MP_boolean & | e2 | ||
) |
For computing the logical AND of two booleansThis is used in the normal formation of an expression.
e1 | first boolean |
e2 | second boolean |
Definition at line 159 of file MP_boolean.cpp.
Returns the product of two constants.This is used in the formation of an expression.
a | first constant |
b | second constant |
Definition at line 177 of file MP_constant.cpp.
Returns the sum of two constants.This is used in the formation of an expression.
a | first constant |
b | second constant |
Definition at line 143 of file MP_constant.cpp.
Returns the difference of two constants.This is used in the formation of an expression.
a | first constant |
b | second constant |
Definition at line 160 of file MP_constant.cpp.
Returns the quotient of two constants.This is used in the formation of an expression.
a | first constant |
b | second constant |
Definition at line 190 of file MP_constant.cpp.
MP_boolean flopc::operator< | ( | const MP_index_exp & | e1, |
const MP_index_exp & | e2 | ||
) |
constructs a boolean evaluator using operator overloadingThis is used in the normal formation of an expression. This is useful when combining index expressions.
e1 | is an index expression involving an MP_index |
e2 | second index expression
|
Definition at line 171 of file MP_boolean.cpp.
MP_boolean flopc::operator< | ( | const Constant & | e1, |
const Constant & | e2 | ||
) |
constructs a boolean evaluator by comparing two constants.This is used in the normal formation of an expression. This utility of this is when comparing constants
e1 | first constant expression |
e2 | second constant expression |
Definition at line 174 of file MP_boolean.cpp.
|
inline |
Global function which copies members of MP_domain d into another (possibly non-empty) MP_domain.
Definition at line 72 of file flopc.hpp.
References flopc::MP_domain::Forall().
|
inline |
Uses operator overloading to construct an ConstraintConstucts a Constraint using operator overloading.
Definition at line 69 of file MP_constraint.hpp.
References flopc::LE.
|
inline |
Uses operator overloading to construct an ConstraintConstucts a Constraint using operator overloading.
Definition at line 77 of file MP_constraint.hpp.
References flopc::operator<=().
|
inline |
Uses operator overloading to construct an ConstraintConstucts a Constraint using operator overloading.
Definition at line 85 of file MP_constraint.hpp.
References flopc::operator<=().
|
inline |
Uses operator overloading to construct an ConstraintConstucts a Constraint using operator overloading.
Definition at line 93 of file MP_constraint.hpp.
References flopc::LE.
MP_boolean flopc::operator<= | ( | const MP_index_exp & | e1, |
const MP_index_exp & | e2 | ||
) |
constructs a boolean evaluator using operator overloadingThis is used in the normal formation of an expression. This is useful when combining index expressions.
e1 | is an index expression involving an MP_index |
e2 | second index expression
|
The brief code below is a bit contrived, but the right hand side illustrate the utility of combining an index expression. MP_index i;
MP_index j;
MP_boolean &b = (i+5)<=(j);
Definition at line 165 of file MP_boolean.cpp.
Referenced by flopc::operator<=().
MP_boolean flopc::operator<= | ( | const Constant & | e1, |
const Constant & | e2 | ||
) |
constructs a boolean evaluator by comparing two constants.This is used in the normal formation of an expression. This utility of this is when comparing constants
e1 | first constant expression |
e2 | second constant expression |
Definition at line 168 of file MP_boolean.cpp.
|
inline |
Uses operator overloading to construct an ConstraintConstucts a Constraint using operator overloading.
Definition at line 135 of file MP_constraint.hpp.
References flopc::EQ.
|
inline |
Uses operator overloading to construct an ConstraintConstucts a Constraint using operator overloading.
Definition at line 143 of file MP_constraint.hpp.
References flopc::operator==().
|
inline |
Uses operator overloading to construct an ConstraintConstucts a Constraint using operator overloading.
Definition at line 151 of file MP_constraint.hpp.
References flopc::operator==().
|
inline |
Uses operator overloading to construct an ConstraintConstucts a Constraint using operator overloading.
Definition at line 159 of file MP_constraint.hpp.
References flopc::EQ.
MP_boolean flopc::operator== | ( | const MP_index_exp & | e1, |
const MP_index_exp & | e2 | ||
) |
constructs a boolean evaluator using operator overloadingThis is used in the normal formation of an expression. This is useful when combining index expressions.
e1 | is an index expression involving an MP_index |
e2 | second index expression
|
Definition at line 189 of file MP_boolean.cpp.
Referenced by flopc::operator==().
MP_boolean flopc::operator== | ( | const Constant & | e1, |
const Constant & | e2 | ||
) |
constructs a boolean evaluator by comparing two constants.This is used in the normal formation of an expression. This utility of this is when comparing constants
e1 | first constant expression |
e2 | second constant expression |
Definition at line 195 of file MP_boolean.cpp.
MP_boolean flopc::operator> | ( | const MP_index_exp & | e1, |
const MP_index_exp & | e2 | ||
) |
constructs a boolean evaluator using operator overloadingThis is used in the normal formation of an expression. This is useful when combining index expressions.
e1 | is an index expression involving an MP_index |
e2 | second index expression
|
Definition at line 183 of file MP_boolean.cpp.
MP_boolean flopc::operator> | ( | const Constant & | e1, |
const Constant & | e2 | ||
) |
constructs a boolean evaluator by comparing two constants.This is used in the normal formation of an expression. This utility of this is when comparing constants
e1 | first constant expression |
e2 | second constant expression |
Definition at line 186 of file MP_boolean.cpp.
|
inline |
Uses operator overloading to construct an ConstraintConstucts a Constraint using operator overloading.
Definition at line 102 of file MP_constraint.hpp.
References flopc::GE.
|
inline |
Uses operator overloading to construct an ConstraintConstucts a Constraint using operator overloading.
Definition at line 110 of file MP_constraint.hpp.
References flopc::operator>=().
|
inline |
Uses operator overloading to construct an ConstraintConstucts a Constraint using operator overloading.
Definition at line 118 of file MP_constraint.hpp.
References flopc::operator>=().
|
inline |
Uses operator overloading to construct an ConstraintConstucts a Constraint using operator overloading.
Definition at line 126 of file MP_constraint.hpp.
References flopc::GE.
MP_boolean flopc::operator>= | ( | const MP_index_exp & | e1, |
const MP_index_exp & | e2 | ||
) |
constructs a boolean evaluator using operator overloadingThis is used in the normal formation of an expression. This is useful when combining index expressions.
e1 | is an index expression involving an MP_index |
e2 | second index expression
|
Definition at line 177 of file MP_boolean.cpp.
Referenced by flopc::operator>=().
MP_boolean flopc::operator>= | ( | const Constant & | e1, |
const Constant & | e2 | ||
) |
constructs a boolean evaluator by comparing two constants.This is used in the normal formation of an expression. This utility of this is when comparing constants
e1 | first constant expression |
e2 | second constant expression |
Definition at line 180 of file MP_boolean.cpp.
MP_boolean flopc::operator|| | ( | const MP_boolean & | e1, |
const MP_boolean & | e2 | ||
) |
For computing the logical OR of two booleansThis is used in the normal formation of an expression.
e1 | first boolean |
e2 | second boolean |
Definition at line 162 of file MP_boolean.cpp.
for returning non-negative value of the constant.This is used in the formation of an expression. It is used to return a non-negative value..
c | an imput constant |
Definition at line 71 of file MP_constant.cpp.
Referenced by flopc::MP_subset< nbr >::evaluate(), flopc::SubsetRef< nbr >::evaluate(), flopc::MP_subset< nbr >::insert(), and flopc::MP_subset< nbr >::operator()().
Returns the sum of two constants.
i | MP_domain used in evaluation |
e | constant |
Definition at line 281 of file MP_constant.cpp.