ActsTrk::detail::TransformStore Class Reference

The TransformStore provides a central place to outsource the alignable transforms of the sensitive detector elements and the alignable volumes. More...

#include <TransformStore.h>

Collaboration diagram for ActsTrk::detail::TransformStore:

Public Types
enum class	Mode : std::uint8_t { LazyFill , Block }
	Enum describing the operation mode of the cache. More...

Public Member Functions
	TransformStore (const DetectorType detType, const Mode m)
	Constructor.
	TransformStore (TransformStore &&other) noexcept=default
	Define the move constructor.
TransformStore &	operator= (TransformStore &&other) noexcept=default
	Define the move assignment operator.
	TransformStore (const TransformStore &other) noexcept
	Define the copy constructor.
TransformStore &	operator= (const TransformStore &other) noexcept
	Define the copy assignment operator.
const Amg::Transform3D *	getTransform (const unsigned ticketNo) const
	Returns the pointer to the transfomation cached in the store (Might be a nullptr if LazyFill is used).
const Amg::Transform3D &	setTransform (const unsigned int ticketNo, Amg::Transform3D &&trf) const
	Stores a transform at the index of the passed ticket number.
const Amg::Transform3D &	setTransform (const unsigned int ticketNo, Amg::Transform3D &&trf)
	Stores a transform at the index of the passed ticket number.
Mode	mode () const
	Returns the mode with which the store has been instantiated.
DetectorType	detectorType () const
	Returns the detector type.
std::size_t	size () const
	Return the size (maximum capacity) of the current store.
std::size_t	filled () const
	Returns the number of filled transforms.

Static Public Member Functions
static std::string	toString (const Mode m)
	Define the to string operator.

Private Types
using	LazyStorage_t = std::vector<CxxUtils::CachedUniquePtr<Amg::Transform3D>>
	Abrivation of the backend in the lazy filling mode.
using	TrfVec_t = std::vector<Amg::Transform3D>
	Abrivate the transform vector.
using	CheckVec_t = std::vector<char>
	Abrivate the char vector.
using	BlockStorage_t = std::pair<TrfVec_t, CheckVec_t>
	Abrivation of the continous vector storage.
using	Storage_t = std::variant<LazyStorage_t, BlockStorage_t>
	Use the std::variant to dynamically switch between the two types.

Private Member Functions
std::ostream &	print (std::ostream &ostr) const

Static Private Member Functions
static Storage_t	initStorage (const DetectorType dType, const Mode mode) noexcept
	Helper method to instantiate the storage for a given detector type.

Private Attributes
Storage_t	m_storage {}
DetectorType	m_detType {ActsTrk::DetectorType::UnDefined}
	The associated detector type.

Friends
std::ostream &	operator<< (std::ostream &ostr, const Mode m)
std::ostream &	operator<< (std::ostream &ostr, const TransformStore &store)
	Define the to string ostream operator.

Detailed Description

The TransformStore provides a central place to outsource the alignable transforms of the sensitive detector elements and the alignable volumes.

For each subdetector, a cache of size N is provided (C.f. the TrfStoreTicketCounter how the cache size is managed). The transform store can be operated either in a LazyFilling mode where the memory is only assigned if the cache slot is actually needed. In this mode, the setTransform mehtod can be called on a const instance. Alternatively, the Store can be operated in Block mode, where tne the memory for N Transforms is allocated at instantiation and can only be filled if a non-const reference is passed

Definition at line 27 of file TransformStore.h.

Member Typedef Documentation

BlockStorage_t

using ActsTrk::detail::TransformStore::BlockStorage_t = std::pair<TrfVec_t, CheckVec_t>

private

Abrivation of the continous vector storage.

Definition at line 89 of file TransformStore.h.

CheckVec_t

using ActsTrk::detail::TransformStore::CheckVec_t = std::vector<char>

private

Abrivate the char vector.

Definition at line 87 of file TransformStore.h.

LazyStorage_t

using ActsTrk::detail::TransformStore::LazyStorage_t = std::vector<CxxUtils::CachedUniquePtr<Amg::Transform3D>>

private

Abrivation of the backend in the lazy filling mode.

Definition at line 83 of file TransformStore.h.

Storage_t

using ActsTrk::detail::TransformStore::Storage_t = std::variant<LazyStorage_t, BlockStorage_t>

private

Use the std::variant to dynamically switch between the two types.

Definition at line 91 of file TransformStore.h.

TrfVec_t

