Type for two related objects with a weight. More...

#include <WeightedRelation.h>

Inheritance diagram for WeightedRelation< AFrom, ATo >:

Collaboration diagram for WeightedRelation< AFrom, ATo >:

[legend]

Public Types
using	From = AFrom
	Type of from which the relation originates.

using	To = ATo
	Type of to which the relation points.

Public Member Functions
	WeightedRelation ()=default
	Default constructor.

	WeightedRelation (From from, Weight weight, To to)
	Creating a relation with one object on the from side, one on the to side and a weight.

bool	operator< (const WeightedRelation< From, To > &rhs) const
	Operator for ordering of relations.

From *	getFrom () const
	Getter for the pointer to the from side object.

Weight	getWeight () const
	Getter for the weight.

void	setWeight (Weight weight)
	Setter for the weight.

const std::pair< From *, Weight > &	getWeightedFrom () const
	Getter for the pointer to the weighted from side object.

To *	getTo () const
	Getter for the pointer to the to side object.

WeightedRelation< To, From >	reversed () const
	Make a relation in the opposite direction with the same weight.

Public Attributes
T1	first_type
	STL member.

T2	second_type
	STL member.

Private Types
using	Super = std::pair<std::pair<AFrom, Weight>, ATo>
	Type of the base class.

Friends
bool	operator< (const std::pair< From *, Weight > &weightedPtr, const WeightedRelation< From, To > &weightedRelation)
	Operator to compare key type weighted item to the relations for associative lookups.

bool	operator< (const WeightedRelation< From, To > &weightedRelation, const std::pair< From *, Weight > &weightedPtr)
	Operator to compare key type weighted item to the relations for associative lookups.

bool	operator< (const From *ptrFrom, const WeightedRelation< From, To > &weightedRelation)
	Operator to compare key type item to the relations for associative lookups.

bool	operator< (const WeightedRelation< From, To > &weightedRelation, const From *ptrFrom)
	Operator to compare key type item to the relations for associative lookups.

Detailed Description

template<class AFrom, class ATo = AFrom>
class Belle2::TrackingUtilities::WeightedRelation< AFrom, ATo >

Type for two related objects with a weight.

Definition at line 26 of file WeightedRelation.h.

Member Typedef Documentation

◆ From

template<class AFrom, class ATo = AFrom>

using From = AFrom

Type of from which the relation originates.

Definition at line 33 of file WeightedRelation.h.

◆ Super

template<class AFrom, class ATo = AFrom>

using Super = std::pair<std::pair<AFrom*, Weight>, ATo*>

private

Type of the base class.

Definition at line 29 of file WeightedRelation.h.

◆ To

template<class AFrom, class ATo = AFrom>

using To = ATo

Type of to which the relation points.

Definition at line 36 of file WeightedRelation.h.

Constructor & Destructor Documentation

◆ WeightedRelation()

template<class AFrom, class ATo = AFrom>

WeightedRelation	(	From *	from,
		Weight	weight,
		To *	to )

inline

Creating a relation with one object on the from side, one on the to side and a weight.

Definition at line 43 of file WeightedRelation.h.

44 : Super({from, weight}, to)

45 {}

Member Function Documentation

◆ getFrom()

template<class AFrom, class ATo = AFrom>

From * getFrom ( ) const

inline

Getter for the pointer to the from side object.

Definition at line 91 of file WeightedRelation.h.

      {
        return getWeightedFrom().first;
      }

◆ getTo()

template<class AFrom, class ATo = AFrom>

To * getTo ( ) const

inline

Getter for the pointer to the to side object.

Definition at line 115 of file WeightedRelation.h.

      {
        return this->second;
      }

◆ getWeight()

template<class AFrom, class ATo = AFrom>

Weight getWeight ( ) const

inline

Getter for the weight.

Definition at line 97 of file WeightedRelation.h.

      {
        return getWeightedFrom().second;
      }

◆ getWeightedFrom()

template<class AFrom, class ATo = AFrom>

