AlpsTreeNode Class Reference

This class holds one node of the search tree. More...

#include <AlpsTreeNode.h>

Inheritance diagram for AlpsTreeNode:

[legend]Collaboration diagram for AlpsTreeNode:


Public Member Functions
	AlpsTreeNode ()
virtual	~AlpsTreeNode ()
bool	operator< (const AlpsTreeNode &compNode)
AlpsNodeDesc *	modifyDesc ()
	Access the desc so that can modify it.
AlpsNodeDesc *	getDesc () const
void	setDesc (AlpsNodeDesc *desc)
AlpsKnowledgeBroker *	getKnowledgeBroker () const
	Functions to access/set the knwoledge broker.
void	setKnowledgeBroker (AlpsKnowledgeBroker *kb)
virtual AlpsTreeNode *	createNewTreeNode (AlpsNodeDesc *&desc) const =0
	The purpose of this function is be able to create the children of a node after branching.
void	removeChild (AlpsTreeNode *&child)
	Remove the pointer to given child from the list of children.
void	addChild (AlpsTreeNode *&child)
	Add a child to the list of children for this node.
void	removeDescendants ()
	Removes all the descendants of the node.

AlpsNodeStatus	getStatus () const
	Query/set the current status.
void	setStatus (const AlpsNodeStatus stat)
	Query/set the current status.

bool	isCandidate () const
	Query functions about specific stati.
bool	isEvaluated () const
	Query functions about specific stati.
bool	isPregnant () const
	Query functions about specific stati.
bool	isBranched () const
	Query functions about specific stati.
bool	isFathomed () const
	Query functions about specific stati.

bool	isActive () const
	Query/set node in-process indicator.
void	setActive (const bool yesno)
	Query/set node in-process indicator.

AlpsNodeIndex_t	getIndex () const
	Query/set node identifier (unique within subtree).
void	setIndex (const AlpsNodeIndex_t index)
	Query/set node identifier (unique within subtree).

int	getDepth () const
	Query/set what depth the search tree node is at.
void	setDepth (const int depth)
	Query/set what depth the search tree node is at.

double	getSolEstimate () const
	Query/set the solution estimate of the node.
void	setSolEstimate (double est)
	Query/set the solution estimate of the node.

double	getQuality () const
	Query/set the quality of the node.
void	setQuality (double quality)
	Query/set the quality of the node.

int	getNumChildren () const
	Query/set what the number of children.
void	setNumChildren (const int numChildren)
	Query/set what the number of children.
void	modifyNumChildren (const int s)
	Query/set what the number of children.

AlpsTreeNode *	getChild (const int i) const
	Query/set pointer to the ith child.
void	setChild (const int i, AlpsTreeNode *node)
	Returns a const pointer to the ith child.

AlpsTreeNode *	getParent () const
	Get/set the parent of the node.
void	setParent (AlpsTreeNode *parent)
	Get/set the parent of the node.

AlpsNodeIndex_t	getParentIndex () const
	Get/set the index of the parent of the node.
void	setParentIndex (AlpsNodeIndex_t index)
	Get/set the index of the parent of the node.

int	getExplicit () const
	Get/set the indication of whether the node has full or differencing description.
void	setExplicit (int fp)
	Get/set the indication of whether the node has full or differencing description.

virtual void	convertToExplicit ()
	Convert explicit description to difference, and vise-vesa.
virtual void	convertToRelative ()
	Convert explicit description to difference, and vise-vesa.

int	getDiving () const
	If the this node is in a diving process.
void	setDiving (const bool d)
	If the this node is in a diving process.

int	getSentMark () const
	Various marks used in parallel code.
void	setSentMark (const int tf)
	Various marks used in parallel code.
Protected Attributes
bool	active_
	Whether the node is being worked on at the moment.
AlpsNodeIndex_t	index_
	The unique index of the tree node (across the whole search tree).
int	depth_
	The depth of the node (in the whole tree -- the root is at depth 0).
