MemorySpace Class Reference

HiCR: HiCR::backend::opencl::MemorySpace Class Reference
HiCR
HiCR::backend::opencl::MemorySpace Class Referencefinal

#include <memorySpace.hpp>

Inheritance diagram for HiCR::backend::opencl::MemorySpace:
HiCR::MemorySpace

Public Member Functions

 MemorySpace (const std::weak_ptr< opencl::Device > device, const std::string &type, const size_t size)
 
 ~MemorySpace ()=default
 
 MemorySpace (const nlohmann::json &input)
 
__INLINE__ const std::weak_ptr< const opencl::DevicegetDevice () const
 
- Public Member Functions inherited from HiCR::MemorySpace
 MemorySpace (const nlohmann::json &input)
 
__INLINE__ std::string getType () const
 
virtual __INLINE__ const size_t getSize () const
 
virtual __INLINE__ size_t getUsage () const
 
__INLINE__ void increaseUsage (const size_t delta)
 
__INLINE__ void decreaseUsage (const size_t delta)
 
__INLINE__ nlohmann::json serialize () const
 
__INLINE__ void deserialize (const nlohmann::json &input)
 

Additional Inherited Members

- Protected Member Functions inherited from HiCR::MemorySpace
 MemorySpace (const size_t size)
 
 MemorySpace ()=default
 
- Protected Attributes inherited from HiCR::MemorySpace
std::string _type
 

Detailed Description

This class represents a memory space, as visible by the OpenCL backend. That is, the entire accessible RAM

Constructor & Destructor Documentation

◆ MemorySpace() [1/2]

HiCR::backend::opencl::MemorySpace::MemorySpace ( const std::weak_ptr< opencl::Device device,
const std::string &  type,
const size_t  size 
)
inline

Constructor for the compute resource class of the OpenCL backend

Parameters
deviceThe OpenCL device in which this memory space was detected
typeThe memory space type
sizeThe size of this memory space

◆ ~MemorySpace()

HiCR::backend::opencl::MemorySpace::~MemorySpace ( )
virtualdefault

Default destructor

Reimplemented from HiCR::MemorySpace.

◆ MemorySpace() [2/2]

HiCR::backend::opencl::MemorySpace::MemorySpace ( const nlohmann::json &  input)
inline

Deserializing constructor

Parameters
[in]inputSerialized resource information
Note
Backwards reference to device is null when deserializing. Do not try to use this class for any operations.

Member Function Documentation

◆ getDevice()

__INLINE__ const std::weak_ptr< const opencl::Device > HiCR::backend::opencl::MemorySpace::getDevice ( ) const
inline

Function to get the OpenCL device associated to this memory space

Returns
The OpenCL device corresponding to this memory space

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