This is the base class for all hough trees. More...

#include <DynTree.h>

Inheritance diagram for DynTree< AProperties, ASubPropertiesFactory >:

Classes
class	Node
	Class for a node in the tree. More...

Public Member Functions
	DynTree (const Properties &properties, const SubPropertiesFactory &subPropertiesFactory=SubPropertiesFactory())
	Constructor taking properties with which the top node of the tree is initialised.

	DynTree (const DynTree &node)=delete
	Forbid copy construction.

DynTree &	operator= (const DynTree &)=delete
	Forbid copy assignment.

Node &	getTopNode ()
	Getter for the top node of the tree.

const Node &	getTopNode () const
	Constant getter for the top node of the tree.

int	getNNodes () const
	Gets the number of nodes currently contained in the tree Also demonstrates how to walk over the tree.

std::map< int, int >	getNNodesByLevel () const
	Gets the number of nodes by level in the tree Also demonstrates how to walk over the tree.

template<class AWalker >
void	walk (AWalker &walker)
	Forward walk to the top node.

template<class AWalker , class APriorityMeasure >
void	walk (AWalker &walker, APriorityMeasure &priority)
	Forward walk to the top node.

void	fell ()
	Fell to tree meaning deleting all child nodes from the tree. Keeps the top node.

void	raze ()
	Like fell but also releases all memory the tree has acquired during long execution.

Public Attributes
SubPropertiesFactory	m_subPropertiesFactory
	Instance of the properties factory for the sub nodes.

Node	m_topNode
	Memory for the top node of the tree.

std::deque< typename Node::Children >	m_children
	Central point to provide memory for the child structures.

size_t	m_nUsedChildren = 0
	Last index of used children.

Private Types
using	This = DynTree< AProperties, ASubPropertiesFactory >
	Type of this class.

using	Properties = AProperties
	Type of the Properties.

using	SubPropertiesFactory = ASubPropertiesFactory
	Type of the factory for the sub node properties.

Private Member Functions
std::vector< Node > *	createChildren (Node *parentNode)
	Create child nodes for the given parents.

std::vector< Node > *	getUnusedChildren ()
	Acquire the next unused child node structure, recycling all memory.

Detailed Description

template<class AProperties, class ASubPropertiesFactory>
class Belle2::TrackFindingCDC::DynTree< AProperties, ASubPropertiesFactory >

This is the base class for all hough trees.

It stores its children trees (each tree has children trees itself to reuse this class) as nodes, and has basic functionality to fill and go through ( = walk) all its children and the chdilren of its children etc.

Definition at line 35 of file DynTree.h.

Member Typedef Documentation

◆ Properties

using Properties = AProperties

private

Type of the Properties.

Definition at line 41 of file DynTree.h.

◆ SubPropertiesFactory

using SubPropertiesFactory = ASubPropertiesFactory

private

Type of the factory for the sub node properties.

Definition at line 44 of file DynTree.h.

◆ This

using This = DynTree<AProperties, ASubPropertiesFactory>

private

Type of this class.

Definition at line 38 of file DynTree.h.

Constructor & Destructor Documentation

◆ DynTree()

DynTree	(	const Properties &	properties,
		const SubPropertiesFactory &	subPropertiesFactory = `SubPropertiesFactory()`
	)

inlineexplicit

Constructor taking properties with which the top node of the tree is initialised.

Definition at line 221 of file DynTree.h.

                                                                                                  :
        m_subPropertiesFactory(subPropertiesFactory),
        m_topNode(properties),
        m_children()
      {
        m_topNode.m_tree = this;
      }

Member Function Documentation

◆ createChildren()

std::vector< Node > * createChildren ( Node * parentNode )

inlineprivate

Create child nodes for the given parents.

Definition at line 284 of file DynTree.h.

      {
        std::vector<Node>* result = getUnusedChildren();
        auto subProperties = m_subPropertiesFactory(*parentNode);
        if (subProperties.empty()) {
          result->clear();
        } else {
          // Initialize new elements with dummy property.
          result->resize(subProperties.size(), Node(subProperties.back()));
          size_t iSubNode = 0;
          for (auto& properties : subProperties) {
            clearIfApplicable(result->at(iSubNode));
            result->at(iSubNode) = properties;
            ++iSubNode;
          }
        }
        return result;
      }

◆ fell()

void fell ( )

inline

Fell to tree meaning deleting all child nodes from the tree. Keeps the top node.

