HiCR::backend::opencl::ComputeResource Class Reference

#include <computeResource.hpp>

Inheritance diagram for HiCR::backend::opencl::ComputeResource:

Public Member Functions
	ComputeResource (const std::shared_ptr< opencl::Device > &device, const std::string &type)
	~ComputeResource ()=default
	ComputeResource (const nlohmann::json &input)
__INLINE__ std::string	getType () const override
__INLINE__ const std::weak_ptr< const opencl::Device >	getDevice () const
Public Member Functions inherited from HiCR::ComputeResource
__INLINE__ nlohmann::json	serialize () const
__INLINE__ void	deserialize (const nlohmann::json &input)

Additional Inherited Members

Detailed Description

This class represents a compute resource, visible by the OpenCL backend.

Constructor & Destructor Documentation

ComputeResource() [1/2]

HiCR::backend::opencl::ComputeResource::ComputeResource ( const std::shared_ptr< opencl::Device > &  device, const std::string &  type  )

inline

Constructor for the compute resource class of the OpenCL backend

Parameters

device	The OpenCL device that contains this compute resource
type	device resource type

~ComputeResource()

HiCR::backend::opencl::ComputeResource::~ComputeResource ( )

virtualdefault

Default destructor

Reimplemented from HiCR::ComputeResource.

ComputeResource() [2/2]

HiCR::backend::opencl::ComputeResource::ComputeResource ( const nlohmann::json &  input )

inline

Deserializing constructor

Parameters

[in]

input

Serialized 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::ComputeResource::getDevice ( ) const

inline

Function to get the device id associated to this memory space

Returns

The device id corresponding to this memory space

getType()

__INLINE__ std::string HiCR::backend::opencl::ComputeResource::getType ( ) const

inlineoverridevirtual

Indicates what type of compute unit is contained in this instance

Returns

A string containing a human-readable description of the compute resource type

Implements HiCR::ComputeResource.

---

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

• /home/runner/work/HiCR/HiCR/include/hicr/backends/opencl/computeResource.hpp