vsmc::InitializeCL< T, PlaceHolder > Class Template Reference

Sampler<T>::init_type subtype using OpenCL. More...

#include <vsmc/opencl/backend_cl.hpp>

Public Member Functions
virtual std::size_t	accept_count (Particle< T > &particle, const ::cl::Buffer &accept_buffer)
CLConfigure &	configure ()
const CLConfigure &	configure () const
virtual void	initialize_param (Particle< T > &, void *)
virtual void	initialize_state (std::string &)
const ::cl::Kernel &	kernel () const
::cl::Kernel &	kernel ()
const std::string &	kernel_name () const
std::size_t	operator() (Particle< T > &particle, void *param)
virtual void	post_processor (Particle< T > &)
virtual void	pre_processor (Particle< T > &)
virtual void	set_kernel (const Particle< T > &particle)
virtual void	set_kernel_args (const Particle< T > &particle)

Static Public Member Functions
static constexpr::cl_uint	kernel_args_offset ()
	The index offset of additional kernel arguments set by the user. More...

Protected Member Functions
	InitializeCL ()
	InitializeCL (const InitializeCL< T, PlaceHolder > &)=default
	InitializeCL (InitializeCL< T, PlaceHolder > &&)=default
virtual	~InitializeCL ()
InitializeCL< T, PlaceHolder > &	operator= (const InitializeCL< T, PlaceHolder > &)=default
InitializeCL< T, PlaceHolder > &	operator= (InitializeCL< T, PlaceHolder > &&)=default

Detailed Description

template<typename T, typename PlaceHolder = NullType>
class vsmc::InitializeCL< T, PlaceHolder >

Sampler<T>::init_type subtype using OpenCL.

Kernel requirement (initialize_state)

__kernel
void kern (__global state_type *state, __global ulong *accept);

• Kernels can have additonal arguments and set by the user in pre_processor.
• state has size N * StateSize where accept has size N.
• The declaration does not have to much this, but the first arguments will be set by InitializeCL::opeartor(). For example

  type struct {
      state_type v1;
      state_type v2;
      // ...
      state_type vDim; // vDim = StateSize / state_type
  } param;
  __kernel
  void kern (__global param *state, __global ulong *accept);

  is also acceptable, but now state has to be treat as a length N array. In summary, on the host side, it is a cl::Buffer object being passed to the kernel, which is not much unlike void * pointer.

Definition at line 543 of file backend_cl.hpp.

Constructor & Destructor Documentation

template<typename T, typename PlaceHolder = NullType>

vsmc::InitializeCL< T, PlaceHolder >::InitializeCL ( )

inlineprotected

Definition at line 619 of file backend_cl.hpp.

template<typename T, typename PlaceHolder = NullType>

vsmc::InitializeCL< T, PlaceHolder >::InitializeCL ( const InitializeCL< T, PlaceHolder > &  )

protecteddefault

template<typename T, typename PlaceHolder = NullType>

virtual vsmc::InitializeCL< T, PlaceHolder >::~InitializeCL ( )

inlineprotectedvirtual

Definition at line 619 of file backend_cl.hpp.

template<typename T, typename PlaceHolder = NullType>

vsmc::InitializeCL< T, PlaceHolder >::InitializeCL ( InitializeCL< T, PlaceHolder > &&  )

protecteddefault

Member Function Documentation

template<typename T, typename PlaceHolder = NullType>

virtual std::size_t vsmc::InitializeCL< T, PlaceHolder >::accept_count ( Particle< T > &  particle, const ::cl::Buffer &  accept_buffer  )

inlinevirtual

Definition at line 577 of file backend_cl.hpp.

template<typename T, typename PlaceHolder = NullType>

CLConfigure& vsmc::InitializeCL< T, PlaceHolder >::configure ( )

inline

Definition at line 615 of file backend_cl.hpp.

template<typename T, typename PlaceHolder = NullType>

const CLConfigure& vsmc::InitializeCL< T, PlaceHolder >::configure ( ) const

