Interface class for the rbcMinDists kernel. More...

#include <algorithms.hpp>

Collaboration diagram for cl_algo::RBC::RBCMin:

Public Types
enum	Memory : uint8_t { Memory::H_IN_D, Memory::H_OUT_ID, Memory::H_OUT_RNK, Memory::H_OUT_N, Memory::D_IN_D, Memory::D_MINS, Memory::D_OUT_ID, Memory::D_OUT_RNK, Memory::D_OUT_N }
	Enumerates the memory objects handled by the class. More...

Public Member Functions
	RBCMin (clutils::CLEnv &_env, clutils::CLEnvInfo< 1 > _info)
	Configures an OpenCL environment as specified by `_info`. More...

cl::Memory &	get (RBCMin::Memory mem)
	Returns a reference to an internal memory object. More...

void	init (unsigned int _cols, unsigned int _rows, int _accCounters=1, Staging _staging=Staging::IO)
	Configures kernel execution parameters. More...

void	write (RBCMin::Memory mem=RBCMin::Memory::D_IN_D, void ptr=nullptr, bool block=CL_FALSE, const std::vector< cl::Event > events=nullptr, cl::Event *event=nullptr)
	Performs a data transfer to a device buffer. More...

void *	read (RBCMin::Memory mem=RBCMin::Memory::H_OUT_ID, bool block=CL_TRUE, const std::vector< cl::Event > events=nullptr, cl::Event event=nullptr)
	Performs a data transfer to a staging buffer. More...

void	run (const std::vector< cl::Event > events=nullptr, cl::Event event=nullptr)
	Executes the necessary kernels. More...

template<typename period >
double	run (clutils::GPUTimer< period > &timer, const std::vector< cl::Event > *events=nullptr)
	Executes the necessary kernels. More...

Public Attributes
cl_float *	hPtrInD

rbc_dist_id *	hPtrOutID

cl_uint *	hPtrOutRnk

cl_uint *	hPtrOutN

Detailed Description

Interface class for the rbcMinDists kernel.

rbcMinDists computes the minimum element, and its corresponding column id, of each row in an array. It also builds a histogram of the id values. And lastly, it stores the rank (order of insert) of each minimum element within its corresponding histogram bin. For more details, look at the kernel's documentation.

Note: The rbcMinDists kernel is available in kernels/rbc_kernels.cl.; The class creates its own buffers. If you would like to provide your own buffers, call get to get references to the placeholders within the class and assign them to your buffers. You will have to do this strictly before the call to init. You can also call get (after the call to init) to get a reference to a buffer within the class and assign it to another kernel class instance further down in your task pipeline.

The following input/output OpenCL memory objects are created by a RBCMin instance:

Name	Type	Placement	I/O	Use	Properties	Size
H_IN_D	Buffer	Host	I	Staging	CL_MEM_READ_WRITE	\(columnsrowssizeof\ (cl\_float)\)
H_OUT_ID	Buffer	Host	O	Staging	CL_MEM_READ_WRITE	\(rows *sizeof\ (rbc\_dist\_id)\)
H_OUT_RNK	Buffer	Host	O	Staging	CL_MEM_READ_WRITE	\(rows *sizeof\ (cl\_uint)\)
H_OUT_N	Buffer	Host	O	Staging	CL_MEM_READ_WRITE	\(columns *sizeof\ (cl\_uint)\)
D_IN_D	Buffer	Device	I	Processing	CL_MEM_READ_ONLY	\(columnsrowssizeof\ (cl\_float)\)
D_OUT_ID	Buffer	Device	O	Processing	CL_MEM_WRITE_ONLY	\(rows *sizeof\ (rbc\_dist\_id)\)
D_OUT_RNK	Buffer	Device	O	Processing	CL_MEM_WRITE_ONLY	\(rows *sizeof\ (cl\_uint)\)
D_OUT_N	Buffer	Device	O	Processing	CL_MEM_READ_WRITE	\(columns *sizeof\ (cl\_uint)\)

rbc_dist_id is documented in rbcDataTypes.hpp.

Member Enumeration Documentation

enum cl_algo::RBC::RBCMin::Memory : uint8_t

strong

Enumerates the memory objects handled by the class.

Note: H_* names refer to staging buffers on the host.; D_* names refer to buffers on the device.

