PortableHostCollection< T > Class Template Reference

#include <PortableHostCollection.h>

Public Types
using	Buffer = cms::alpakatools::host_buffer< std::byte[]>
using	ConstBuffer = cms::alpakatools::const_host_buffer< std::byte[]>
using	ConstView = typename Layout::ConstView
using	Layout = T
using	View = typename Layout::View

Public Member Functions
Buffer	buffer ()
ConstBuffer	buffer () const
ConstBuffer	const_buffer () const
ConstView const &	const_view () const
View &	operator* ()
ConstView const &	operator* () const
View *	operator-> ()
ConstView const *	operator-> () const
PortableHostCollection &	operator= (PortableHostCollection const &)=delete
PortableHostCollection &	operator= (PortableHostCollection &&)=default
	PortableHostCollection ()=default
	PortableHostCollection (int32_t elements, alpaka_common::DevHost const &host)
template<typename TQueue , typename = std::enable_if_t<alpaka::isQueue<TQueue>>>
	PortableHostCollection (int32_t elements, TQueue const &queue)
	PortableHostCollection (PortableHostCollection const &)=delete
	PortableHostCollection (PortableHostCollection &&)=default
View &	view ()
ConstView const &	view () const
void	zeroInitialise ()
template<typename TQueue , typename = std::enable_if_t<alpaka::isQueue<TQueue>>>
void	zeroInitialise (TQueue &&queue)
	~PortableHostCollection ()=default

Static Public Member Functions
static void	ROOTReadStreamer (PortableHostCollection *newObj, Layout &layout)

Private Attributes
std::optional< Buffer >	buffer_
Layout	layout_
View	view_

Detailed Description

template<typename T>
class PortableHostCollection< T >

Definition at line 16 of file PortableHostCollection.h.

Member Typedef Documentation

Buffer

template<typename T>

using PortableHostCollection< T >::Buffer = cms::alpakatools::host_buffer<std::byte[]>

Definition at line 21 of file PortableHostCollection.h.

ConstBuffer

template<typename T>

using PortableHostCollection< T >::ConstBuffer = cms::alpakatools::const_host_buffer<std::byte[]>

Definition at line 22 of file PortableHostCollection.h.

ConstView

template<typename T>

using PortableHostCollection< T >::ConstView = typename Layout::ConstView

Definition at line 20 of file PortableHostCollection.h.

Layout

template<typename T>

using PortableHostCollection< T >::Layout = T

Definition at line 18 of file PortableHostCollection.h.

View

template<typename T>

using PortableHostCollection< T >::View = typename Layout::View

Definition at line 19 of file PortableHostCollection.h.

Constructor & Destructor Documentation

PortableHostCollection() [1/5]

template<typename T>

PortableHostCollection< T >::PortableHostCollection ( )

default

Referenced by PortableHostCollection< TestSoA >::ROOTReadStreamer().

PortableHostCollection() [2/5]

template<typename T>

PortableHostCollection< T >::PortableHostCollection ( int32_t  elements, alpaka_common::DevHost const &  host  )

inline

Definition at line 26 of file PortableHostCollection.h.

      : buffer_{cms::alpakatools::make_host_buffer<std::byte[]>(Layout::computeDataSize(elements))},
        layout_{buffer_->data(), elements},
        view_{layout_} {
    // Alpaka set to a default alignment of 128 bytes defining ALPAKA_DEFAULT_HOST_MEMORY_ALIGNMENT=128
    assert(reinterpret_cast<uintptr_t>(buffer_->data()) % Layout::alignment == 0);
  }

PortableHostCollection() [3/5]

template<typename T>

template<typename TQueue , typename = std::enable_if_t<alpaka::isQueue<TQueue>>>

PortableHostCollection< T >::PortableHostCollection ( int32_t  elements, TQueue const &  queue  )

inline

Definition at line 36 of file PortableHostCollection.h.

      : buffer_{cms::alpakatools::make_host_buffer<std::byte[]>(queue, Layout::computeDataSize(elements))},
        layout_{buffer_->data(), elements},
        view_{layout_} {
    // Alpaka set to a default alignment of 128 bytes defining ALPAKA_DEFAULT_HOST_MEMORY_ALIGNMENT=128
    assert(reinterpret_cast<uintptr_t>(buffer_->data()) % Layout::alignment == 0);
  }

PortableHostCollection() [4/5]

template<typename T>

PortableHostCollection< T >::PortableHostCollection ( PortableHostCollection< T > const &  )

delete

PortableHostCollection() [5/5]

template<typename T>

PortableHostCollection< T >::PortableHostCollection ( PortableHostCollection< T > &&  )

default

~PortableHostCollection()

template<typename T>

PortableHostCollection< T >::~PortableHostCollection ( )

default

Referenced by PortableHostCollection< TestSoA >::ROOTReadStreamer().

Member Function Documentation

buffer() [1/2]

template<typename T>

Buffer PortableHostCollection< T >::buffer ( )

inline

Definition at line 68 of file PortableHostCollection.h.

Referenced by TestAlpakaAnalyzer::analyze(), cms::alpakatools::CopyToDevice< PortableHostCollection< TLayout > >::copyAsync(), and ALPAKA_ACCELERATOR_NAMESPACE::TestHelperClass::makeAsync().

