Trk::BinnedArrayArray< T > Class Template Reference

#include <BinnedArrayArray.h>

Inheritance diagram for Trk::BinnedArrayArray< T >:

Collaboration diagram for Trk::BinnedArrayArray< T >:

Public Member Functions
	BinnedArrayArray (const std::vector< std::pair< BinnedArray< T > *, Amg::Vector3D >> &tbas, BinUtility *bUtility)
	Default Constructor More...
	BinnedArrayArray (const BinnedArrayArray &baa)
	Copy Constructor. More...
virtual	~BinnedArrayArray ()
	Virtual Destructor. More...
BinnedArrayArray &	operator= (const BinnedArrayArray &baa)
	assignment operator matching the copy constructor More...
virtual BinnedArrayArray *	clone () const override
	Implicit constructor. More...
virtual T *	object (const Amg::Vector2D &lp) const override
	Returns the pointer to the templated class object from the BinnedArrayArray, it returns 0 if not defined, takes local position. More...
virtual T *	object (const Amg::Vector3D &gp) const override
	Returns the pointer to the templated class object from the BinnedArrayArray it returns 0 if not defined, takes global position. More...
virtual T *	entryObject (const Amg::Vector3D &gp) const override
	Returns the pointer to the templated class object from the BinnedArrayArray - entry point. More...
virtual T *	nextObject (const Amg::Vector3D &gp, const Amg::Vector3D &, bool) const override
	Returns the pointer to the templated class object from the BinnedArrayArray, takes 3D position & direction. More...
virtual BinnedArraySpan< T *const >	arrayObjects () override final
	Return all objects of the Array non-const T. More...
virtual BinnedArraySpan< T const *const >	arrayObjects () const override final
	Return all objects of the Array const T. More...
virtual unsigned int	arrayObjectsNumber () const override final
	Number of Entries in the Array. More...
virtual const BinUtility *	binUtility () const override
	Return the BinUtility. More...

Private Member Functions
void	deleteBinnedArrays ()
	cleanup the array of binned arrays. More...
void	copyBinnedArrays (const std::vector< BinnedArray< T > * > &binned_arrays)
	Build up binned arrays array from cloned binned arrays. More...

Private Attributes
BinUtility *	m_binUtility
std::vector< BinnedArray< T > * >	m_binnedArrays
std::vector< T * >	m_arrayObjects

Detailed Description

template<class T>
class Trk::BinnedArrayArray< T >

the most generic extension of a BinnedArray: a BinnedArray of BinnedArrays voila

Author

Andre.nosp@m.as.S.nosp@m.alzbu.nosp@m.rger.nosp@m.@cern.nosp@m..ch

Definition at line 35 of file BinnedArrayArray.h.

Constructor & Destructor Documentation

BinnedArrayArray() [1/2]

template<class T >

Trk::BinnedArrayArray< T >::BinnedArrayArray ( const std::vector< std::pair< BinnedArray< T > *, Amg::Vector3D >> &  tbas, BinUtility *  bUtility  )

inline

Default Constructor

Definition at line 40 of file BinnedArrayArray.h.

    : m_binUtility(bUtility)
    , m_binnedArrays(bUtility->bins(0), nullptr)
    , m_arrayObjects()
  {
    // the array objects
    m_arrayObjects.reserve(tbas.size() * bUtility->bins(0));
    // looping over the contained binned arraysa
    for (auto& barray : tbas) {
      // binned array ordering
      m_binnedArrays[bUtility->bin(barray.second, 0)] = barray.first;
      // get the array objects
      BinnedArraySpan<T * const > aObjects = barray.first->arrayObjects();
      for (auto& o : aObjects)
        m_arrayObjects.push_back(o);
    }
  }

BinnedArrayArray() [2/2]

template<class T >

Trk::BinnedArrayArray< T >::BinnedArrayArray ( const BinnedArrayArray< T > &  baa )

inline

Copy Constructor.

Definition at line 61 of file BinnedArrayArray.h.

    : m_binUtility(baa.m_binUtility->clone())
    , m_arrayObjects(baa.m_arrayObjects)
  {
    copyBinnedArrays(baa.m_binnedArrays);
  }

~BinnedArrayArray()

template<class T >

virtual Trk::BinnedArrayArray< T >::~BinnedArrayArray ( )

inlinevirtual

Virtual Destructor.

Definition at line 69 of file BinnedArrayArray.h.

  {
    delete m_binUtility;
    deleteBinnedArrays();
  }

Member Function Documentation

arrayObjects() [1/2]

template<class T >

virtual BinnedArraySpan<T const * const> Trk::BinnedArrayArray< T >::arrayObjects ( ) const

inlinefinaloverridevirtual

Return all objects of the Array const T.

Implements Trk::BinnedArray< T >.

Definition at line 143 of file BinnedArrayArray.h.

  {
    return BinnedArraySpan<T const* const>(&*m_arrayObjects.begin(), &*m_arrayObjects.end());
  }

arrayObjects() [2/2]

template<class T >

virtual BinnedArraySpan<T* const > Trk::BinnedArrayArray< T >::arrayObjects ( )

inlinefinaloverridevirtual

Return all objects of the Array non-const T.

Implements Trk::BinnedArray< T >.

Definition at line 137 of file BinnedArrayArray.h.

  {
    return BinnedArraySpan<T* const >(&*m_arrayObjects.begin(), &*m_arrayObjects.end());
  }

