CaloRecGPU::Helpers Namespace Reference

Namespaces
	Constants
	!
	MemoryContext
	! Holds dummy classes just to identify the place in which memory lives.

Classes
struct	maybe_allocate
	Possibly holds an object in its internal buffer. More...
class	MemoryManagement
	! Handles allocation of a type T, using indexer as the integer type to indicate sizes. More...
struct	separate_thread_accessor
	! More...
class	separate_thread_holder
	Manages objects of type T in a thread-safe way, ensuring that there's an object available for each separate thread while minimizing the number of allocations. More...
class	SimpleContainer
	Holds a run-time amount of objects of type \T, measuring sizes with indexer, in memory context Context. More...
class	SimpleContainer< T, indexer, Context, false >
class	SimpleContainer< T, indexer, Context, true >
class	SimpleHolder
	Holds one objects of type \T in memory context Context. More...
class	SimpleHolder< T, Context, false >
class	SimpleHolder< T, Context, true >

Typedefs
template<class T , class indexer = unsigned int>
using	CPU_array = SimpleContainer< T, indexer, MemoryContext::CPU, true >
	Holds a run-time specified amount of objects of type T in CPU memory. More...
template<class T , class indexer = unsigned int>
using	CUDA_array = SimpleContainer< T, indexer, MemoryContext::CUDAGPU, true >
	Holds a run-time specified amount of objects of type T in CUDA GPU memory. More...
template<class T , class indexer = unsigned int>
using	CUDA_kernel_array = SimpleContainer< T, indexer, MemoryContext::CUDAGPU, false >
	Non-owning pointer to an array of T in CUDA GPU memory. More...
template<class T >
using	CPU_object = SimpleHolder< T, MemoryContext::CPU, true >
	Holds an object of type T in CPU memory. More...
template<class T >
using	CUDA_object = SimpleHolder< T, MemoryContext::CUDAGPU, true >
	Holds an object of type T in CUDA GPU memory. More...
template<class T >
using	CUDA_kernel_object = SimpleHolder< T, MemoryContext::CUDAGPU, false >
	Non-owning pointer to an object of type T in CUDA GPU memory. More...
template<class T >
using	CUDA_pinned_CPU_object = SimpleHolder< T, MemoryContext::CUDAPinnedCPU, true >
	Holds an object of type T in CUDA GPU memory. More...

Functions
constexpr int	int_ceil_div (const int num, const int denom)
	Returns the ceiling of num/denom, with proper rounding. More...
constexpr int	int_floor_div (const int num, const int denom)
	Returns the floor of num/denom, with proper rounding. More...
template<class Base = float, class Exp = int>
constexpr Base	compile_time_pow2 (const Exp exp)
	Returns 2 to the power of exp. More...
template<class T >
constexpr unsigned char	Pearson_hash (const T number)
	Calculates a Pearson hash from @ number. More...
template<class T >
constexpr unsigned short	Pearson_hash_16_bit (const T number)
	Calculates a 16-bit Pearson hash from @ number. More...

Typedef Documentation

CPU_array

template<class T , class indexer = unsigned int>

using CaloRecGPU::Helpers::CPU_array = typedef SimpleContainer<T, indexer, MemoryContext::CPU, true>

Holds a run-time specified amount of objects of type T in CPU memory.

Definition at line 1052 of file Calorimeter/CaloRecGPU/CaloRecGPU/Helpers.h.

CPU_object

template<class T >

using CaloRecGPU::Helpers::CPU_object = typedef SimpleHolder<T, MemoryContext::CPU, true>

Holds an object of type T in CPU memory.

Definition at line 1450 of file Calorimeter/CaloRecGPU/CaloRecGPU/Helpers.h.

CUDA_array

template<class T , class indexer = unsigned int>

using CaloRecGPU::Helpers::CUDA_array = typedef SimpleContainer<T, indexer, MemoryContext::CUDAGPU, true>

Holds a run-time specified amount of objects of type T in CUDA GPU memory.

Definition at line 1056 of file Calorimeter/CaloRecGPU/CaloRecGPU/Helpers.h.

CUDA_kernel_array

template<class T , class indexer = unsigned int>

using CaloRecGPU::Helpers::CUDA_kernel_array = typedef SimpleContainer<T, indexer, MemoryContext::CUDAGPU, false>

Non-owning pointer to an array of T in CUDA GPU memory.

Definition at line 1060 of file Calorimeter/CaloRecGPU/CaloRecGPU/Helpers.h.