using ActsTrk::detail::TransformStore::TrfVec_t = std::vector<Amg::Transform3D>

private

Abrivate the transform vector.

Definition at line 85 of file TransformStore.h.

Member Enumeration Documentation

Mode

enum class ActsTrk::detail::TransformStore::Mode : std::uint8_t

strong

Enum describing the operation mode of the cache.

Enumerator
LazyFill
Block	Transforms can be set later during the event processing. Transforms can only be set if the Store is created and non-const.

Definition at line 30 of file TransformStore.h.

                           : std::uint8_t {
                LazyFill,   
                Block       
            };

Constructor & Destructor Documentation

TransformStore() [1/3]

ActsTrk::detail::TransformStore::TransformStore	(	const DetectorType	detType,
		const Mode	m )

Constructor.

Parameters

detType	Sub detector type to retrieve the information about how much memory needs to be allocated
m	Storage mode

Definition at line 47 of file TransformStore.cxx.

                                                :
        m_storage{initStorage(detType, m)},
        m_detType{detType} {}

TransformStore() [2/3]

ActsTrk::detail::TransformStore::TransformStore ( TransformStore && other )

defaultnoexcept

Define the move constructor.

TransformStore() [3/3]

ActsTrk::detail::TransformStore::TransformStore ( const TransformStore & other )

noexcept

Define the copy constructor.

Definition at line 51 of file TransformStore.cxx.

                                                                       :
        m_storage{initStorage(other.detectorType(), other.mode())},
        m_detType{other.detectorType()} {
        if (mode() == Mode::Block){
            for (std::size_t t = 0; t < size(); ++t) {
                if (const Amg::Transform3D* copyMe = other.getTransform(t); copyMe != nullptr) {
                    setTransform(t, Amg::Transform3D{*copyMe});
                }
            }
        }
    }

Member Function Documentation

detectorType()

DetectorType ActsTrk::detail::TransformStore::detectorType

(

)

const

Returns the detector type.

Definition at line 78 of file TransformStore.cxx.

{ return m_detType; }

filled()

std::size_t ActsTrk::detail::TransformStore::filled

(

)

const

Returns the number of filled transforms.

Definition at line 131 of file TransformStore.cxx.

                                           {
        return std::visit([](const auto& store) {
          using Store_t = std::decay_t<decltype(store)>;
          if constexpr(std::is_same_v<Store_t, LazyStorage_t>) {
              return std::count_if(store.begin(), store.end(), [](const auto& trf){
                  return trf.get() != nullptr;
              });
          } else if constexpr(std::is_same_v<Store_t, BlockStorage_t>) {
             return std::count_if(store.second.begin(), store.second.end(), [](const char filled){
                  return filled;
              });
          }
        }, m_storage);
    }

getTransform()

const Amg::Transform3D * ActsTrk::detail::TransformStore::getTransform ( const unsigned ticketNo ) const

inline

Returns the pointer to the transfomation cached in the store (Might be a nullptr if LazyFill is used).

Parameters

ticketNo

Unique ticket number drawn by the client indicating the index inside the storegae vector

Definition at line 139 of file TransformStore.h.

                                                                                           {
        return std::visit([&](auto& store) -> const Amg::Transform3D* {
            using Store_t = std::decay_t<decltype(store)>;
            if constexpr(std::is_same_v<Store_t, LazyStorage_t>) {
                assert(ticketNo < store.size());
                return store[ticketNo].get();
            } else if constexpr(std::is_same_v<Store_t, BlockStorage_t>) {
                assert(ticketNo < store.first.size());
                return store.second[ticketNo] ? &store.first[ticketNo] : nullptr;
            } else {
                return nullptr;
            }
        }, m_storage);
    }

initStorage()

TransformStore::Storage_t ActsTrk::detail::TransformStore::initStorage ( const DetectorType dType, const Mode mode )

staticprivatenoexcept

Helper method to instantiate the storage for a given detector type.

Parameters

dType	Subdetector system for which the transform storage needs to be instantiated
mode	The mode in which the storage shall be instantiated

Definition at line 31 of file TransformStore.cxx.

                                                                                    {
        const unsigned size = TrfStoreTicketCounter::distributedTickets(dType);
        switch (mode) {
            using enum Mode;
            case LazyFill: {
              LazyStorage_t store(size);
              return store;
            } case Block: {
               TrfVec_t trfStore(size, Amg::Transform3D::Identity());
               CheckVec_t isSet(size, 0);
               return std::make_pair(std::move(trfStore), std::move(isSet));
            }
        }
        return Storage_t{};
    }

