This is an abstract base class for subproblem data to be stored in a tree node. More...
#include <AlpsNodeDesc.h>
Inheritance diagram for AlpsNodeDesc:
Collaboration diagram for AlpsNodeDesc:
Public Member Functions | |
Constructor and Destructor. | |
| AlpsNodeDesc () | |
| Default constructor. More... | |
| AlpsNodeDesc (AlpsKnowledgeBroker *broker) | |
| virtual | ~AlpsNodeDesc () |
| Destructor. More... | |
Encode/Decode inherited from #AlpsKnowledge. | |
| virtual AlpsReturnStatus | encode (AlpsEncoded *encoded) const |
| Pack this node description into the given AlpsEncoded object. More... | |
| virtual AlpsReturnStatus | decodeToSelf (AlpsEncoded &encoded) |
| Unpack fields from the given AlpsEncoded object. More... | |
| AlpsEncoded * | encode () const |
| Pack this into an AlpsEncoded object and return a pointer to it. More... | |
| virtual AlpsReturnStatus | encode (AlpsEncoded *encoded) const |
| Pack this into an AlpsEncoded object and return a pointer to it. More... | |
| Public Member Functions inherited from AlpsKnowledge | |
| AlpsKnowledge () | |
| Default constructor. More... | |
| AlpsKnowledge (AlpsKnowledgeType type) | |
| AlpsKnowledge (AlpsKnowledgeType type, AlpsKnowledgeBroker *broker) | |
| virtual | ~AlpsKnowledge () |
| Destructor. More... | |
| AlpsKnowledgeType | getType () const |
| Get knowledge type. More... | |
| void | setType (AlpsKnowledgeType t) |
| Set knowledge type. More... | |
| AlpsKnowledgeBroker * | broker () |
| Get pointer to the knowledge broker. More... | |
| const AlpsKnowledgeBroker * | broker () const |
| Get pointer to the knowledge broker. More... | |
| void | setBroker (AlpsKnowledgeBroker *broker) |
| Set knowledge broker. More... | |
| AlpsEncoded * | encode () const |
| Encode the content of this into an AlpsEncoded object and return a pointer to it. More... | |
| virtual AlpsKnowledge * | decode (AlpsEncoded &encoded) const =0 |
| Decode the given AlpsEncoded object into a new AlpsKnowledge object and return a pointer to it. More... | |
Additional Inherited Members | |
| Public Attributes inherited from AlpsKnowledge | |
| AlpsKnowledgeBroker * | broker_ |
Detailed Description
This is an abstract base class for subproblem data to be stored in a tree node.
An instance of this class is a member in AlpsTreeNode.
AlpsTreeNode keeps data related to node's position within the tree and AlpsNodeDesc holds data directly related to the corresponding subproblem. This design is prefered due to its simplicity and convenience of separating subproblem data from tree search related data.
Definition at line 45 of file AlpsNodeDesc.h.
Constructor & Destructor Documentation
◆ AlpsNodeDesc() [1/2]
|
inline |
Default constructor.
Definition at line 50 of file AlpsNodeDesc.h.
◆ AlpsNodeDesc() [2/2]
|
inline |
Definition at line 51 of file AlpsNodeDesc.h.
◆ ~AlpsNodeDesc()
|
inlinevirtual |
Destructor.
Definition at line 53 of file AlpsNodeDesc.h.
Member Function Documentation
◆ encode() [1/3]
|
inlinevirtual |
Pack this node description into the given AlpsEncoded object.
Reimplemented from AlpsKnowledge.
Reimplemented in AbcNodeDesc, AbcNodeDesc, AbcNodeDesc, and KnapNodeDesc.
Definition at line 61 of file AlpsNodeDesc.h.
◆ decodeToSelf()
|
inlinevirtual |
Unpack fields from the given AlpsEncoded object.
Reimplemented from AlpsKnowledge.
Reimplemented in AbcNodeDesc, AbcNodeDesc, AbcNodeDesc, and KnapNodeDesc.
Definition at line 65 of file AlpsNodeDesc.h.
◆ encode() [2/3]
| AlpsEncoded* AlpsKnowledge::encode |
Pack this into an AlpsEncoded object and return a pointer to it.
◆ encode() [3/3]
| virtual AlpsReturnStatus AlpsKnowledge::encode |
Pack this into an AlpsEncoded object and return a pointer to it.
The documentation for this class was generated from the following file:
- /home/ted/Projects/Alps/Alps/src/AlpsNodeDesc.h
