A treenode contains the bits that make up a tree pattern. More...

#include <treenode.h>

Inheritance diagram for QwTracking::treenode:

Collaboration diagram for QwTracking::treenode:

Public Member Functions
	treenode (unsigned int size)
	Default constructor. More...

	treenode (treenode &node)
	Copy-constructor from object. More...

	treenode (treenode *node)
	Copy-constructor from pointer. More...

	~treenode ()
	Destructor. More...

void	SetNext (treenode *next)
	Set the next node. More...

treenode *	GetNext () const
	Get the next node. More...

treenode *	next () const
	Get the next node (non-standard notation) More...

unsigned int	size () const
	Get size of the bit array. More...

void	Print (bool recursive=false, int indent=0)
	Print some debugging information. More...

Public Member Functions inherited from QwObjectCounter< treenode >
	QwObjectCounter ()
	Default constructor. More...

	QwObjectCounter (const QwObjectCounter &)
	Copy constructor. More...

virtual	~QwObjectCounter ()
	Destructor. More...

Data Fields
int	fMinLevel
	Minimum level at which this node is valid. More...

int	fMaxLevel
	Maximum level at which this node is valid. More...

int *	fBit
	Hit pattern, one bin specified per detector layer. More...

int	fWidth
	Width in bins of the hit pattern. More...

int	fRef
	Reference of this node when writing to file. More...

nodenode *	fSon [4]
	Each tree has four son nodes. More...

Private Attributes
treenode *	fNext
	Link to the next tree node. More...

unsigned int	fSize

Static Private Attributes
static int	fDebug = 0
	Debug level. More...

Friends
std::ostream &	operator<< (std::ostream &stream, const treenode &tn)
	Output stream operator. More...

Additional Inherited Members
Static Public Member Functions inherited from QwObjectCounter< treenode >
static size_t	GetObjectsCreated ()
	Get number of objects ever created. More...

static size_t	GetObjectsAlive ()
	Get number of objects still alive. More...

Detailed Description

A treenode contains the bits that make up a tree pattern.

This is the basic element of the tree search database when it is constructed. Each valid track has a corresponding tree node. The minimum and maximum levels of bin division are stored in the treenode.

The array fBit contains the rank of the bit that is active for this track. For example, a track that goes through (simplified) element 2 in layer 1, element 4 in layer 2, element 5 in layer 3, and element 7 in layer 4 will have the following fBit array: [2,4,6,7]. This example track will have a width of 7 - 2 + 1 = 6 (such that the track [2,2,2,2] has a width of 1).

The treenode also has a pointer to its father and a pointer to its son nodenodes. Each following generation of a treenode will have a higher bit resolution.

Definition at line 63 of file treenode.h.

Constructor & Destructor Documentation

QwTracking::treenode::treenode ( unsigned int size )

Default constructor.

Default constructor

Parameters

size	Size of the bit pattern

Definition at line 30 of file treenode.cc.

References fBit, fNext, fSize, fSon, and size().

 {
   // Set the size
   fSize = size;
   fBit = new int[fSize];
   for (unsigned int i = 0; i < fSize; i++) fBit[i] = 0;
 
   // Initialize pointers
   fNext = 0;
   for (int i = 0; i < 4; i++) fSon[i] = 0;
 }

Here is the call graph for this function:

QwTracking::treenode::treenode ( treenode & node )

Copy-constructor from object.

Copy-constructor from object

Parameters

node	Original tree node

Definition at line 46 of file treenode.cc.

References fBit, fNext, fSize, and fSon.

 {
   // Copy the node
   *this = node;
 
   // Copy the bit pattern
   fBit = new int[fSize];
   for (unsigned int i = 0; i < fSize; i++) fBit[i] = node.fBit[i];
 
   // Set the external reference link
   this->fRef = -1L;
 
   // Initialize pointers
   fNext = 0;
   for (int i = 0; i < 4; i++) fSon[i] = 0;
 }

QwTracking::treenode::treenode ( treenode * node )

Copy-constructor from pointer.

Copy-constructor from pointer

Parameters

node	Pointer to original tree node

Definition at line 67 of file treenode.cc.

