PortableHostObject< T > Class Template Reference

#include <PortableHostObject.h>

Public Types
using	Buffer = cms::alpakatools::host_buffer< Product >
using	ConstBuffer = cms::alpakatools::const_host_buffer< Product >
using	Product = T

Public Member Functions
Buffer	buffer ()
ConstBuffer	buffer () const
ConstBuffer	const_buffer () const
Product const *	const_data () const
Product const &	const_value () const
Product *	data ()
Product const *	data () const
Product &	operator* ()
Product const &	operator* () const
Product *	operator-> ()
Product const *	operator-> () const
PortableHostObject &	operator= (PortableHostObject const &)=delete
PortableHostObject &	operator= (PortableHostObject &&)=default
	PortableHostObject ()=default
	PortableHostObject (alpaka_common::DevHost const &host)
template<typename TQueue , typename = std::enable_if_t<alpaka::isQueue<TQueue>>>
	PortableHostObject (TQueue const &queue)
	PortableHostObject (PortableHostObject const &)=delete
	PortableHostObject (PortableHostObject &&)=default
Product &	value ()
Product const &	value () const
void	zeroInitialise ()
template<typename TQueue , typename = std::enable_if_t<alpaka::isQueue<TQueue>>>
void	zeroInitialise (TQueue &&queue)
	~PortableHostObject ()=default

Static Public Member Functions
static void	ROOTReadStreamer (PortableHostObject *newObj, Product &product)

Private Attributes
std::optional< Buffer >	buffer_
Product *	product_

Detailed Description

template<typename T>
class PortableHostObject< T >

Definition at line 16 of file PortableHostObject.h.

Member Typedef Documentation

Buffer

template<typename T>

using PortableHostObject< T >::Buffer = cms::alpakatools::host_buffer<Product>

Definition at line 19 of file PortableHostObject.h.

ConstBuffer

template<typename T>

using PortableHostObject< T >::ConstBuffer = cms::alpakatools::const_host_buffer<Product>

Definition at line 20 of file PortableHostObject.h.

Product

template<typename T>

using PortableHostObject< T >::Product = T

Definition at line 18 of file PortableHostObject.h.

Constructor & Destructor Documentation

PortableHostObject() [1/5]

template<typename T>

PortableHostObject< T >::PortableHostObject ( )

default

Referenced by PortableHostObject< T >::ROOTReadStreamer().

PortableHostObject() [2/5]

template<typename T>

PortableHostObject< T >::PortableHostObject ( alpaka_common::DevHost const &  host )

inline

Definition at line 24 of file PortableHostObject.h.

      : buffer_{cms::alpakatools::make_host_buffer<Product>()}, product_{buffer_->data()} {
    assert(reinterpret_cast<uintptr_t>(product_) % alignof(Product) == 0);
  }

PortableHostObject() [3/5]

template<typename T>

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

PortableHostObject< T >::PortableHostObject ( TQueue const &  queue )

inline

Definition at line 31 of file PortableHostObject.h.

References createBeamHaloJobs::queue.

      : buffer_{cms::alpakatools::make_host_buffer<Product>(queue)}, product_{buffer_->data()} {
    assert(reinterpret_cast<uintptr_t>(product_) % alignof(Product) == 0);
  }

PortableHostObject() [4/5]

template<typename T>

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

delete

PortableHostObject() [5/5]

template<typename T>

PortableHostObject< T >::PortableHostObject ( PortableHostObject< T > &&  )

default

~PortableHostObject()

template<typename T>

PortableHostObject< T >::~PortableHostObject ( )

default

Referenced by PortableHostObject< T >::ROOTReadStreamer().

Member Function Documentation

buffer() [1/2]

template<typename T>

Buffer PortableHostObject< T >::buffer ( )

inline

Definition at line 64 of file PortableHostObject.h.

References PortableHostObject< T >::buffer_.

Referenced by TestAlpakaObjectAnalyzer::analyze(), cms::alpakatools::CopyToHost< PortableDeviceObject< TProduct, TDevice > >::copyAsync(), and cms::alpakatools::CopyToDevice< PortableHostObject< TProduct > >::copyAsync().

{ return *buffer_; }

buffer() [2/2]

template<typename T>

ConstBuffer PortableHostObject< T >::buffer ( ) const

inline

Definition at line 65 of file PortableHostObject.h.

References PortableHostObject< T >::buffer_.

{ return *buffer_; }

const_buffer()

template<typename T>

ConstBuffer PortableHostObject< T >::const_buffer ( ) const

inline

Definition at line 66 of file PortableHostObject.h.

References PortableHostObject< T >::buffer_.

{ return *buffer_; }

const_data()

template<typename T>

Product const* PortableHostObject< T >::const_data ( ) const

inline

Definition at line 55 of file PortableHostObject.h.

References PortableHostObject< T >::product_.

{ return product_; }

const_value()

template<typename T>

Product const& PortableHostObject< T >::const_value ( ) const

inline

Definition at line 51 of file PortableHostObject.h.

References PortableHostObject< T >::product_.

{ return *product_; }

data() [1/2]

template<typename T>

Product* PortableHostObject< T >::data ( )

inline

Definition at line 53 of file PortableHostObject.h.

References PortableHostObject< T >::product_.

Referenced by TestAlpakaObjectAnalyzer::analyze().

{ return product_; }

data() [2/2]

template<typename T>

