Type of tree for partitioning the hough space. More...

#include <WeightedFastHoughTree.h>

Inheritance diagram for WeightedParititioningDynTree< T, ADomain, ADomainDivsion >:

Public Member Functions
	WeightedParititioningDynTree (ADomain topDomain, ADomainDivsion domainDivsion)
	Constructor attaching a vector of the weighted items to the top most node domain.

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

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

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.

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.

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

void	walk (AWalker &walker)
	Forward walk to the top node.

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

void	walk (AWalker &walker)
	Forward walk to the top node.

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	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.

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.

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

Node	m_topNode
	Memory for the top node of the tree.

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.

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

size_t	m_nUsedChildren
	Last index of used children.

size_t	m_nUsedChildren
	Last index of used children.

Private Types
using	Super = DynTree< WithWeightedItems<ADomain, T>, ADomainDivsion>
	Type of the base class.

using	This
	Type of this class.

using	Properties
	Type of the Properties.

using	SubPropertiesFactory
	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 > *	createChildren (Node *parentNode)
	Create child nodes for the given parents.

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

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

Detailed Description

template<class T, class ADomain, class ADomainDivsion>
class Belle2::TrackFindingCDC::WeightedParititioningDynTree< T, ADomain, ADomainDivsion >

Type of tree for partitioning the hough space.

Definition at line 29 of file WeightedFastHoughTree.h.

Member Typedef Documentation

◆ Properties

using Properties

privateinherited

Type of the Properties.

Definition at line 41 of file DynTree.h.

◆ SubPropertiesFactory

using SubPropertiesFactory

privateinherited

Type of the factory for the sub node properties.

Definition at line 44 of file DynTree.h.

◆ Super

template<class T, class ADomain, class ADomainDivsion>

using Super = DynTree< WithWeightedItems<ADomain, T>, ADomainDivsion>

private

Type of the base class.

Definition at line 33 of file WeightedFastHoughTree.h.

◆ This

using This

privateinherited

Type of this class.

Definition at line 38 of file DynTree.h.

Constructor & Destructor Documentation

◆ WeightedParititioningDynTree()

template<class T, class ADomain, class ADomainDivsion>

WeightedParititioningDynTree	(	ADomain	topDomain,
		ADomainDivsion	domainDivsion )

inline

Constructor attaching a vector of the weighted items to the top most node domain.

Definition at line 37 of file WeightedFastHoughTree.h.

                                                                                    :
        Super(WithWeightedItems<ADomain, T>(std::move(topDomain)), std::move(domainDivsion))
      {}

Member Function Documentation

◆ createChildren() [1/2]

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

inlineprivateinherited

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;
      }

◆ createChildren() [2/2]

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

inlineprivateinherited

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() [1/2]

void fell ( )

inlineinherited

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;
      }

◆ fell() [2/2]

void fell ( )

inlineinherited

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() [1/2]

int getNNodes ( ) const

inlineinherited

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;
      }

◆ getNNodes() [2/2]

int getNNodes ( ) const

inlineinherited

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() [1/2]

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

inlineinherited

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;
      }

◆ getNNodesByLevel() [2/2]

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

inlineinherited

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/4]

Node & getTopNode ( )

inlineinherited

Getter for the top node of the tree.

Definition at line 237 of file DynTree.h.

238 { return m_topNode; }

◆ getTopNode() [2/4]

Node & getTopNode ( )

inlineinherited

Getter for the top node of the tree.

Definition at line 237 of file DynTree.h.

238 { return m_topNode; }

◆ getTopNode() [3/4]

const Node & getTopNode ( ) const

inlineinherited

Constant getter for the top node of the tree.

Definition at line 241 of file DynTree.h.

242 { return m_topNode; }

◆ getTopNode() [4/4]

const Node & getTopNode ( ) const

inlineinherited

Constant getter for the top node of the tree.

Definition at line 241 of file DynTree.h.

242 { return m_topNode; }

◆ getUnusedChildren() [1/2]

std::vector< Node > * getUnusedChildren ( )

inlineprivateinherited

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]);
      }

◆ getUnusedChildren() [2/2]

std::vector< Node > * getUnusedChildren ( )

inlineprivateinherited

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() [1/2]

void raze ( )

inlineinherited

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();
      }

◆ raze() [2/2]

void raze ( )

inlineinherited

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/4]

void walk ( AWalker & walker )

inlineinherited

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/4]

void walk ( AWalker & walker )

inlineinherited

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() [3/4]

void walk	(	AWalker &	walker,
		APriorityMeasure &	priority )

inlineinherited

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);
      }

◆ walk() [4/4]

void walk	(	AWalker &	walker,
		APriorityMeasure &	priority )

inlineinherited

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 [1/2]

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

inherited

Central point to provide memory for the child structures.

Definition at line 364 of file DynTree.h.

◆ m_children [2/2]

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

inherited

Central point to provide memory for the child structures.

Definition at line 364 of file DynTree.h.

◆ m_nUsedChildren [1/2]

size_t m_nUsedChildren

inherited

Last index of used children.

Definition at line 367 of file DynTree.h.

◆ m_nUsedChildren [2/2]

size_t m_nUsedChildren

inherited

Last index of used children.

Definition at line 367 of file DynTree.h.

◆ m_subPropertiesFactory [1/2]

SubPropertiesFactory m_subPropertiesFactory

inherited

Instance of the properties factory for the sub nodes.

Definition at line 358 of file DynTree.h.

◆ m_subPropertiesFactory [2/2]

SubPropertiesFactory m_subPropertiesFactory

inherited

Instance of the properties factory for the sub nodes.

Definition at line 358 of file DynTree.h.

◆ m_topNode [1/2]

Node m_topNode

inherited

Memory for the top node of the tree.

Definition at line 361 of file DynTree.h.

◆ m_topNode [2/2]

Node m_topNode

inherited

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/WeightedFastHoughTree.h

Public Member Functions

Public Attributes

Private Types

Private Member Functions

Detailed Description

Member Typedef Documentation

◆ Properties

◆ SubPropertiesFactory

◆ Super

◆ This

Constructor & Destructor Documentation

◆ WeightedParititioningDynTree()

Member Function Documentation

◆ createChildren() [1/2]

◆ createChildren() [2/2]

◆ fell() [1/2]

◆ fell() [2/2]

◆ getNNodes() [1/2]

◆ getNNodes() [2/2]

◆ getNNodesByLevel() [1/2]

◆ getNNodesByLevel() [2/2]

◆ getTopNode() [1/4]

◆ getTopNode() [2/4]

◆ getTopNode() [3/4]

◆ getTopNode() [4/4]

◆ getUnusedChildren() [1/2]

◆ getUnusedChildren() [2/2]

◆ raze() [1/2]

◆ raze() [2/2]

◆ walk() [1/4]

◆ walk() [2/4]

◆ walk() [3/4]

◆ walk() [4/4]

Member Data Documentation

◆ m_children [1/2]

◆ m_children [2/2]

◆ m_nUsedChildren [1/2]

◆ m_nUsedChildren [2/2]

◆ m_subPropertiesFactory [1/2]

◆ m_subPropertiesFactory [2/2]

◆ m_topNode [1/2]

◆ m_topNode [2/2]