arrayObjectsNumber()

template<class T >

virtual unsigned int Trk::BinnedArrayArray< T >::arrayObjectsNumber ( ) const

inlinefinaloverridevirtual

Number of Entries in the Array.

Implements Trk::BinnedArray< T >.

Definition at line 149 of file BinnedArrayArray.h.

  {
    return m_arrayObjects.size();
  };

binUtility()

template<class T >

virtual const BinUtility* Trk::BinnedArrayArray< T >::binUtility ( ) const

inlineoverridevirtual

Return the BinUtility.

Implements Trk::BinnedArray< T >.

Definition at line 155 of file BinnedArrayArray.h.

{ return m_binUtility; }

clone()

template<class T >

virtual BinnedArrayArray* Trk::BinnedArrayArray< T >::clone ( ) const

inlineoverridevirtual

Implicit constructor.

Implements Trk::BinnedArray< T >.

Definition at line 91 of file BinnedArrayArray.h.

  {
    return new BinnedArrayArray(*this);
  }

copyBinnedArrays()

template<class T >

void Trk::BinnedArrayArray< T >::copyBinnedArrays ( const std::vector< BinnedArray< T > * > &  binned_arrays )

inlineprivate

Build up binned arrays array from cloned binned arrays.

Note: the original m_binnedArrays is not automatically cleaned but requires deleteBinnedArrays to be called explicitly.

Definition at line 172 of file BinnedArrayArray.h.

  {
    m_binnedArrays.reserve(binned_arrays.size());
 
    for (const auto& a_binned_array : binned_arrays) {
      m_binnedArrays.push_back(a_binned_array->clone());
    }
  }

deleteBinnedArrays()

template<class T >

void Trk::BinnedArrayArray< T >::deleteBinnedArrays ( )

inlineprivate

cleanup the array of binned arrays.

Definition at line 160 of file BinnedArrayArray.h.

  {
    for (auto ba : m_binnedArrays) {
      delete ba;
    }
    m_binnedArrays.clear();
  }

entryObject()

template<class T >

virtual T* Trk::BinnedArrayArray< T >::entryObject ( const Amg::Vector3D &  gp ) const

inlineoverridevirtual

Returns the pointer to the templated class object from the BinnedArrayArray - entry point.

Implements Trk::BinnedArray< T >.

Definition at line 122 of file BinnedArrayArray.h.

  {
    return object(gp);
  }

nextObject()

template<class T >

virtual T* Trk::BinnedArrayArray< T >::nextObject ( const Amg::Vector3D &  gp, const Amg::Vector3D &  , bool    ) const

inlineoverridevirtual

Returns the pointer to the templated class object from the BinnedArrayArray, takes 3D position & direction.

Implements Trk::BinnedArray< T >.

Definition at line 129 of file BinnedArrayArray.h.

  {
    return object(gp);
  }

object() [1/2]

template<class T >

virtual T* Trk::BinnedArrayArray< T >::object ( const Amg::Vector2D &  lp ) const

inlineoverridevirtual

Returns the pointer to the templated class object from the BinnedArrayArray, it returns 0 if not defined, takes local position.

Implements Trk::BinnedArray< T >.

Definition at line 98 of file BinnedArrayArray.h.

  {
    if (m_binUtility->inside(lp)) {
      BinnedArray<T>* ba = m_binnedArrays[m_binUtility->bin(lp, 0)];
      if (ba)
        return ba->object(lp);
    }
    return nullptr;
  }

object() [2/2]

template<class T >

virtual T* Trk::BinnedArrayArray< T >::object ( const Amg::Vector3D &  gp ) const

inlineoverridevirtual

Returns the pointer to the templated class object from the BinnedArrayArray it returns 0 if not defined, takes global position.

Implements Trk::BinnedArray< T >.

Definition at line 110 of file BinnedArrayArray.h.

  {
    if (m_binUtility->inside(gp)) {
      BinnedArray<T>* ba = m_binnedArrays[m_binUtility->bin(gp, 0)];
      if (ba)
        return ba->object(gp);
    }
    return nullptr;
  }

operator=()

template<class T >

BinnedArrayArray& Trk::BinnedArrayArray< T >::operator= ( const BinnedArrayArray< T > &  baa )

inline

assignment operator matching the copy constructor

Definition at line 76 of file BinnedArrayArray.h.

  {
    if (&baa != this) {
      delete m_binUtility;
      m_binUtility = baa.m_binUtility->clone();
 
      deleteBinnedArrays();
      copyBinnedArrays(baa.m_binnedArrays);
 
      m_arrayObjects = baa.m_arrayObjects;
    }
    return *this;
  }

Member Data Documentation

m_arrayObjects

template<class T >

std::vector<T*> Trk::BinnedArrayArray< T >::m_arrayObjects

private

Definition at line 183 of file BinnedArrayArray.h.

m_binnedArrays

template<class T >

std::vector<BinnedArray<T>*> Trk::BinnedArrayArray< T >::m_binnedArrays

private

Definition at line 182 of file BinnedArrayArray.h.

m_binUtility

template<class T >

BinUtility* Trk::BinnedArrayArray< T >::m_binUtility

private

Definition at line 181 of file BinnedArrayArray.h.

---

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

• BinnedArrayArray.h