Product const* PortableHostObject< T >::data ( ) const

inline

Definition at line 54 of file PortableHostObject.h.

References PortableHostObject< T >::product_.

{ return product_; }

operator*() [1/2]

template<typename T>

Product& PortableHostObject< T >::operator* ( void  )

inline

Definition at line 57 of file PortableHostObject.h.

References PortableHostObject< T >::product_.

{ return *product_; }

operator*() [2/2]

template<typename T>

Product const& PortableHostObject< T >::operator* ( void  ) const

inline

Definition at line 58 of file PortableHostObject.h.

References PortableHostObject< T >::product_.

{ return *product_; }

operator->() [1/2]

template<typename T>

Product* PortableHostObject< T >::operator-> ( )

inline

Definition at line 60 of file PortableHostObject.h.

References PortableHostObject< T >::product_.

{ return product_; }

operator->() [2/2]

template<typename T>

Product const* PortableHostObject< T >::operator-> ( ) const

inline

Definition at line 61 of file PortableHostObject.h.

References PortableHostObject< T >::product_.

{ return product_; }

operator=() [1/2]

template<typename T>

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

delete

operator=() [2/2]

template<typename T>

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

default

ROOTReadStreamer()

template<typename T>

static void PortableHostObject< T >::ROOTReadStreamer ( PortableHostObject< T > *  newObj, Product &  product  )

inlinestatic

Definition at line 79 of file PortableHostObject.h.

References cms::alpakatools::host(), PortableHostObject< T >::PortableHostObject(), PortableHostObject< T >::product_, and PortableHostObject< T >::~PortableHostObject().

                                                                             {
    // destroy the default-constructed object
    newObj->~PortableHostObject();
    // use the global "host" object returned by cms::alpakatools::host()
    new (newObj) PortableHostObject(cms::alpakatools::host());
    // copy the data from the on-file object to the new one
    std::memcpy(newObj->product_, &product, sizeof(Product));
  }

value() [1/2]

template<typename T>

Product& PortableHostObject< T >::value ( )

inline

Definition at line 49 of file PortableHostObject.h.

References PortableHostObject< T >::product_.

Referenced by Types.int32::__nonzero__(), Types.uint32::__nonzero__(), Types.int64::__nonzero__(), Types.uint64::__nonzero__(), Types.double::__nonzero__(), Types.bool::__nonzero__(), Types.string::__nonzero__(), TestAlpakaObjectAnalyzer::analyze(), average.Average::average(), Types.string::configValue(), Types.FileInPath::configValue(), Mixins.UsingBlock::dumpPython(), Mixins.UsingBlock::insertInto(), Types.int32::insertInto(), Types.uint32::insertInto(), Types.int64::insertInto(), Types.uint64::insertInto(), Types.double::insertInto(), Types.bool::insertInto(), Types.string::insertInto(), Types.FileInPath::insertInto(), Types.vint32::insertInto(), Types.vuint32::insertInto(), Types.vint64::insertInto(), Types.vuint64::insertInto(), Types.vdouble::insertInto(), Types.vbool::insertInto(), and Types.vstring::insertInto().

{ return *product_; }

value() [2/2]

template<typename T>

Product const& PortableHostObject< T >::value ( ) const

inline

Definition at line 50 of file PortableHostObject.h.

References PortableHostObject< T >::product_.

Referenced by Types.int32::__nonzero__(), Types.uint32::__nonzero__(), Types.int64::__nonzero__(), Types.uint64::__nonzero__(), Types.double::__nonzero__(), Types.bool::__nonzero__(), Types.string::__nonzero__(), average.Average::average(), Types.string::configValue(), Types.FileInPath::configValue(), Mixins.UsingBlock::dumpPython(), Mixins.UsingBlock::insertInto(), Types.int32::insertInto(), Types.uint32::insertInto(), Types.int64::insertInto(), Types.uint64::insertInto(), Types.double::insertInto(), Types.bool::insertInto(), Types.string::insertInto(), Types.FileInPath::insertInto(), Types.vint32::insertInto(), Types.vuint32::insertInto(), Types.vint64::insertInto(), Types.vuint64::insertInto(), Types.vdouble::insertInto(), Types.vbool::insertInto(), and Types.vstring::insertInto().

{ return *product_; }

zeroInitialise() [1/2]

template<typename T>

void PortableHostObject< T >::zeroInitialise ( )

inline

Definition at line 69 of file PortableHostObject.h.

References PortableHostObject< T >::buffer_, and data.

                        {
    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 PortableHostObject< T >::zeroInitialise ( TQueue &&  queue )

inline

Definition at line 74 of file PortableHostObject.h.

References PortableHostObject< T >::buffer_, and createBeamHaloJobs::queue.

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

Member Data Documentation

buffer_

template<typename T>

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

private

Definition at line 89 of file PortableHostObject.h.

Referenced by PortableHostObject< T >::buffer(), PortableHostObject< T >::const_buffer(), and PortableHostObject< T >::zeroInitialise().

product_

template<typename T>

Product* PortableHostObject< T >::product_

private

Definition at line 90 of file PortableHostObject.h.

Referenced by PortableHostObject< T >::const_data(), PortableHostObject< T >::const_value(), PortableHostObject< T >::data(), PortableHostObject< T >::operator*(), PortableHostObject< T >::operator->(), PortableHostObject< T >::ROOTReadStreamer(), and PortableHostObject< T >::value().