Analysis Software
Documentation for sPHENIX simulation software
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Acts::Sycl::QueueWrapper Class Reference

#include <acts/blob/sPHENIX/Plugins/Sycl/include/Acts/Plugins/Sycl/Utilities/QueueWrapper.hpp>

+ Collaboration diagram for Acts::Sycl::QueueWrapper:

Public Member Functions

 QueueWrapper (const std::string &="", std::unique_ptr< const Logger > logger=getDefaultLogger("Sycl::QueueWrapper", Logging::INFO))
 
 QueueWrapper (cl::sycl::queue &queue, std::unique_ptr< const Logger > logger=getDefaultLogger("Sycl::QueueWrapper", Logging::INFO))
 Constructor around an existing queue object.
 
 QueueWrapper (QueueWrapper &&parent) noexcept
 
 QueueWrapper (const QueueWrapper &other)
 
 ~QueueWrapper ()
 
QueueWrapperoperator= (QueueWrapper &&rhs) noexcept
 Move assignment operator.
 
QueueWrapperoperator= (const QueueWrapper &other)
 Copy assignment operator.
 
Accessor functions/operators
const cl::sycl::queue * getQueue () const
 Get stored pointer (const)
 
cl::sycl::queue * getQueue ()
 Get stored pointer (non-const)
 
const cl::sycl::queue * operator-> () const
 Operator implementing smart pointer behaviour (const)
 
cl::sycl::queue * operator-> ()
 Operator implementing smart pointer behaviour (non-const)
 
const cl::sycl::queue & operator* () const
 De-referencing operator (const)
 
cl::sycl::queue & operator* ()
 De-referencing operator (non-const)
 

Private Member Functions

const Loggerlogger () const
 Logger accessor.
 

Private Attributes

cl::sycl::queue * m_queue
 Raw pointer to SYCL queue object.
 
bool m_ownsQueue
 Owns queue.
 
std::unique_ptr< const Loggerm_logger
 The logger object.
 

Detailed Description

Definition at line 27 of file QueueWrapper.hpp.

View newest version in sPHENIX GitHub at line 27 of file QueueWrapper.hpp

Constructor & Destructor Documentation

Acts::Sycl::QueueWrapper::QueueWrapper ( const std::string &  deviceNameSubstring = "",
std::unique_ptr< const Logger logger = getDefaultLogger("Sycl::QueueWrapper", Logging::INFO) 
)

Create queue with default selector or given name Default constructed queue wrappers are owners.

Definition at line 24 of file QueueWrapper.cpp.

View newest version in sPHENIX GitHub at line 24 of file QueueWrapper.cpp

References ACTS_FATAL, ACTS_INFO, Acts::UnitConstants::e, m_ownsQueue, m_queue, and perf_headwind::name.

Acts::Sycl::QueueWrapper::QueueWrapper ( cl::sycl::queue &  queue,
std::unique_ptr< const Logger logger = getDefaultLogger("Sycl::QueueWrapper", Logging::INFO) 
)

Constructor around an existing queue object.

Definition at line 48 of file QueueWrapper.cpp.

View newest version in sPHENIX GitHub at line 48 of file QueueWrapper.cpp

Acts::Sycl::QueueWrapper::QueueWrapper ( QueueWrapper &&  parent)
noexcept

Move constructor It takes ownership (if it is given).

Definition at line 54 of file QueueWrapper.cpp.

View newest version in sPHENIX GitHub at line 54 of file QueueWrapper.cpp

Acts::Sycl::QueueWrapper::QueueWrapper ( const QueueWrapper other)

Copy constructor Does not give ownership to the underlying pointer.

Definition at line 62 of file QueueWrapper.cpp.

View newest version in sPHENIX GitHub at line 62 of file QueueWrapper.cpp

Acts::Sycl::QueueWrapper::~QueueWrapper ( )

Destructor Destroy the underlying pointer, but only if it is owned.

Definition at line 67 of file QueueWrapper.cpp.

View newest version in sPHENIX GitHub at line 67 of file QueueWrapper.cpp