Enumerator
H_IN_D	Input staging buffer for the array of distances.
H_OUT_ID	Output staging buffer with the minimum elements and id values.
H_OUT_RNK	Output staging buffer with the indices of each database point within the associated list.
H_OUT_N	Output staging buffer with the cardinalities of the representative lists.
D_IN_D	Input buffer for the array of distances.
D_MINS	Buffer of minimum elements and id values per work-group.
D_OUT_ID	Output buffer with the minimum elements and id values.
D_OUT_RNK	Output buffer with the indices of each database point within the associated list.
D_OUT_N	Output buffer with the cardinalities of the representative lists.

Constructor & Destructor Documentation

cl_algo::RBC::RBCMin::RBCMin	(	clutils::CLEnv &	_env,
		clutils::CLEnvInfo< 1 >	_info
	)

Configures an OpenCL environment as specified by _info.

Parameters

[in]	_env	opencl environment.
[in]	_info	opencl configuration. Specifies the context, queue, etc, to be used.

Member Function Documentation

cl::Memory & cl_algo::RBC::RBCMin::get ( RBCMin::Memory mem )

Returns a reference to an internal memory object.

This interface exists to allow CL memory sharing between different kernels.

Parameters

[in] mem enumeration value specifying the requested memory object.

Returns: A reference to the requested memory object.

void cl_algo::RBC::RBCMin::init	(	unsigned int	_cols,
		unsigned int	_rows,
		int	_accCounters = `1`,
		Staging	_staging = `Staging::IO`
	)

Configures kernel execution parameters.

Sets up memory objects as necessary, and defines the kernel workspaces.

Note: If you have assigned a memory object to one member variable of the class before the call to init, then that memory will be maintained. Otherwise, a new memory object will be created.

Parameters

[in]	_cols	number of columns in the input array.
[in]	_rows	number of rows in the input array.
[in]	_accCounters	flag to indicate whether or not to involve in the computation the list element counters, `N`, and element ranks, `Rnk`.
[in]	_staging	flag to indicate whether or not to instantiate the staging buffers.

void * cl_algo::RBC::RBCMin::read	(	RBCMin::Memory	mem = `RBCMin::Memory::H_OUT_ID`,
		bool	block = `CL_TRUE`,
		const std::vector< cl::Event > *	events = `nullptr`,
		cl::Event *	event = `nullptr`
	)

Performs a data transfer to a staging buffer.

The transfer happens from a device buffer to the associated (specified) staging buffer on the host.

Parameters

[in]	mem	enumeration value specifying an output staging buffer.
[in]	block	a flag to indicate whether to perform a blocking or a non-blocking operation.
[in]	events	a wait-list of events.
[out]	event	event associated with the read operation to the staging buffer.

void cl_algo::RBC::RBCMin::run	(	const std::vector< cl::Event > *	events = `nullptr`,
		cl::Event *	event = `nullptr`
	)

Executes the necessary kernels.

The function call is non-blocking.

Parameters

[in]	events	a wait-list of events.
[out]	event	event associated with the kernel execution.

template<typename period >

double cl_algo::RBC::RBCMin::run	(	clutils::GPUTimer< period > &	timer,
		const std::vector< cl::Event > *	events = `nullptr`
	)

inline

Executes the necessary kernels.

This run instance is used for profiling.

Parameters

[in]	timer	`GPUTimer` that does the profiling of the kernel executions.
[in]	events	a wait-list of events.

Returns: Τhe total execution time measured by the timer.

void cl_algo::RBC::RBCMin::write	(	RBCMin::Memory	mem = `RBCMin::Memory::D_IN_D`,
		void *	ptr = `nullptr`,
		bool	block = `CL_FALSE`,
		const std::vector< cl::Event > *	events = `nullptr`,
		cl::Event *	event = `nullptr`
	)

Performs a data transfer to a device buffer.

The transfer happens from a staging buffer on the host to the associated (specified) device buffer.

Parameters

[in]	mem	enumeration value specifying an input device buffer.
[in]	ptr	a pointer to an array holding input data. If not NULL, the data from `ptr` will be copied to the associated staging buffer.
[in]	block	a flag to indicate whether to perform a blocking or a non-blocking operation.
[in]	events	a wait-list of events.
[out]	event	event associated with the write operation to the device buffer.

Member Data Documentation

cl_float* cl_algo::RBC::RBCMin::hPtrInD

Mapping of the input staging buffer.

rbc_dist_id* cl_algo::RBC::RBCMin::hPtrOutID

Mapping of the output staging buffer with the minimum elements and id values.

cl_uint* cl_algo::RBC::RBCMin::hPtrOutN

Mapping of the output staging buffer with the number of elements per representative list.

cl_uint* cl_algo::RBC::RBCMin::hPtrOutRnk

Mapping of the output staging buffer with the indices of each database point within the associated list.

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

Public Types

Public Member Functions

Public Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation