Trk::BinnedArray2D< T > Class Template Reference

#include <BinnedArray2D.h>

Inheritance diagram for Trk::BinnedArray2D< T >:

Collaboration diagram for Trk::BinnedArray2D< T >:

Public Member Functions
	BinnedArray2D ()
	Default Constructor - needed for inherited classes. More...
	BinnedArray2D (const std::vector< std::pair< SharedObject< T >, Amg::Vector3D >> &tclassvector, BinUtility *bingen)
	Constructor with std::vector and a BinUtility. More...
	BinnedArray2D (const BinnedArray2D &barr)
	Copy Constructor - copies only pointers ! More...
BinnedArray2D &	operator= (const BinnedArray2D &barr)
	Assignment operator. More...
BinnedArray2D *	clone () const
	Implizit Constructor. More...
	~BinnedArray2D ()
	Virtual Destructor. More...
T *	object (const Amg::Vector2D &lp) const
	Returns the pointer to the templated class object from the BinnedArray, it returns 0 if not defined;. More...
T *	object (const Amg::Vector3D &gp) const
	Returns the pointer to the templated class object from the BinnedArray it returns 0 if not defined;. More...
T *	entryObject (const Amg::Vector3D &pos) const
	Returns the pointer to the templated class object from the BinnedArray -entry point. More...
T *	nextObject (const Amg::Vector3D &gp, const Amg::Vector3D &mom, bool associatedResult=true) const
	Returns the pointer to the templated class object from the BinnedArray. More...
BinnedArraySpan< T *const >	arrayObjects ()
	Return all objects of the Array non-const T. More...
BinnedArraySpan< T const *const >	arrayObjects () const
	Return all objects of the Array const T. More...
unsigned int	arrayObjectsNumber () const
	Number of Entries in the Array. More...
const BinUtility *	binUtility () const
	Return the BinUtility. More...

Private Member Functions
void	createArrayCache () const
	vector of pointers to the class T More...

Private Attributes
std::vector< std::vector< SharedObject< T > > >	m_array
	forced 1D vector of pointers to class T More...
CxxUtils::CachedUniquePtr< std::vector< T * > >	m_arrayObjects
	binUtility for retrieving and filling the Array More...
BinUtility *	m_binUtility

Detailed Description

template<class T>
class Trk::BinnedArray2D< T >

Avoiding a map search, the templated BinnedArray class can help ordereing geometrical objects by providing a dedicated BinUtility.

dedicated for 2-dim equidistant binning

Author

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

Christos Anastopoulos (Athena MT modifications)

Definition at line 36 of file BinnedArray2D.h.

Constructor & Destructor Documentation

BinnedArray2D() [1/3]

template<class T >

Trk::BinnedArray2D< T >::BinnedArray2D ( )

inline

Default Constructor - needed for inherited classes.

Definition at line 41 of file BinnedArray2D.h.

    : BinnedArray<T>()
    , m_array{}
    , m_arrayObjects(nullptr)
    , m_binUtility(nullptr)
  {}

BinnedArray2D() [2/3]

template<class T >

Trk::BinnedArray2D< T >::BinnedArray2D ( const std::vector< std::pair< SharedObject< T >, Amg::Vector3D >> &  tclassvector, BinUtility *  bingen  )

inline

Constructor with std::vector and a BinUtility.

Definition at line 49 of file BinnedArray2D.h.

    : BinnedArray<T>()
    , m_array{}
    , m_arrayObjects(nullptr)
    , m_binUtility(bingen)
  {
 
    if (bingen) {
      m_array = std::vector<std::vector<SharedObject<T>>>(bingen->bins(1));
      for (size_t i = 0; i < bingen->bins(1); ++i) {
        m_array[i] = std::vector<SharedObject<T>>(bingen->bins(0));
      }
      // fill the Volume vector into the array
      size_t vecsize = tclassvector.size();
      for (size_t ivec = 0; ivec < vecsize; ++ivec) {
        const Amg::Vector3D currentGlobal(((tclassvector[ivec]).second));
        if (bingen->inside(currentGlobal)) {
          std::vector<SharedObject<T>>& curVec =
            m_array[bingen->bin(currentGlobal, 1)];
 
          curVec[bingen->bin(currentGlobal, 0)] = ((tclassvector)[ivec]).first;
        } else {
          throw GaudiException(
            "BinnedArray2D", "Object outside bounds", StatusCode::FAILURE);
        }
      }
    }
  }

BinnedArray2D() [3/3]

template<class T >

Trk::BinnedArray2D< T >::BinnedArray2D ( const BinnedArray2D< T > &  barr )

inline

Copy Constructor - copies only pointers !

Definition at line 81 of file BinnedArray2D.h.

    : BinnedArray<T>()
    , m_array{}
    , m_arrayObjects(nullptr)
    , m_binUtility(nullptr)
  {
    m_binUtility = (barr.m_binUtility) ? barr.m_binUtility->clone() : nullptr;
    // copy over
    m_array = std::vector<std::vector<SharedObject<T>>>(barr.m_array.size());
    for (size_t ihl = 0; ihl < barr.m_array.size(); ++ihl) {
      m_array[ihl] = std::vector<SharedObject<T>>((barr.m_array[0]).size());
      for (size_t ill = 0; ill < (barr.m_array[0]).size(); ++ill) {
        m_array[ihl][ill] = (barr.m_array)[ihl][ill];
      }
    }
  }

~BinnedArray2D()

template<class T >

Trk::BinnedArray2D< T >::~BinnedArray2D ( )

inline

Virtual Destructor.