double	solEstimate_
	The solution estimate.
double	quality_
	The quality of this node.
AlpsTreeNode *	parent_
	The parent of the tree node.
AlpsNodeIndex_t	parentIndex_
	The index of parent of the tree node.
int	numChildren_
	The number of children.
AlpsTreeNode **	children_
int	explicit_
	Indicate whether the node description is explicit(1) or relative(0).
AlpsNodeDesc *	desc_
	The actual description of the tree node.
AlpsNodeStatus	status_
	The current status of the node.
AlpsKnowledgeBroker *	knowledgeBroker_
	A pointer to the knowledge broker of the process where this node is processed.
int	sentMark_
	Various mark used in splitting and passing subtrees.
bool	diving_
	When processing it, if it is in the diving processing.
Private Member Functions
	AlpsTreeNode (const AlpsTreeNode &)
AlpsTreeNode &	operator= (const AlpsTreeNode &)

Detailed Description

This class holds one node of the search tree.

Note that the generic search procedure doesn't know anything about the nodes in the tree other than their index, lower bound, etc. Other application-specific data is contained in derived classes, but is not needed for the basic operation of the search tree.

Definition at line 50 of file AlpsTreeNode.h.

Constructor & Destructor Documentation

AlpsTreeNode::AlpsTreeNode ( const AlpsTreeNode & ) [private]

AlpsTreeNode::AlpsTreeNode ( ) [inline]

Definition at line 113 of file AlpsTreeNode.h.

References AlpsKnowledgeTypeNode, and AlpsKnowledge::setType().

virtual AlpsTreeNode::~AlpsTreeNode ( ) [inline, virtual]

Definition at line 136 of file AlpsTreeNode.h.

References children_, desc_, and numChildren_.

Member Function Documentation

AlpsTreeNode& AlpsTreeNode::operator= ( const AlpsTreeNode & ) [private]

bool AlpsTreeNode::operator< ( const AlpsTreeNode & compNode ) [inline]

Definition at line 151 of file AlpsTreeNode.h.

References getQuality(), and quality_.

AlpsNodeDesc* AlpsTreeNode::modifyDesc ( ) [inline]

Access the desc so that can modify it.

Definition at line 155 of file AlpsTreeNode.h.

References desc_.

AlpsNodeDesc* AlpsTreeNode::getDesc ( ) const [inline]

Definition at line 156 of file AlpsTreeNode.h.

References desc_.

void AlpsTreeNode::setDesc ( AlpsNodeDesc * desc ) [inline]

Definition at line 157 of file AlpsTreeNode.h.

References desc_.

AlpsKnowledgeBroker* AlpsTreeNode::getKnowledgeBroker ( ) const [inline]

Functions to access/set the knwoledge broker.

Definition at line 160 of file AlpsTreeNode.h.

References knowledgeBroker_.

Referenced by AbcTreeNode::AbcTreeNode(), and KnapTreeNode::KnapTreeNode().

void AlpsTreeNode::setKnowledgeBroker ( AlpsKnowledgeBroker * kb ) [inline]

Definition at line 162 of file AlpsTreeNode.h.

References knowledgeBroker_.

virtual AlpsTreeNode* AlpsTreeNode::createNewTreeNode ( AlpsNodeDesc *& desc ) const [pure virtual]

The purpose of this function is be able to create the children of a node after branching.

Implemented in AbcTreeNode, KnapTreeNode, BlisTreeNode, and BlisTreeNode.

AlpsNodeStatus AlpsTreeNode::getStatus ( ) const [inline]

Query/set the current status.

Definition at line 176 of file AlpsTreeNode.h.

References status_.

Referenced by AlpsSubTree::getNumNodes().

void AlpsTreeNode::setStatus ( const AlpsNodeStatus stat ) [inline]

Query/set the current status.

Definition at line 177 of file AlpsTreeNode.h.

References status_.

bool AlpsTreeNode::isCandidate ( ) const [inline]