A mixin class to attach a set of weighted items to a class. More...

#include <WithWeightedItems.h>

Inheritance diagram for WithWeightedItems< T, AItem >:

Public Member Functions
	WithWeightedItems (const T &t)
	Also forward the copy constructor form the base class object.

TrackingUtilities::Weight	getWeight () const
	Cumulated weight of the contained items.

template<class APredicate>
void	eraseIf (const APredicate &predicate)
	Erase items from this node that satisfy the predicate.

void	insert (const AItem &item, TrackingUtilities::Weight weight=1.0)
	Add an item with weight.

template<class AMeasure>
void	insert (const This &items, AMeasure &measure)
	Add the items from another item range assigning a weight from the predicate.

std::vector< TrackingUtilities::WithWeight< AItem > >::iterator	begin ()
	Begin iterator of the contained items.

std::vector< TrackingUtilities::WithWeight< AItem > >::const_iterator	begin () const
	Begin iterator of the contained items.

std::vector< TrackingUtilities::WithWeight< AItem > >::iterator	end ()
	End iterator of the contained items.

std::vector< TrackingUtilities::WithWeight< AItem > >::const_iterator	end () const
	End iterator of the contained items.

size_t	size () const
	Getter for the number of items.

void	clear ()
	Clear the contained items.

Private Types
using	Super = T
	Type of the base class.

using	This = WithWeightedItems<T, AItem>
	Type of this class.

Private Attributes
std::vector< TrackingUtilities::WithWeight< AItem > >	m_items
	Memory for the weighted items.

std::vector< TrackingUtilities::WithWeight< AItem > >::iterator	m_itEnd {m_items.end()}
	Memory for the end of the items that are not erased.

TrackingUtilities::Weight	m_weightSum = 0.0
	Cumulated weight of the contained items, kept up to date on insertion and removal.

Detailed Description

template<class T, class AItem>
class Belle2::TrackFindingCDC::WithWeightedItems< T, AItem >

A mixin class to attach a set of weighted items to a class.

Definition at line 25 of file WithWeightedItems.h.

Member Typedef Documentation

◆ Super

template<class T, class AItem>

using Super = T

private

Type of the base class.

Definition at line 29 of file WithWeightedItems.h.

◆ This

template<class T, class AItem>

using This = WithWeightedItems<T, AItem>

private

Type of this class.

Definition at line 32 of file WithWeightedItems.h.

Constructor & Destructor Documentation

◆ WithWeightedItems()

template<class T, class AItem>

WithWeightedItems ( const T & t )

inlineexplicit

Also forward the copy constructor form the base class object.

Definition at line 42 of file WithWeightedItems.h.

        : T(t)
      {
      }

Member Function Documentation

◆ begin() [1/2]

template<class T, class AItem>

std::vector< TrackingUtilities::WithWeight< AItem > >::iterator begin ( )

inline

Begin iterator of the contained items.

Definition at line 96 of file WithWeightedItems.h.

      {
        return m_items.begin();
      }

◆ begin() [2/2]

template<class T, class AItem>

std::vector< TrackingUtilities::WithWeight< AItem > >::const_iterator begin ( ) const

inline

Begin iterator of the contained items.

Definition at line 102 of file WithWeightedItems.h.

      {
        return m_items.begin();
      }

◆ clear()

template<class T, class AItem>

void clear ( )

inline

Clear the contained items.

Definition at line 127 of file WithWeightedItems.h.

      {
        m_items.clear();
        m_itEnd = m_items.end();
        m_weightSum = 0.0;
        Super& super = *this;
        TrackingUtilities::clearIfApplicable(super);
      }

◆ end() [1/2]

template<class T, class AItem>

std::vector< TrackingUtilities::WithWeight< AItem > >::iterator end ( )

inline

End iterator of the contained items.

Definition at line 108 of file WithWeightedItems.h.

      {
        return m_itEnd;
      }

◆ end() [2/2]

template<class T, class AItem>

std::vector< TrackingUtilities::WithWeight< AItem > >::const_iterator end ( ) const

