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

#include <NavBinnedArray1D.h>

Inheritance diagram for Trk::NavBinnedArray1D< T >:

Collaboration diagram for Trk::NavBinnedArray1D< T >:

Public Member Functions
	NavBinnedArray1D ()=default
	NavBinnedArray1D (NavBinnedArray1D &&)=default
NavBinnedArray1D &	operator= (NavBinnedArray1D &&)=default
	~NavBinnedArray1D ()=default
	NavBinnedArray1D (const std::vector< std::shared_ptr< T > > &tclassvector, const BinUtility &bingen, const Amg::Transform3D &transform)
	Constructor with std::vector and a BinUtility - reference counted, will delete objects at the end, if this deletion should be turned off, the boolean deletion should be switched to false the global position is given by pointer and then deleted!
	NavBinnedArray1D (const NavBinnedArray1D &barr, std::vector< std::shared_ptr< T > > &&vec, const Amg::Transform3D &shift)
	Copy Constructor with shift.
	NavBinnedArray1D (const NavBinnedArray1D &barr)
	Copy Constructor.
NavBinnedArray1D &	operator= (const NavBinnedArray1D &barr)
	Assignment operator.
NavBinnedArray1D *	clone () const
	Implicit Constructor.
T *	object (const Amg::Vector2D &lp) const
	Returns the pointer to the templated class object from the BinnedArray, it returns nullptr if not defined;.
T *	object (const Amg::Vector3D &gp) const
	Returns the pointer to the templated class object from the BinnedArray it returns nullptr if not defined;.
T *	entryObject (const Amg::Vector3D &) const
	Returns the pointer to the templated class object from the BinnedArray - entry point.
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.
std::span< T *const >	arrayObjects ()
	Return all objects of the Array non-const T.
std::span< T const *const >	arrayObjects () const
	Return all objects of the Array const T.
unsigned int	arrayObjectsNumber () const
	Number of Entries in the Array.
const BinUtility *	binUtility () const
	Return the BinUtility.
const Amg::Transform3D *	transform () const
	Return the transform.
void	updateTransform (Amg::Transform3D &transform)
	Reposition.

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

Private Attributes
std::vector< std::shared_ptr< T > >	m_array
	1D vector of cached not owning pointers to class T
CxxUtils::CachedUniquePtr< std::vector< T * > >	m_arrayObjects
	binUtility for retrieving and filling the Array
BinUtility	m_binUtility
Amg::Transform3D	m_transf

Detailed Description

template<class T>
class Trk::NavBinnedArray1D< T >

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

For use within navigation objects, global coordinates/transform refer to the position within mother navigation object

Author: Andre.nosp@m.as.S.nosp@m.alzbu.nosp@m.rger.nosp@m.@cern.nosp@m..ch, Sarka.nosp@m..Tod.nosp@m.orova.nosp@m.@cer.nosp@m.n.ch; Christos Anastopoulos (Athena MT modifications)

Definition at line 35 of file NavBinnedArray1D.h.

Constructor & Destructor Documentation

◆ NavBinnedArray1D() [1/5]

template<class T>

Trk::NavBinnedArray1D< T >::NavBinnedArray1D ( )

default

◆ NavBinnedArray1D() [2/5]

template<class T>

Trk::NavBinnedArray1D< T >::NavBinnedArray1D ( NavBinnedArray1D< T > && )

default

◆ ~NavBinnedArray1D()

template<class T>

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

default

◆ NavBinnedArray1D() [3/5]

template<class T>

Trk::NavBinnedArray1D< T >::NavBinnedArray1D	(	const std::vector< std::shared_ptr< T > > &	tclassvector,
		const BinUtility &	bingen,
		const Amg::Transform3D &	transform )

inline

Constructor with std::vector and a BinUtility - reference counted, will delete objects at the end, if this deletion should be turned off, the boolean deletion should be switched to false the global position is given by pointer and then deleted!

Definition at line 49 of file NavBinnedArray1D.h.

     : BinnedArray<T>(),
       m_array{tclassvector},
       m_arrayObjects(nullptr),
       m_binUtility(bingen),
       m_transf(transform) {}

◆ NavBinnedArray1D() [4/5]

template<class T>

Trk::NavBinnedArray1D< T >::NavBinnedArray1D	(	const NavBinnedArray1D< T > &	barr,
		std::vector< std::shared_ptr< T > > &&	vec,
		const Amg::Transform3D &	shift )

inline

Copy Constructor with shift.

Definition at line 58 of file NavBinnedArray1D.h.

    : BinnedArray<T>()
    , m_array(std::move(vec))
    , m_arrayObjects{}
    , m_binUtility(barr.m_binUtility)
    , m_transf(Amg::Transform3D(shift * (barr.m_transf)))
  {}

◆ NavBinnedArray1D() [5/5]

template<class T>

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

inline

Copy Constructor.

Definition at line 69 of file NavBinnedArray1D.h.

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

Member Function Documentation

◆ arrayObjects() [1/2]

template<class T>

std::span< T *const > Trk::NavBinnedArray1D< T >::arrayObjects ( )

inlinevirtual

Return all objects of the Array non-const T.

Implements Trk::BinnedArray< T >.

Definition at line 148 of file NavBinnedArray1D.h.

  {
    createArrayCache();
    return std::span<T* const>(m_arrayObjects->begin(),m_arrayObjects->end());
  }

◆ arrayObjects() [2/2]

template<class T>

std::span< T const *const > Trk::NavBinnedArray1D< T >::arrayObjects ( ) const

inlinevirtual

Return all objects of the Array const T.

Implements Trk::BinnedArray< T >.

Definition at line 155 of file NavBinnedArray1D.h.

  {
    createArrayCache();
    return std::span<T const * const>(m_arrayObjects->begin(), m_arrayObjects->end());
  }

