![]() |
OR-Tools
8.2
|
Class that owns everything related to a particular optimization model.
This class is actually a fully generic wrapper that can hold any type of constraints, watchers, solvers and provide a mecanism to wire them together.
Definition at line 38 of file sat/model.h.
Public Member Functions | |
Model () | |
~Model () | |
Model (std::string name) | |
When there is more than one model in an application, it makes sense to name them for debugging or logging. More... | |
template<typename T > | |
T | Add (std::function< T(Model *)> f) |
This makes it possible to have a nicer API on the client side, and it allows both of these forms: More... | |
template<typename T > | |
T | Get (std::function< T(const Model &)> f) const |
Similar to Add() but this is const. More... | |
template<typename T > | |
T * | GetOrCreate () |
Returns an object of type T that is unique to this model (like a "local" singleton). More... | |
template<typename T > | |
const T * | Get () const |
Likes GetOrCreate() but do not create the object if it is non-existing. More... | |
template<typename T > | |
T * | Mutable () const |
Same as Get(), but returns a mutable version of the object. More... | |
template<typename T > | |
void | TakeOwnership (T *t) |
Gives ownership of a pointer to this model. More... | |
template<typename T > | |
T * | Create () |
This returns a non-singleton object owned by the model and created with the T(Model* model) constructor if it exist or the T() constructor otherwise. More... | |
template<typename T > | |
void | Register (T *non_owned_class) |
Register a non-owned class that will be "singleton" in the model. More... | |
const std::string & | Name () const |
|
inline |
Definition at line 40 of file sat/model.h.
|
inline |
Definition at line 42 of file sat/model.h.
|
inlineexplicit |
When there is more than one model in an application, it makes sense to name them for debugging or logging.
Definition at line 54 of file sat/model.h.
|
inline |
This makes it possible to have a nicer API on the client side, and it allows both of these forms:
The second form is a bit nicer for the client and it also allows to store constraints and add them later. However, the function creating the constraint is slighly more involved.
We also have a templated return value for the functions that need it like
Definition at line 81 of file sat/model.h.
|
inline |
This returns a non-singleton object owned by the model and created with the T(Model* model) constructor if it exist or the T() constructor otherwise.
It is just a shortcut to new + TakeOwnership().
Definition at line 157 of file sat/model.h.
|
inline |
Likes GetOrCreate() but do not create the object if it is non-existing.
This returns a const version of the object.
Definition at line 127 of file sat/model.h.
|
inline |
Similar to Add() but this is const.
Definition at line 87 of file sat/model.h.
|
inline |
Returns an object of type T that is unique to this model (like a "local" singleton).
This returns an already created instance or create a new one if needed using the T(Model* model) constructor if it exist or T() otherwise.
This works a bit like in a dependency injection framework and allows to really easily wire all the classes that make up a solver together. For instance a constraint can depends on the LiteralTrail, or the IntegerTrail or both, it can depend on a Watcher class to register itself in order to be called when needed and so on.
IMPORTANT: the Model* constructor functions shouldn't form a cycle between each other, otherwise this will crash the program.
Definition at line 106 of file sat/model.h.
|
inline |
Same as Get(), but returns a mutable version of the object.
Definition at line 136 of file sat/model.h.
|
inline |
Definition at line 175 of file sat/model.h.
|
inline |
Register a non-owned class that will be "singleton" in the model.
It is an error to call this on an already registered class.
Definition at line 169 of file sat/model.h.
|
inline |
Gives ownership of a pointer to this model.
It will be destroyed when the model is.
Definition at line 147 of file sat/model.h.