{ return *buffer_; }

buffer() [2/2]

template<typename T>

ConstBuffer PortableHostCollection< T >::buffer ( ) const

inline

Definition at line 69 of file PortableHostCollection.h.

{ return *buffer_; }

const_buffer()

template<typename T>

ConstBuffer PortableHostCollection< T >::const_buffer ( ) const

inline

Definition at line 70 of file PortableHostCollection.h.

{ return *buffer_; }

const_view()

template<typename T>

ConstView const& PortableHostCollection< T >::const_view ( ) const

inline

Definition at line 59 of file PortableHostCollection.h.

Referenced by TestAlpakaAnalyzer::analyze(), L2TauNNProducerAlpaka::fillPatatracks(), LegacyPFRecHitProducer::produce(), and L2TauNNProducerAlpaka::selectGoodTracksAndVertices().

{ return view_; }

operator*() [1/2]

template<typename T>

View& PortableHostCollection< T >::operator* ( void  )

inline

Definition at line 61 of file PortableHostCollection.h.

{ return view_; }

operator*() [2/2]

template<typename T>

ConstView const& PortableHostCollection< T >::operator* ( void  ) const

inline

Definition at line 62 of file PortableHostCollection.h.

{ return view_; }

operator->() [1/2]

template<typename T>

View* PortableHostCollection< T >::operator-> ( )

inline

Definition at line 64 of file PortableHostCollection.h.

{ return &view_; }

operator->() [2/2]

template<typename T>

ConstView const* PortableHostCollection< T >::operator-> ( ) const

inline

Definition at line 65 of file PortableHostCollection.h.

{ return &view_; }

operator=() [1/2]

template<typename T>

PortableHostCollection& PortableHostCollection< T >::operator= ( PortableHostCollection< T > const &  )

delete

operator=() [2/2]

template<typename T>

PortableHostCollection& PortableHostCollection< T >::operator= ( PortableHostCollection< T > &&  )

default

ROOTReadStreamer()

template<typename T>

static void PortableHostCollection< T >::ROOTReadStreamer ( PortableHostCollection< T > *  newObj, Layout &  layout  )

inlinestatic

Definition at line 83 of file PortableHostCollection.h.

                                                                               {
    // destroy the default-constructed collection
    newObj->~PortableHostCollection();
    // construct in-place a new collection, with the known size, using the global "host" object returned by cms::alpakatools::host()
    new (newObj) PortableHostCollection(layout.metadata().size(), cms::alpakatools::host());
    // copy the data from the on-file layout to the new collection
    newObj->layout_.ROOTReadStreamer(layout);
    // free the memory allocated by ROOT
    layout.ROOTStreamerCleaner();
  }

view() [1/2]

template<typename T>

View& PortableHostCollection< T >::view ( )

inline

Definition at line 57 of file PortableHostCollection.h.

Referenced by TestAlpakaAnalyzer::analyze(), L2TauNNProducerAlpaka::fillPatatracks(), L2TauNNProducerAlpaka::impactParameter(), ALPAKA_ACCELERATOR_NAMESPACE::HcalDigisSoAProducer::produce(), ALPAKA_ACCELERATOR_NAMESPACE::TestAlpakaESProducerC::produce(), ALPAKA_ACCELERATOR_NAMESPACE::SiPixelCablingSoAESProducer::produce(), and L2TauNNProducerAlpaka::selectGoodTracksAndVertices().

{ return view_; }

view() [2/2]

template<typename T>

ConstView const& PortableHostCollection< T >::view ( ) const

inline

Definition at line 58 of file PortableHostCollection.h.

{ return view_; }

zeroInitialise() [1/2]

template<typename T>

void PortableHostCollection< T >::zeroInitialise ( )

inline

Definition at line 73 of file PortableHostCollection.h.

                        {
    std::memset(std::data(*buffer_), 0x00, alpaka::getExtentProduct(*buffer_) * sizeof(std::byte));
  }

zeroInitialise() [2/2]

template<typename T>

template<typename TQueue , typename = std::enable_if_t<alpaka::isQueue<TQueue>>>

void PortableHostCollection< T >::zeroInitialise ( TQueue &&  queue )

inline

Definition at line 78 of file PortableHostCollection.h.

                                      {
    alpaka::memset(std::forward<TQueue>(queue), *buffer_, 0x00);
  }

Member Data Documentation

buffer_

template<typename T>

std::optional<Buffer> PortableHostCollection< T >::buffer_

private

Definition at line 95 of file PortableHostCollection.h.

Referenced by PortableHostCollection< TestSoA >::buffer(), PortableHostCollection< TestSoA >::const_buffer(), and PortableHostCollection< TestSoA >::zeroInitialise().

layout_

template<typename T>

Layout PortableHostCollection< T >::layout_

private

Definition at line 96 of file PortableHostCollection.h.

Referenced by PortableHostCollection< TestSoA >::ROOTReadStreamer().

view_

template<typename T>

View PortableHostCollection< T >::view_

private

Definition at line 97 of file PortableHostCollection.h.

Referenced by PortableHostCollection< TestSoA >::const_view(), PortableHostCollection< TestSoA >::operator*(), PortableHostCollection< TestSoA >::operator->(), and PortableHostCollection< TestSoA >::view().