References m_ownsQueue, and m_queue.

Member Function Documentation

const cl::sycl::queue * Acts::Sycl::QueueWrapper::getQueue ( ) const

Get stored pointer (const)

Definition at line 106 of file QueueWrapper.cpp.

View newest version in sPHENIX GitHub at line 106 of file QueueWrapper.cpp

References m_queue.

Referenced by Acts::Sycl::createSeedsForGroupSycl(), and main().

+ Here is the caller graph for this function:

cl::sycl::queue * Acts::Sycl::QueueWrapper::getQueue ( )

Get stored pointer (non-const)

Definition at line 110 of file QueueWrapper.cpp.

View newest version in sPHENIX GitHub at line 110 of file QueueWrapper.cpp

References m_queue.

const Logger& Acts::Sycl::QueueWrapper::logger ( ) const
inlineprivate

Logger accessor.

Definition at line 82 of file QueueWrapper.hpp.

View newest version in sPHENIX GitHub at line 82 of file QueueWrapper.hpp

References m_logger.

const cl::sycl::queue & Acts::Sycl::QueueWrapper::operator* ( ) const

De-referencing operator (const)

Definition at line 122 of file QueueWrapper.cpp.

View newest version in sPHENIX GitHub at line 122 of file QueueWrapper.cpp

References m_queue.

cl::sycl::queue & Acts::Sycl::QueueWrapper::operator* ( )

De-referencing operator (non-const)

Definition at line 126 of file QueueWrapper.cpp.

View newest version in sPHENIX GitHub at line 126 of file QueueWrapper.cpp

References m_queue.

const cl::sycl::queue * Acts::Sycl::QueueWrapper::operator-> ( ) const

Operator implementing smart pointer behaviour (const)

Definition at line 114 of file QueueWrapper.cpp.

View newest version in sPHENIX GitHub at line 114 of file QueueWrapper.cpp

References m_queue.

cl::sycl::queue * Acts::Sycl::QueueWrapper::operator-> ( )

Operator implementing smart pointer behaviour (non-const)

Definition at line 118 of file QueueWrapper.cpp.

View newest version in sPHENIX GitHub at line 118 of file QueueWrapper.cpp

References m_queue.

QueueWrapper & Acts::Sycl::QueueWrapper::operator= ( QueueWrapper &&  rhs)
noexcept

Move assignment operator.

Definition at line 73 of file QueueWrapper.cpp.

View newest version in sPHENIX GitHub at line 73 of file QueueWrapper.cpp

References m_logger, m_ownsQueue, m_queue, testing::internal::move(), and check_smearing_config::rhs.

+ Here is the call graph for this function:

QueueWrapper & Acts::Sycl::QueueWrapper::operator= ( const QueueWrapper other)

Copy assignment operator.

Definition at line 95 of file QueueWrapper.cpp.

View newest version in sPHENIX GitHub at line 95 of file QueueWrapper.cpp

References m_ownsQueue, and m_queue.

Member Data Documentation

std::unique_ptr<const Logger> Acts::Sycl::QueueWrapper::m_logger
private

The logger object.

Definition at line 79 of file QueueWrapper.hpp.

View newest version in sPHENIX GitHub at line 79 of file QueueWrapper.hpp

Referenced by logger(), and operator=().

bool Acts::Sycl::QueueWrapper::m_ownsQueue
private

Owns queue.

Definition at line 77 of file QueueWrapper.hpp.

View newest version in sPHENIX GitHub at line 77 of file QueueWrapper.hpp

Referenced by operator=(), QueueWrapper(), and ~QueueWrapper().

cl::sycl::queue* Acts::Sycl::QueueWrapper::m_queue
private

Raw pointer to SYCL queue object.

Definition at line 75 of file QueueWrapper.hpp.

View newest version in sPHENIX GitHub at line 75 of file QueueWrapper.hpp

Referenced by getQueue(), operator*(), operator->(), operator=(), QueueWrapper(), and ~QueueWrapper().


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