inline

Definition at line 615 of file backend_cl.hpp.

template<typename T, typename PlaceHolder = NullType>

virtual void vsmc::InitializeCL< T, PlaceHolder >::initialize_param ( Particle< T > &  , void *    )

inlinevirtual

Reimplemented in vsmc::InitializeAdapterBase< T, NullType, InitializeCL< T > >, and vsmc::InitializeAdapterBase< T, F, InitializeCL< T > >.

Definition at line 572 of file backend_cl.hpp.

template<typename T, typename PlaceHolder = NullType>

virtual void vsmc::InitializeCL< T, PlaceHolder >::initialize_state ( std::string &  )

inlinevirtual

Reimplemented in vsmc::InitializeAdapter< T, InitializeCL, NullType >, and vsmc::InitializeAdapter< T, InitializeCL, F >.

Definition at line 573 of file backend_cl.hpp.

template<typename T, typename PlaceHolder = NullType>

::cl::Kernel& vsmc::InitializeCL< T, PlaceHolder >::kernel ( )

inline

Definition at line 615 of file backend_cl.hpp.

template<typename T, typename PlaceHolder = NullType>

const ::cl::Kernel& vsmc::InitializeCL< T, PlaceHolder >::kernel ( ) const

inline

Definition at line 615 of file backend_cl.hpp.

template<typename T, typename PlaceHolder = NullType>

static constexpr ::cl_uint vsmc::InitializeCL< T, PlaceHolder >::kernel_args_offset ( )

inlinestatic

The index offset of additional kernel arguments set by the user.

The first user supplied additional argument shall have index kernel_args_offset

Definition at line 552 of file backend_cl.hpp.

template<typename T, typename PlaceHolder = NullType>

const std::string& vsmc::InitializeCL< T, PlaceHolder >::kernel_name ( ) const

inline

Definition at line 615 of file backend_cl.hpp.

template<typename T, typename PlaceHolder = NullType>

std::size_t vsmc::InitializeCL< T, PlaceHolder >::operator() ( Particle< T > &  particle, void *  param  )

inline

Definition at line 554 of file backend_cl.hpp.

template<typename T, typename PlaceHolder = NullType>

InitializeCL<T, PlaceHolder>& vsmc::InitializeCL< T, PlaceHolder >::operator= ( const InitializeCL< T, PlaceHolder > &  )

protecteddefault

template<typename T, typename PlaceHolder = NullType>

InitializeCL<T, PlaceHolder>& vsmc::InitializeCL< T, PlaceHolder >::operator= ( InitializeCL< T, PlaceHolder > &&  )

protecteddefault

template<typename T, typename PlaceHolder = NullType>

virtual void vsmc::InitializeCL< T, PlaceHolder >::post_processor ( Particle< T > &  )

inlinevirtual

Reimplemented in vsmc::InitializeAdapterBase< T, NullType, InitializeCL< T > >, and vsmc::InitializeAdapterBase< T, F, InitializeCL< T > >.

Definition at line 575 of file backend_cl.hpp.

template<typename T, typename PlaceHolder = NullType>

virtual void vsmc::InitializeCL< T, PlaceHolder >::pre_processor ( Particle< T > &  )

inlinevirtual

Reimplemented in vsmc::InitializeAdapterBase< T, NullType, InitializeCL< T > >, and vsmc::InitializeAdapterBase< T, F, InitializeCL< T > >.

Definition at line 574 of file backend_cl.hpp.

template<typename T, typename PlaceHolder = NullType>

virtual void vsmc::InitializeCL< T, PlaceHolder >::set_kernel ( const Particle< T > &  particle )

inlinevirtual

Definition at line 588 of file backend_cl.hpp.

template<typename T, typename PlaceHolder = NullType>

virtual void vsmc::InitializeCL< T, PlaceHolder >::set_kernel_args ( const Particle< T > &  particle )

inlinevirtual

Definition at line 595 of file backend_cl.hpp.