Declares classes that organize the execution of OpenCL kernels. More...

#include <CLUtils.hpp>
#include <RBC/data_types.hpp>
#include <RBC/common.hpp>

Include dependency graph for algorithms.hpp:

This graph shows which files directly or indirectly include this file:

Classes
class	cl_algo::RBC::RBCComputeDists< K >
	Interface class for the `rbcComputeDists` kernels. More...

class	cl_algo::RBC::Reduce< C, T >
	Interface class for the `reduce` kernels. More...

class	cl_algo::RBC::RBCMin
	Interface class for the `rbcMinDists` kernel. More...

class	cl_algo::RBC::Scan< C, T >
	Interface class for the `scan` kernel. More...

class	cl_algo::RBC::RBCPermute< C >
	Interface class for the `rbcPermute` kernel. More...

class	cl_algo::RBC::RBCConstruct< K, P >
	Interface class for constructing the `Random Ball Cover` data structure. More...

class	cl_algo::RBC::RBCSearch< K, P, S >
	Interface class for searching for nearest neighbors, of a set of queries, in the `Random Ball Cover` data structure. More...

class	cl_algo::RBC::RBCSearch< K, P, KernelTypeS::GENERIC >
	Interface class for searching for nearest neighbors, of a set of queries, in the `Random Ball Cover` data structure. More...

class	cl_algo::RBC::RBCSearch< K, P, KernelTypeS::KINECT >
	Interface class for searching for nearest neighbors, of a set of queries, in the `Random Ball Cover` data structure. More...

Namespaces
	cl_algo
	Offers classes which set up kernel execution parameters and provide interfaces for the handling of memory objects.

	cl_algo::RBC
	Offers classes associated with the Random Ball Cover data structure.

Enumerations
enum	cl_algo::RBC::KernelTypeC : uint8_t { cl_algo::RBC::KernelTypeC::SHARED_NONE, cl_algo::RBC::KernelTypeC::SHARED_R, cl_algo::RBC::KernelTypeC::SHARED_X_R, cl_algo::RBC::KernelTypeC::KINECT, cl_algo::RBC::KernelTypeC::KINECT_R, cl_algo::RBC::KernelTypeC::KINECT_X_R }
	Enumerates the kernels available for computing the array of distances in the construction step. More...

enum	cl_algo::RBC::ReduceConfig : uint8_t { cl_algo::RBC::ReduceConfig::MIN, cl_algo::RBC::ReduceConfig::MAX }
	Enumerates configurations for the `Reduce` class. More...

enum	cl_algo::RBC::ScanConfig : uint8_t { cl_algo::RBC::ScanConfig::INCLUSIVE, cl_algo::RBC::ScanConfig::EXCLUSIVE }
	Enumerates configurations for the `Scan` class. More...

enum	cl_algo::RBC::RBCPermuteConfig : uint8_t { cl_algo::RBC::RBCPermuteConfig::GENERIC, cl_algo::RBC::RBCPermuteConfig::KINECT }
	Enumerates configurations for the `RBCPermute` class. More...

enum	cl_algo::RBC::KernelTypeS : uint8_t { cl_algo::RBC::KernelTypeS::GENERIC, cl_algo::RBC::KernelTypeS::KINECT }
	Enumerates the kernels available for computing the array of distances (`Q-X[L]`) during search. More...

Detailed Description

Declares classes that organize the execution of OpenCL kernels.

Each class hides the details of kernel execution. They initialize the necessary buffers, set up the workspaces, and run the kernels.

: Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

: THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Classes