CUDA_kernel_object

template<class T >

using CaloRecGPU::Helpers::CUDA_kernel_object = typedef SimpleHolder<T, MemoryContext::CUDAGPU, false>

Non-owning pointer to an object of type T in CUDA GPU memory.

Definition at line 1458 of file Calorimeter/CaloRecGPU/CaloRecGPU/Helpers.h.

CUDA_object

template<class T >

using CaloRecGPU::Helpers::CUDA_object = typedef SimpleHolder<T, MemoryContext::CUDAGPU, true>

Holds an object of type T in CUDA GPU memory.

Definition at line 1454 of file Calorimeter/CaloRecGPU/CaloRecGPU/Helpers.h.

CUDA_pinned_CPU_object

template<class T >

using CaloRecGPU::Helpers::CUDA_pinned_CPU_object = typedef SimpleHolder<T, MemoryContext::CUDAPinnedCPU, true>

Holds an object of type T in CUDA GPU memory.

Definition at line 1462 of file Calorimeter/CaloRecGPU/CaloRecGPU/Helpers.h.

Function Documentation

compile_time_pow2()

template<class Base = float, class Exp = int>

constexpr Base CaloRecGPU::Helpers::compile_time_pow2 ( const Exp  exp )

inlineconstexpr

Returns 2 to the power of exp.

Definition at line 226 of file Calorimeter/CaloRecGPU/CaloRecGPU/Helpers.h.

    {
      Base ret = 1;
      if (exp < 0)
        {
          for (Exp i = 0; i < -exp; ++i)
            {
              ret /= Base(2);
            }
        }
      else
        {
          for (Exp i = 0; i < exp; ++i)
            {
              ret *= Base(2);
            }
        }
      return ret;
    }

int_ceil_div()

constexpr int CaloRecGPU::Helpers::int_ceil_div ( const int  num, const int  denom  )

inlineconstexpr

Returns the ceiling of num/denom, with proper rounding.

Definition at line 213 of file Calorimeter/CaloRecGPU/CaloRecGPU/Helpers.h.

    {
      return num / denom + (num % denom != 0);
    }

int_floor_div()

constexpr int CaloRecGPU::Helpers::int_floor_div ( const int  num, const int  denom  )

inlineconstexpr

Returns the floor of num/denom, with proper rounding.

Definition at line 219 of file Calorimeter/CaloRecGPU/CaloRecGPU/Helpers.h.

    {
      return num / denom;
    }

Pearson_hash()

template<class T >

constexpr unsigned char CaloRecGPU::Helpers::Pearson_hash ( const T  number )

inlineconstexpr

Calculates a Pearson hash from @ number.

Definition at line 253 of file Calorimeter/CaloRecGPU/CaloRecGPU/Helpers.h.

    {
      constexpr unsigned char initial_value = 42;
      //The answer.
 
      constexpr unsigned char c_mult = 7;
      constexpr unsigned char c_add = 1;
      //For our "look up table": table[i] = c_mult * i + c_add
      //For an appropriate choice of constants (such as this),
      //this will be bijective (modulo 255), as required.
 
      unsigned char ret = initial_value;
 
      for (unsigned int i = 0; i < sizeof(T); i += sizeof(unsigned char))
        {
          const unsigned char to_hash = number >> (i * CHAR_BIT);
          const unsigned char operand = ret ^ to_hash;
          ret = c_mult * operand + c_add;
        }
 
      return ret;
    }

Pearson_hash_16_bit()

template<class T >

constexpr unsigned short CaloRecGPU::Helpers::Pearson_hash_16_bit ( const T  number )

inlineconstexpr

Calculates a 16-bit Pearson hash from @ number.

Definition at line 280 of file Calorimeter/CaloRecGPU/CaloRecGPU/Helpers.h.

    {
      constexpr unsigned short initial_value = 42754;
      //The answer and the standard.
 
      constexpr unsigned short c_mult = 7;
      constexpr unsigned short c_add = 1;
      //For our "look up table": table[i] = c_mult * i + c_add
      //For an appropriate choice of constants (such as this),
      //this will be bijective (modulo 255), as required.
 
      unsigned short ret = initial_value;
 
      for (unsigned int i = 0; i < sizeof(T); i += sizeof(unsigned short))
        {
          const unsigned short to_hash = number >> (i * CHAR_BIT);
          const unsigned short operand = ret ^ to_hash;
          ret = c_mult * operand + c_add;
        }
 
      return ret;
    }