OpenCL C++ Bindings
Classes | Public Types | Public Member Functions | List of all members
cl::SVMAllocator< T, SVMTrait > Class Template Reference

#include <opencl.hpp>

Classes

struct  rebind
 

Public Types

typedef T value_type
 
typedef value_type * pointer
 
typedef const value_type * const_pointer
 
typedef value_type & reference
 
typedef const value_type & const_reference
 
typedef std::size_t size_type
 
typedef std::ptrdiff_t difference_type
 

Public Member Functions

 SVMAllocator (cl::Context context)
 
 SVMAllocator (const SVMAllocator &other)
 
template<typename U >
 SVMAllocator (const SVMAllocator< U, SVMTrait > &other)
 
pointer address (reference r) CL_HPP_NOEXCEPT_
 
const_pointer address (const_reference r) CL_HPP_NOEXCEPT_
 
pointer allocate (size_type size, typename cl::SVMAllocator< void, SVMTrait >::const_pointer=0)
 
void deallocate (pointer p, size_type)
 
size_type max_size () const CL_HPP_NOEXCEPT_
 
template<class U , class... Args>
void construct (U *p, Args &&... args)
 
template<class U >
void destroy (U *p)
 
bool operator== (SVMAllocator const &rhs)
 
bool operator!= (SVMAllocator const &a)
 

Detailed Description

template<typename T, class SVMTrait>
class cl::SVMAllocator< T, SVMTrait >

STL-like allocator class for managing SVM objects provided for convenience.

Note that while this behaves like an allocator for the purposes of constructing vectors and similar objects, care must be taken when using with smart pointers. The allocator should not be used to construct a unique_ptr if we are using coarse-grained SVM mode because the coarse-grained management behaviour would behave incorrectly with respect to reference counting.

Instead the allocator embeds a Deleter which may be used with unique_ptr and is used with the allocate_shared and allocate_ptr supplied operations.

Definition at line 3659 of file opencl.hpp.

Member Typedef Documentation

◆ const_pointer

template<typename T , class SVMTrait >
typedef const value_type* cl::SVMAllocator< T, SVMTrait >::const_pointer

Definition at line 3666 of file opencl.hpp.

◆ const_reference

template<typename T , class SVMTrait >
typedef const value_type& cl::SVMAllocator< T, SVMTrait >::const_reference

Definition at line 3668 of file opencl.hpp.

◆ difference_type

template<typename T , class SVMTrait >
typedef std::ptrdiff_t cl::SVMAllocator< T, SVMTrait >::difference_type

Definition at line 3670 of file opencl.hpp.

◆ pointer

template<typename T , class SVMTrait >
typedef value_type* cl::SVMAllocator< T, SVMTrait >::pointer

Definition at line 3665 of file opencl.hpp.

◆ reference

template<typename T , class SVMTrait >
typedef value_type& cl::SVMAllocator< T, SVMTrait >::reference

Definition at line 3667 of file opencl.hpp.

◆ size_type

template<typename T , class SVMTrait >
typedef std::size_t cl::SVMAllocator< T, SVMTrait >::size_type

Definition at line 3669 of file opencl.hpp.

◆ value_type

template<typename T , class SVMTrait >
typedef T cl::SVMAllocator< T, SVMTrait >::value_type

Definition at line 3664 of file opencl.hpp.

Constructor & Destructor Documentation

◆ SVMAllocator() [1/4]

template<typename T , class SVMTrait >
cl::SVMAllocator< T, SVMTrait >::SVMAllocator ( )
inline

Definition at line 3681 of file opencl.hpp.

◆ SVMAllocator() [2/4]

template<typename T , class SVMTrait >
cl::SVMAllocator< T, SVMTrait >::SVMAllocator ( cl::Context  context)
inlineexplicit

Definition at line 3686 of file opencl.hpp.

◆ SVMAllocator() [3/4]

template<typename T , class SVMTrait >
cl::SVMAllocator< T, SVMTrait >::SVMAllocator ( const SVMAllocator< T, SVMTrait > &  other)
inline

Definition at line 3692 of file opencl.hpp.

◆ SVMAllocator() [4/4]

template<typename T , class SVMTrait >
template<typename U >
cl::SVMAllocator< T, SVMTrait >::SVMAllocator ( const SVMAllocator< U, SVMTrait > &  other)
inline

Definition at line 3698 of file opencl.hpp.

◆ ~SVMAllocator()

template<typename T , class SVMTrait >
cl::SVMAllocator< T, SVMTrait >::~SVMAllocator ( )
inline

Definition at line 3703 of file opencl.hpp.

Member Function Documentation

◆ address() [1/2]

template<typename T , class SVMTrait >
const_pointer cl::SVMAllocator< T, SVMTrait >::address ( const_reference  r)
inline

Definition at line 3712 of file opencl.hpp.

◆ address() [2/2]

template<typename T , class SVMTrait >
pointer cl::SVMAllocator< T, SVMTrait >::address ( reference  r)
inline

Definition at line 3707 of file opencl.hpp.

◆ allocate()

template<typename T , class SVMTrait >
pointer cl::SVMAllocator< T, SVMTrait >::allocate ( size_type  size,
typename cl::SVMAllocator< void, SVMTrait >::const_pointer  = 0 
)
inline

Allocate an SVM pointer.

If the allocator is coarse-grained, this will take ownership to allow containers to correctly construct data in place.

Definition at line 3723 of file opencl.hpp.

◆ construct()

template<typename T , class SVMTrait >
template<class U , class... Args>
void cl::SVMAllocator< T, SVMTrait >::construct ( U *  p,
Args &&...  args 
)
inline

Definition at line 3779 of file opencl.hpp.

◆ deallocate()

template<typename T , class SVMTrait >
void cl::SVMAllocator< T, SVMTrait >::deallocate ( pointer  p,
size_type   
)
inline

Definition at line 3756 of file opencl.hpp.

◆ destroy()

template<typename T , class SVMTrait >
template<class U >
void cl::SVMAllocator< T, SVMTrait >::destroy ( U *  p)
inline

Definition at line 3785 of file opencl.hpp.

◆ max_size()

template<typename T , class SVMTrait >
size_type cl::SVMAllocator< T, SVMTrait >::max_size ( ) const
inline

Return the maximum possible allocation size. This is the minimum of the maximum sizes of all devices in the context.

Definition at line 3765 of file opencl.hpp.

◆ operator!=()

template<typename T , class SVMTrait >
bool cl::SVMAllocator< T, SVMTrait >::operator!= ( SVMAllocator< T, SVMTrait > const &  a)
inline

Definition at line 3798 of file opencl.hpp.

◆ operator==()

template<typename T , class SVMTrait >
bool cl::SVMAllocator< T, SVMTrait >::operator== ( SVMAllocator< T, SVMTrait > const &  rhs)
inline

Returns true if the contexts match.

Definition at line 3793 of file opencl.hpp.

Friends And Related Function Documentation

◆ SVMAllocator

template<typename T , class SVMTrait >
template<typename U , typename V >
friend class SVMAllocator
friend

Definition at line 3679 of file opencl.hpp.

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