const std::pair< From *, Weight > & getWeightedFrom ( ) const

inline

Getter for the pointer to the weighted from side object.

Definition at line 109 of file WeightedRelation.h.

      {
        return this->first;
      }

◆ operator<()

template<class AFrom, class ATo = AFrom>

bool operator< ( const WeightedRelation< From, To > & rhs ) const

inline

Operator for ordering of relations.

Definition at line 48 of file WeightedRelation.h.

      {
        return (getFrom() < rhs.getFrom() or
                (not(rhs.getFrom() < getFrom()) and
                 // highest weight first
                 (getWeight() > rhs.getWeight() or
                  (not(rhs.getWeight() > getWeight()) and
                   (getTo() < rhs.getTo())))));
      }

◆ reversed()

template<class AFrom, class ATo = AFrom>

WeightedRelation< To, From > reversed ( ) const

inline

Make a relation in the opposite direction with the same weight.

Definition at line 121 of file WeightedRelation.h.

      {
        //return WeightedRelation<To, From>(getTo(), getWeight(), getFrom());
        return {getTo(), getWeight(), getFrom()};
      }

◆ setWeight()

template<class AFrom, class ATo = AFrom>

void setWeight ( Weight weight )

inline

Setter for the weight.

Definition at line 103 of file WeightedRelation.h.

      {
        this->first.second = weight;
      }

Friends And Related Symbol Documentation

◆ operator< [1/4]

template<class AFrom, class ATo = AFrom>

bool operator<	(	const From *	ptrFrom,
		const WeightedRelation< From, To > &	weightedRelation )

friend

Operator to compare key type item to the relations for associative lookups.

Definition at line 79 of file WeightedRelation.h.

      {
        return ptrFrom < weightedRelation.getFrom();
      }

◆ operator< [2/4]

template<class AFrom, class ATo = AFrom>

bool operator<	(	const std::pair< From *, Weight > &	weightedPtr,
		const WeightedRelation< From, To > &	weightedRelation )

friend

Operator to compare key type weighted item to the relations for associative lookups.

Definition at line 59 of file WeightedRelation.h.

      {
        return (weightedPtr.first < weightedRelation.getFrom() or
                (not(weightedRelation.getFrom() < weightedPtr.first) and
                 // highest weight first
                 (weightedPtr.second > weightedRelation.getWeight())));
      }

◆ operator< [3/4]

template<class AFrom, class ATo = AFrom>

bool operator<	(	const WeightedRelation< From, To > &	weightedRelation,
		const From *	ptrFrom )

friend

Operator to compare key type item to the relations for associative lookups.

Definition at line 85 of file WeightedRelation.h.

      {
        return weightedRelation.getFrom() < ptrFrom;
      }

◆ operator< [4/4]

template<class AFrom, class ATo = AFrom>

bool operator<	(	const WeightedRelation< From, To > &	weightedRelation,
		const std::pair< From *, Weight > &	weightedPtr )

friend

Operator to compare key type weighted item to the relations for associative lookups.

Definition at line 69 of file WeightedRelation.h.

      {
        return (weightedRelation.getFrom() < weightedPtr.first or
                (not(weightedPtr.first < weightedRelation.getFrom()) and
                 // highest weight first
                 (weightedRelation.getWeight() > weightedPtr.second)));
      }

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

tracking/trackingUtilities/eventdata/segments/include/CDCSegment2D.h
tracking/trackingUtilities/utilities/include/WeightedRelation.h

Public Types

Public Member Functions

Public Attributes

Private Types

Friends

Detailed Description

Member Typedef Documentation

◆ From

◆ Super

◆ To

Constructor & Destructor Documentation

◆ WeightedRelation()

Member Function Documentation

◆ getFrom()

◆ getTo()

◆ getWeight()

◆ getWeightedFrom()

◆ operator<()

◆ reversed()

◆ setWeight()

Friends And Related Symbol Documentation

◆ operator< [1/4]

◆ operator< [2/4]

◆ operator< [3/4]

◆ operator< [4/4]