Definition at line 120 of file BinnedArray2D.h.

{ delete m_binUtility; }

Member Function Documentation

arrayObjects() [1/2]

template<class T >

BinnedArraySpan<T* const> Trk::BinnedArray2D< T >::arrayObjects ( )

inlinevirtual

Return all objects of the Array non-const T.

Implements Trk::BinnedArray< T >.

Definition at line 172 of file BinnedArray2D.h.

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

arrayObjects() [2/2]

template<class T >

BinnedArraySpan<T const * const> Trk::BinnedArray2D< T >::arrayObjects ( ) const

inlinevirtual

Return all objects of the Array const T.

Implements Trk::BinnedArray< T >.

Definition at line 179 of file BinnedArray2D.h.

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

arrayObjectsNumber()

template<class T >

unsigned int Trk::BinnedArray2D< T >::arrayObjectsNumber ( ) const

inlinevirtual

Number of Entries in the Array.

Implements Trk::BinnedArray< T >.

Definition at line 186 of file BinnedArray2D.h.

  {
    return (m_array.size() * (m_array[0]).size());
  }

binUtility()

template<class T >

const BinUtility* Trk::BinnedArray2D< T >::binUtility ( ) const

inlinevirtual

Return the BinUtility.

Implements Trk::BinnedArray< T >.

Definition at line 192 of file BinnedArray2D.h.

{ return (m_binUtility); }

clone()

template<class T >

BinnedArray2D* Trk::BinnedArray2D< T >::clone ( ) const

inlinevirtual

Implizit Constructor.

Implements Trk::BinnedArray< T >.

Definition at line 117 of file BinnedArray2D.h.

{ return new BinnedArray2D(*this); }

createArrayCache()

template<class T >

void Trk::BinnedArray2D< T >::createArrayCache ( ) const

inlineprivate

vector of pointers to the class T

Definition at line 195 of file BinnedArray2D.h.

entryObject()

template<class T >

T* Trk::BinnedArray2D< T >::entryObject ( const Amg::Vector3D &  pos ) const

inlinevirtual

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

Implements Trk::BinnedArray< T >.

Definition at line 148 of file BinnedArray2D.h.

  {
    return (m_array[m_binUtility->entry(pos, 1)][m_binUtility->entry(pos, 0)])
      .get();
  }

nextObject()

template<class T >

T* Trk::BinnedArray2D< T >::nextObject ( const Amg::Vector3D &  gp, const Amg::Vector3D &  mom, bool  associatedResult = true  ) const

inlinevirtual

Returns the pointer to the templated class object from the BinnedArray.

Implements Trk::BinnedArray< T >.

Definition at line 156 of file BinnedArray2D.h.

  {
    // direct access to associated one
    if (associatedResult)
      return object(gp);
    size_t nextFirst = m_binUtility->next(gp, mom, 0);
    size_t nextSecond = m_binUtility->next(gp, mom, 1);
 
    return (nextFirst > 0 && nextSecond > 0)
             ? (m_array[nextSecond][nextFirst]).get()
             : nullptr;
  }

object() [1/2]

template<class T >

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

inlinevirtual

Returns the pointer to the templated class object from the BinnedArray, it returns 0 if not defined;.

Implements Trk::BinnedArray< T >.

Definition at line 125 of file BinnedArray2D.h.

  {
    if (m_binUtility->inside(lp)) {
      return (m_array[m_binUtility->bin(lp, 1)][m_binUtility->bin(lp, 0)])
        .get();
    }
    return nullptr;
  }

object() [2/2]

template<class T >

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

inlinevirtual

Returns the pointer to the templated class object from the BinnedArray it returns 0 if not defined;.

Implements Trk::BinnedArray< T >.

Definition at line 137 of file BinnedArray2D.h.

  {
    if (m_binUtility->inside(gp)) {
      return (m_array[m_binUtility->bin(gp, 1)][m_binUtility->bin(gp, 0)])
        .get();
    }
    return nullptr;
  }

operator=()

template<class T >

BinnedArray2D& Trk::BinnedArray2D< T >::operator= ( const BinnedArray2D< T > &  barr )

inline

Assignment operator.

Definition at line 98 of file BinnedArray2D.h.

  {
    if (this != &barr) {
      m_arrayObjects.release();
      delete m_binUtility;
      // now refill
      m_binUtility = (barr.m_binUtility) ? barr.m_binUtility->clone() : nullptr;
      // assign over
      m_array = std::vector<std::vector<SharedObject<T>>>(barr.m_array.size());
      for (size_t ihl = 0; ihl < barr.m_array.size(); ++ihl) {
        m_array[ihl] = std::vector<SharedObject<T>>((barr.m_array[0]).size());
        for (size_t ill = 0; ill < ((barr.m_array)[0]).size(); ++ill) {
          m_array[ihl][ill] = (barr.m_array)[ihl][ill];
        }
      }
    }
    return *this;
  }

Member Data Documentation

m_array

template<class T >

std::vector<std::vector<SharedObject<T> > > Trk::BinnedArray2D< T >::m_array

private

forced 1D vector of pointers to class T

Definition at line 214 of file BinnedArray2D.h.

m_arrayObjects

template<class T >

CxxUtils::CachedUniquePtr<std::vector<T*> > Trk::BinnedArray2D< T >::m_arrayObjects

private

binUtility for retrieving and filling the Array

Definition at line 216 of file BinnedArray2D.h.

m_binUtility

template<class T >

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

private

Definition at line 218 of file BinnedArray2D.h.

---

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

• BinnedArray2D.h