mode()

TransformStore::Mode ActsTrk::detail::TransformStore::mode

(

)

const

Returns the mode with which the store has been instantiated.

Definition at line 120 of file TransformStore.cxx.

                                                  {
        return std::visit([&](const auto& store) {
          using Store_t = std::decay_t<decltype(store)>;
          if constexpr(std::is_same_v<Store_t, LazyStorage_t>) {
              return Mode::LazyFill;
          } else if constexpr(std::is_same_v<Store_t, BlockStorage_t>) {
              return Mode::Block;
          }
        }, m_storage);
    }

operator=() [1/2]

TransformStore & ActsTrk::detail::TransformStore::operator= ( const TransformStore & other )

noexcept

Define the copy assignment operator.

Definition at line 63 of file TransformStore.cxx.

                                                                                {
        if (&other != this) {
            m_storage = initStorage(other.detectorType(), other.mode());
            m_detType = other.detectorType();
            if (mode() == Mode::Block){
              for (std::size_t t = 0; t < size(); ++t) {
                if (const Amg::Transform3D* copyMe = other.getTransform(t); 
                    copyMe != nullptr) {
                    setTransform(t, Amg::Transform3D{*copyMe});
                }
              }
            }
        }
        return (*this);
    }

operator=() [2/2]

TransformStore & ActsTrk::detail::TransformStore::operator= ( TransformStore && other )

defaultnoexcept

Define the move assignment operator.

print()

std::ostream & ActsTrk::detail::TransformStore::print ( std::ostream & ostr ) const

private

Definition at line 23 of file TransformStore.cxx.

                                                            {
        const auto f = filled();
        const auto s = size();
        ostr<<detectorType()<<" transform store in mode: "<<mode()
            <<", size: "<<s<<", (un)allocated: ("<<(s- f)<<")"<<f;
        return ostr;
    }

setTransform() [1/2]

const Amg::Transform3D & ActsTrk::detail::TransformStore::setTransform	(	const unsigned int	ticketNo,
		Amg::Transform3D &&	trf )

Stores a transform at the index of the passed ticket number.

Parameters

ticketNo	Number of the ticket under which the transform should be cached
trf	Transform object to be stored

Returns

The reference to the transform to which the passed transform was assigned to

setTransform() [2/2]

const Amg::Transform3D & ActsTrk::detail::TransformStore::setTransform	(	const unsigned int	ticketNo,
		Amg::Transform3D &&	trf ) const

Stores a transform at the index of the passed ticket number.

(Only works if the LazyFill mode option is activated)

Parameters

ticketNo	Number of the ticket under which the transform should be cached
trf	Transform object to be stored

Returns

The reference to the transform to which the passed transform was assigned to

size()

std::size_t ActsTrk::detail::TransformStore::size

(

)

const

Return the size (maximum capacity) of the current store.

Definition at line 94 of file TransformStore.cxx.

                                         {
       return std::visit([](const auto& store){
          using Store_t = std::decay_t<decltype(store)>;
          if constexpr(std::is_same_v<Store_t, LazyStorage_t>) {
              return store.size();
          } else {
              return store.first.size();
          }
       }, m_storage);
    }

toString()

std::string ActsTrk::detail::TransformStore::toString ( const Mode m )

static

Define the to string operator.

Definition at line 15 of file TransformStore.cxx.

                                                   {
        switch (m) {
          using enum Mode; 
          case LazyFill: return "LazyFill";
          case Block: return "Block";
        }
        return "";
    }

Friends And Related Symbol Documentation

operator<< [1/2]

std::ostream & operator<< ( std::ostream & ostr, const Mode m )

friend

Definition at line 37 of file TransformStore.h.

                                                                               {
                return ostr<<toString(m);
            }

operator<< [2/2]

std::ostream & operator<< ( std::ostream & ostr, const TransformStore & store )

friend

Define the to string ostream operator.

Definition at line 41 of file TransformStore.h.

                                                                                              {
                return store.print(ostr);
            }

Member Data Documentation

m_detType

DetectorType ActsTrk::detail::TransformStore::m_detType {ActsTrk::DetectorType::UnDefined}

private

The associated detector type.

Definition at line 94 of file TransformStore.h.

{ActsTrk::DetectorType::UnDefined};

m_storage

Storage_t ActsTrk::detail::TransformStore::m_storage {}

private

Definition at line 92 of file TransformStore.h.

{};

---

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

• TransformStore.h
• TransformStore.cxx