References fBit, fNext, fSize, and fSon.

 {
   // Copy the node
   *this = *node;
 
   // Copy the bit pattern
   fBit = new int[fSize];
   for (unsigned int i = 0; i < fSize; i++) fBit[i] = node->fBit[i];
 
   // Set the external reference link
   this->fRef = -1L;
 
   // Initialize pointers
   fNext = 0;
   for (int i = 0; i < 4; i++) fSon[i] = 0;
 }

QwTracking::treenode::~treenode ( )

Destructor.

Destructor

Definition at line 87 of file treenode.cc.

References fBit, and fSon.

 {
   // Delete the sons
   for (int i = 0; i < 4; i++)
     if (fSon[i]) delete fSon[i];
 
   // Delete the bit pattern
   delete[] fBit;
 }

Member Function Documentation

treenode* QwTracking::treenode::GetNext ( ) const

inline

Get the next node.

Definition at line 112 of file treenode.h.

References fNext.

Referenced by QwTrackingTree::existent(), QwTrackingTree::PrintHashTable(), and QwTrackingTree::~QwTrackingTree().

112 { return fNext; };

QwTracking::treenode::fNext

treenode * fNext

Link to the next tree node.

Definition: treenode.h:100

Here is the caller graph for this function:

treenode* QwTracking::treenode::next ( ) const

inline

Get the next node (non-standard notation)

Definition at line 114 of file treenode.h.

References fNext.

Referenced by SetNext().

114 { return fNext; };

QwTracking::treenode::fNext

treenode * fNext

Link to the next tree node.

Definition: treenode.h:100

Here is the caller graph for this function:

void QwTracking::treenode::Print	(	bool	recursive = `false`,
		int	indent = `0`
	)

Print some debugging information.

Print the entire tree (descending all the way down)

Warning: This will produce a lot of screen output!

Parameters

recursive	Flag to enable recursive calls
indent	Indentation level (for recursive calls)

Definition at line 104 of file treenode.cc.

References QwLog::endl(), fSon, QwTracking::nodenode::GetTree(), Print(), QwOut, and QwWarning.

Referenced by Print(), and QwTrackingTree::PrintTree().

 {
   // Print this node
   std::string indentation;
   for (int i = 0; i < indent; i++) indentation += " ";
   QwOut << indentation << this << ": " << *this << QwLog::endl;
 
   // Bail out if too deep (probably in a loop)
   if (indent > 50) {
     QwWarning << "Tree is too deep to print, probably a self-reference somewhere" << QwLog::endl;
     return;
   }
 
   // Descend to the sons of this node
   for (int i = 0; recursive && i < 4; i++) {
     nodenode* node = this->fSon[i];
     if (node) {
       treenode* tree = node->GetTree();
       if (tree)
         tree->Print(recursive,indent+1);
     } // if (node)
 
   } // loop over sons
 }

Here is the call graph for this function:

Here is the caller graph for this function:

void QwTracking::treenode::SetNext ( treenode * next )

inline

Set the next node.

Definition at line 105 of file treenode.h.

References QwLog::endl(), fNext, next(), and QwError.

Referenced by QwTrackingTree::_inittree(), and QwTrackingTree::marklin().

                                  {
       if (next == this) {
         QwError << "Trying to link next to self" << QwLog::endl; return;
       }
       fNext = next;
     };

Here is the call graph for this function:

Here is the caller graph for this function:

unsigned int QwTracking::treenode::size ( ) const

inline

Get size of the bit array.

Definition at line 123 of file treenode.h.

References fSize.

Referenced by QwTrackingTree::QwTrackingTree(), and treenode().

123 { return fSize; };

QwTracking::treenode::fSize

unsigned int fSize

Definition: treenode.h:114

Here is the caller graph for this function:

Friends And Related Function Documentation

std::ostream& operator<<	(	std::ostream &	stream,
		const treenode &	tn
	)

friend

Output stream operator.

Stream summary info about the tree node

Parameters

stream	Stream as lhs of the operator
tn	Tree node as rhs of the operator

Returns: Stream as result of the operator

Definition at line 135 of file treenode.cc.

 {
   stream << "(" << tn.fMinLevel << "," << tn.fMaxLevel << ") ";
   for (unsigned int i = 0; i < tn.fSize; i++)
     stream << tn.fBit[i] << ",";
   stream << " width = " << tn.fWidth << ",";
   stream << " ref = " << tn.fRef;
   return stream;
 }