Definition at line 334 of file DynTree.h.

      {
        clearIfApplicable(m_topNode);
        m_topNode.unlink();
        m_topNode.m_tree = this;
        for (typename Node::Children& children : m_children) {
          for (Node& node : children) {
            clearIfApplicable(node);
            node.unlink();
          }
        }
        m_nUsedChildren = 0;
      }

◆ getNNodes()

int getNNodes ( ) const

inline

Gets the number of nodes currently contained in the tree Also demonstrates how to walk over the tree.

Definition at line 248 of file DynTree.h.

      {
        int nNodes = 0;
        auto countNodes = [&nNodes](const Node*) -> bool {
          ++nNodes;
          return true;
        };
        const_cast<DynTree&>(*this).walk(countNodes);
        //walk(countNodes);
        return nNodes;
      }

◆ getNNodesByLevel()

std::map< int, int > getNNodesByLevel ( ) const

inline

Gets the number of nodes by level in the tree Also demonstrates how to walk over the tree.

Definition at line 264 of file DynTree.h.

      {
        std::map<int, int> nNodesByLevel;
        auto countNodes = [&nNodesByLevel](const Node * node) -> bool {
          if (nNodesByLevel.count(node->getLevel()) == 0)
          {
            nNodesByLevel[node->getLevel()] = 1;
          } else
          {
            nNodesByLevel[node->getLevel()]++;
          }
          return true;
        };
        const_cast<DynTree&>(*this).walk(countNodes);
        //walk(countNodes);
        return nNodesByLevel;
      }

◆ getTopNode() [1/2]

Node & getTopNode ( )

inline

Getter for the top node of the tree.

Definition at line 237 of file DynTree.h.

238 { return m_topNode; }

◆ getTopNode() [2/2]

const Node & getTopNode ( ) const

inline

Constant getter for the top node of the tree.

Definition at line 241 of file DynTree.h.

242 { return m_topNode; }

◆ getUnusedChildren()

std::vector< Node > * getUnusedChildren ( )

inlineprivate

Acquire the next unused child node structure, recycling all memory.

Definition at line 304 of file DynTree.h.

      {
        if (m_nUsedChildren >= m_children.size()) {
          m_children.emplace_back();
        }
        ++m_nUsedChildren;
        return &(m_children[m_nUsedChildren - 1]);
      }

◆ raze()

void raze ( )

inline

Like fell but also releases all memory the tree has acquired during long execution.

Definition at line 349 of file DynTree.h.

      {
        this->fell();
        m_children.clear();
        m_children.shrink_to_fit();
      }

◆ walk() [1/2]

void walk ( AWalker & walker )

inline

Forward walk to the top node.

Definition at line 316 of file DynTree.h.

      {
        static_assert(std::is_assignable<std::function<bool(Node*)>, AWalker>(), "");
 
        getTopNode().walk(walker);
      }

◆ walk() [2/2]

void walk	(	AWalker &	walker,
		APriorityMeasure &	priority
	)

inline

Forward walk to the top node.

Definition at line 325 of file DynTree.h.

      {
        static_assert(std::is_assignable<std::function<bool(Node*)>, AWalker>(), "");
        static_assert(std::is_assignable<std::function<float(Node*)>, APriorityMeasure>(), "");
 
        getTopNode().walk(walker, priority);
      }

Member Data Documentation

◆ m_children

std::deque<typename Node::Children> m_children

Central point to provide memory for the child structures.

Definition at line 364 of file DynTree.h.

◆ m_nUsedChildren

size_t m_nUsedChildren = 0

Last index of used children.

Definition at line 367 of file DynTree.h.

◆ m_subPropertiesFactory

SubPropertiesFactory m_subPropertiesFactory

Instance of the properties factory for the sub nodes.

Definition at line 358 of file DynTree.h.

◆ m_topNode

Node m_topNode

Memory for the top node of the tree.

Definition at line 361 of file DynTree.h.

The documentation for this class was generated from the following file:

tracking/trackFindingCDC/hough/trees/include/DynTree.h

Classes

Public Member Functions

Public Attributes

Private Types

Private Member Functions

Detailed Description

Member Typedef Documentation

◆ Properties

◆ SubPropertiesFactory

◆ This

Constructor & Destructor Documentation

◆ DynTree()

Member Function Documentation

◆ createChildren()

◆ fell()

◆ getNNodes()

◆ getNNodesByLevel()

◆ getTopNode() [1/2]

◆ getTopNode() [2/2]

◆ getUnusedChildren()

◆ raze()

◆ walk() [1/2]

◆ walk() [2/2]

Member Data Documentation

◆ m_children

◆ m_nUsedChildren

◆ m_subPropertiesFactory

◆ m_topNode