inline

End iterator of the contained items.

Definition at line 114 of file WithWeightedItems.h.

      {
        return m_itEnd;
      }

◆ eraseIf()

template<class T, class AItem>

template<class APredicate>

void eraseIf ( const APredicate & predicate )

inline

Erase items from this node that satisfy the predicate.

Definition at line 55 of file WithWeightedItems.h.

      {
        // Sneakily hide the items instead of erasing them.
        // auto notPredicate = [&predicate](AItem & item) { return not predicate(item); };
        // m_itEnd = std::partition(m_items.begin(), m_items.end(), notPredicate);
        // Properly delete use the following.
        m_itEnd = std::remove_if(m_items.begin(), m_items.end(), predicate);
        if (m_itEnd != m_items.end()) {
          m_items.erase(m_itEnd, m_items.end());
          // Recompute the cumulated weight in the same order as a fresh accumulation
          m_weightSum = std::accumulate(begin(),
                                        end(),
                                        static_cast<TrackingUtilities::Weight>(0.0),
          [](TrackingUtilities::Weight accumulatedWeight, const TrackingUtilities::WithWeight<AItem>& weightedItem) {
            return accumulatedWeight + weightedItem.getWeight();
          });
        }
      }

◆ getWeight()

template<class T, class AItem>

TrackingUtilities::Weight getWeight ( ) const

inline

Cumulated weight of the contained items.

Definition at line 48 of file WithWeightedItems.h.

      {
        return m_weightSum;
      }

◆ insert() [1/2]

template<class T, class AItem>

void insert	(	const AItem &	item,
		TrackingUtilities::Weight	weight = 1.0 )

inline

Add an item with weight.

Definition at line 75 of file WithWeightedItems.h.

      {
        // The end marker always coincides with the end of the item vector, hence append.
        m_items.emplace_back(item, weight);
        m_itEnd = m_items.end();
        m_weightSum += weight;
      }

◆ insert() [2/2]

template<class T, class AItem>

template<class AMeasure>

void insert	(	const This &	items,
		AMeasure &	measure )

inline

Add the items from another item range assigning a weight from the predicate.

Definition at line 85 of file WithWeightedItems.h.

      {
        for (AItem item : items.m_items) {
          const TrackingUtilities::Weight weight = measure(item);
          if (not std::isnan(weight)) {
            insert(item, weight);
          }
        }
      }

◆ size()

template<class T, class AItem>

size_t size ( ) const

inline

Getter for the number of items.

Definition at line 120 of file WithWeightedItems.h.

      {
        return std::distance(begin(), end());
      }

Member Data Documentation

◆ m_items

template<class T, class AItem>

std::vector<TrackingUtilities::WithWeight<AItem> > m_items

private

Memory for the weighted items.

Definition at line 138 of file WithWeightedItems.h.

◆ m_itEnd

template<class T, class AItem>

std::vector<TrackingUtilities::WithWeight<AItem>>::iterator m_itEnd {m_items.end()}

private

Memory for the end of the items that are not erased.

Definition at line 141 of file WithWeightedItems.h.

141{m_items.end()};

◆ m_weightSum

template<class T, class AItem>

TrackingUtilities::Weight m_weightSum = 0.0

private

Cumulated weight of the contained items, kept up to date on insertion and removal.

Definition at line 144 of file WithWeightedItems.h.

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

tracking/trackFindingCDC/hough/baseelements/include/WithWeightedItems.h

Public Member Functions

Private Types

Private Attributes

Detailed Description

Member Typedef Documentation

◆ Super

◆ This

Constructor & Destructor Documentation

◆ WithWeightedItems()

Member Function Documentation

◆ begin() [1/2]

◆ begin() [2/2]

◆ clear()

◆ end() [1/2]

◆ end() [2/2]

◆ eraseIf()

◆ getWeight()

◆ insert() [1/2]

◆ insert() [2/2]

◆ size()

Member Data Documentation

◆ m_items

◆ m_itEnd

◆ m_weightSum