◆ arrayObjectsNumber()

template<class T>

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

inlinevirtual

Number of Entries in the Array.

Implements Trk::BinnedArray< T >.

Definition at line 162 of file NavBinnedArray1D.h.

162{ return arrayObjects().size(); }

Trk::NavBinnedArray1D::arrayObjects

std::span< T *const > arrayObjects()

Return all objects of the Array non-const T.

Definition NavBinnedArray1D.h:148

◆ binUtility()

template<class T>

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

inlinevirtual

Return the BinUtility.

Implements Trk::BinnedArray< T >.

Definition at line 165 of file NavBinnedArray1D.h.

165{ return &m_binUtility; }

◆ clone()

template<class T>

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

inlinevirtual

Implicit Constructor.

Implements Trk::BinnedArray< T >.

Definition at line 92 of file NavBinnedArray1D.h.

92{ return new NavBinnedArray1D(*this); }

Trk::NavBinnedArray1D::NavBinnedArray1D

NavBinnedArray1D()=default

◆ createArrayCache()

template<class T>

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

inlineprivate

vector of pointers to the class T

Definition at line 177 of file NavBinnedArray1D.h.

◆ entryObject()

template<class T>

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

inlinevirtual

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

Implements Trk::BinnedArray< T >.

Definition at line 119 of file NavBinnedArray1D.h.

119{ return (m_array[0]).get(); }

◆ nextObject()

template<class T>

T * Trk::NavBinnedArray1D< 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 123 of file NavBinnedArray1D.h.

  {
    // transform into navig.coordinates
    const Amg::Vector3D navGP((m_transf.inverse()) * gp);
    const Amg::Vector3D navMom((m_transf.inverse()).linear() * mom);
    // the bins
    size_t firstBin = m_binUtility.next(navGP, navMom, 0);
    // use the information of the associated result
    if (associatedResult) {
      if (firstBin <= m_binUtility.max(0)) {
        return (m_array[firstBin]).get();
      } else {
        return nullptr;
      }
    }
    // the associated result was 0 -> set to boundary
    firstBin = (firstBin < m_binUtility.bins(0))
                 ? firstBin
                 : m_binUtility.max(0);
    return (m_array[m_binUtility.bin(navGP)]).get();
  }

◆ object() [1/2]

template<class T>

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

inlinevirtual

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

Implements Trk::BinnedArray< T >.

Definition at line 97 of file NavBinnedArray1D.h.

  {
    if (m_binUtility.inside(lp)) {
      return (m_array[m_binUtility.bin(lp)]).get();
    }
    return nullptr;
  }

◆ object() [2/2]

template<class T>

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

inlinevirtual

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

Implements Trk::BinnedArray< T >.

Definition at line 107 of file NavBinnedArray1D.h.

  {
    // transform into navig.coordinates
    const Amg::Vector3D navGP((m_transf.inverse()) * gp);
    if (m_binUtility.inside(navGP)) {
      return (m_array[m_binUtility.bin(navGP)]).get();
    }
    return nullptr;
  }

◆ operator=() [1/2]

template<class T>

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

inline

Assignment operator.

Definition at line 79 of file NavBinnedArray1D.h.

  {
    if (this != &barr) {
      m_arrayObjects.release();
      m_binUtility = barr.m_binUtility;
      // --------------------------------------------------------------------------
      m_array = (barr.m_array);
      m_transf = barr.m_transf;
    }
    return *this;
  }

◆ operator=() [2/2]

template<class T>

NavBinnedArray1D & Trk::NavBinnedArray1D< T >::operator= ( NavBinnedArray1D< T > && )

default

◆ transform()

template<class T>

const Amg::Transform3D * Trk::NavBinnedArray1D< T >::transform ( ) const

inline

Return the transform.

Definition at line 168 of file NavBinnedArray1D.h.

168{ return &m_transf; }

◆ updateTransform()

template<class T>

void Trk::NavBinnedArray1D< T >::updateTransform ( Amg::Transform3D & transform )

inline

Reposition.

Definition at line 171 of file NavBinnedArray1D.h.

  {
    m_transf = Amg::Transform3D(transform * m_transf);
  }

Member Data Documentation

◆ m_array

template<class T>

std::vector<std::shared_ptr<T> > Trk::NavBinnedArray1D< T >::m_array

private

1D vector of cached not owning pointers to class T

Definition at line 189 of file NavBinnedArray1D.h.

◆ m_arrayObjects

template<class T>

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

private

binUtility for retrieving and filling the Array

Definition at line 191 of file NavBinnedArray1D.h.

◆ m_binUtility

template<class T>

BinUtility Trk::NavBinnedArray1D< T >::m_binUtility

private

Definition at line 193 of file NavBinnedArray1D.h.

◆ m_transf

template<class T>

Amg::Transform3D Trk::NavBinnedArray1D< T >::m_transf

private

Definition at line 195 of file NavBinnedArray1D.h.

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

NavBinnedArray1D.h

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ NavBinnedArray1D() [1/5]

◆ NavBinnedArray1D() [2/5]

◆ ~NavBinnedArray1D()

◆ NavBinnedArray1D() [3/5]

◆ NavBinnedArray1D() [4/5]

◆ NavBinnedArray1D() [5/5]

Member Function Documentation

◆ arrayObjects() [1/2]

◆ arrayObjects() [2/2]

◆ arrayObjectsNumber()

◆ binUtility()

◆ clone()

◆ createArrayCache()

◆ entryObject()

◆ nextObject()

◆ object() [1/2]

◆ object() [2/2]

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ transform()

◆ updateTransform()

Member Data Documentation

◆ m_array

◆ m_arrayObjects

◆ m_binUtility

◆ m_transf