Kokkos Node API and Local Linear Algebra Kernels Version of the Day
Public Member Functions | Static Public Member Functions | Static Public Attributes
Kokkos::TBBNode Class Reference

Kokkos node interface to the Intel Threading Building Blocks threading library. More...

#include <Kokkos_TBBNode.hpp>

Inheritance diagram for Kokkos::TBBNode:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 TBBNode (Teuchos::ParameterList &pl)
 Constructor acceptings a list of parameters.
 ~TBBNode ()
 Default destructor, calls tbb::task_scheduler_init::terminate().
void init (int numThreads)
 Init the node with a given number of threads. Call tbb::task_scheduler_initi::initialize(), with numThreads as the argument if it is greater than 0, and tbb::task_scheduler_init::automatic otherwise. If init has already been called, this calls tbb:task_scheduler_init::terminate() first.
void sync () const
 No-op for TBBNode.
template<class T >
ArrayRCP< T > allocBuffer (size_t size)
 Allocate a parallel buffer, returning it as a pointer ecnapsulated in an ArrayRCP.
template<class T >
void copyFromBuffer (size_t size, const ArrayRCP< const T > &buffSrc, const ArrayView< T > &hostDest)
 Copy data to host memory from a parallel buffer.
template<class T >
void copyToBuffer (size_t size, const ArrayView< const T > &hostSrc, const ArrayRCP< T > &buffDest)
 Copy data to host memory from a parallel buffer.
template<class T >
void copyBuffers (size_t size, const ArrayRCP< const T > &buffSrc, const ArrayRCP< T > &buffDest)
 Copy data between buffers.
template<class T >
ArrayRCP< const T > viewBuffer (size_t size, ArrayRCP< const T > buff)
 Return a const view of a buffer for use on the host.
template<class T >
ArrayRCP< T > viewBufferNonConst (ReadWriteOption rw, size_t size, const ArrayRCP< T > &buff)
 Return a non-const view of a buffer for use on the host.

Static Public Member Functions

template<class WDP >
static void parallel_for (int begin, int end, WDP wd)
 parallel for skeleton, a wrapper around tbb::parallel_for. See Kokkos Node API
template<class WDP >
static WDP::ReductionType parallel_reduce (int begin, int end, WDP wd)
 parallel reduction skeleton, a wrapper around tbb::parallel_reduce. See Kokkos Node API

Static Public Attributes

static const bool isHostNode = true
 Indicates that parallel buffers allocated by this node are available for use on the host thread.

Detailed Description

Kokkos node interface to the Intel Threading Building Blocks threading library.

Definition at line 94 of file Kokkos_TBBNode.hpp.


Constructor & Destructor Documentation

Kokkos::TBBNode::TBBNode ( Teuchos::ParameterList pl)

Constructor acceptings a list of parameters.

This constructor accepts the parameters:

Parameters:
Num Threads[int] Specifies the number of threads, calls TBBNode::init() if non-negative. Otherwise, late initialization. Default: -1.

Definition at line 50 of file Kokkos_TBBNode.cpp.

Kokkos::TBBNode::~TBBNode ( )

Default destructor, calls tbb::task_scheduler_init::terminate().

Definition at line 74 of file Kokkos_TBBNode.cpp.


Member Function Documentation

void Kokkos::TBBNode::init ( int  numThreads)

Init the node with a given number of threads. Call tbb::task_scheduler_initi::initialize(), with numThreads as the argument if it is greater than 0, and tbb::task_scheduler_init::automatic otherwise. If init has already been called, this calls tbb:task_scheduler_init::terminate() first.

Definition at line 61 of file Kokkos_TBBNode.cpp.

template<class WDP >
static void Kokkos::TBBNode::parallel_for ( int  begin,
int  end,
WDP  wd 
) [inline, static]

parallel for skeleton, a wrapper around tbb::parallel_for. See Kokkos Node API

Definition at line 116 of file Kokkos_TBBNode.hpp.

template<class WDP >
static WDP::ReductionType Kokkos::TBBNode::parallel_reduce ( int  begin,
int  end,
WDP  wd 
) [inline, static]

parallel reduction skeleton, a wrapper around tbb::parallel_reduce. See Kokkos Node API

Definition at line 124 of file Kokkos_TBBNode.hpp.

void Kokkos::TBBNode::sync ( ) const [inline]

No-op for TBBNode.

Definition at line 131 of file Kokkos_TBBNode.hpp.

template<class T >
ArrayRCP<T> Kokkos::StandardNodeMemoryModel::allocBuffer ( size_t  size) [inline, inherited]

Allocate a parallel buffer, returning it as a pointer ecnapsulated in an ArrayRCP.

Dereferencing the returned ArrayRCP or its underlying pointer in general results in undefined behavior outside of parallel computations.

The buffer will be automatically freed by the Node when no more references remain.

Template Parameters:
TThe data type of the allocate buffer. This is used to perform alignment and determine the number of bytes to allocate.
Parameters:
[in]sizeThe size requested for the parallel buffer, greater than zero.
Postcondition:
The method will return an ArrayRCP encapsulating a pointer. The underlying pointer may be used in parallel computation routines, and is guaranteed to have size large enough to reference size number of entries of type T.

Definition at line 80 of file Kokkos_StandardNodeMemoryModel.hpp.

template<class T >
void Kokkos::StandardNodeMemoryModel::copyFromBuffer ( size_t  size,
const ArrayRCP< const T > &  buffSrc,
const ArrayView< T > &  hostDest 
) [inline, inherited]

Copy data to host memory from a parallel buffer.

Parameters:
[in]sizeThe number of entries to copy from buffSrc to hostDest.
[in]buffSrcThe parallel buffer from which to copy.
[out]hostDestThe location in host memory where the data from buffSrc is copied to.
Precondition:
size is non-negative.
buffSrc has length at least size.
hostDest has length equal to size.
Postcondition:
On return, entries in the range [0 , size) of buffSrc have been copied to hostDest entries in the range [0 , size).

Definition at line 103 of file Kokkos_StandardNodeMemoryModel.hpp.

template<class T >
void Kokkos::StandardNodeMemoryModel::copyToBuffer ( size_t  size,
const ArrayView< const T > &  hostSrc,
const ArrayRCP< T > &  buffDest 
) [inline, inherited]

Copy data to host memory from a parallel buffer.

Parameters:
[in]sizeThe number of entries to copy from hostSrc to buffDest.
[in]hostSrcThe location in host memory from where the data is copied.
[out]buffDestThe parallel buffer to which the data is copied.
Precondition:
size is non-negative.
hostSrc has length equal to size.
buffSrc has length at least size.
Postcondition:
On return, entries in the range [0 , size) of hostSrc are allowed to be written to. The data is guaranteed to be present in buffDest before it is used in a parallel computation.

Definition at line 123 of file Kokkos_StandardNodeMemoryModel.hpp.

template<class T >
void Kokkos::StandardNodeMemoryModel::copyBuffers ( size_t  size,
const ArrayRCP< const T > &  buffSrc,
const ArrayRCP< T > &  buffDest 
) [inline, inherited]

Copy data between buffers.

Parameters:
[in]sizeThe size of the copy, greater than zero.
[in]buffSrcThe source buffer, with length at least as large as size.
[in,out]buffDestThe destination buffer, with length at least as large as size.
Postcondition:
The data is guaranteed to have been copied before any other usage of buffSrc or buffDest occurs.

Definition at line 140 of file Kokkos_StandardNodeMemoryModel.hpp.

template<class T >
ArrayRCP<const T> Kokkos::StandardNodeMemoryModel::viewBuffer ( size_t  size,
ArrayRCP< const T >  buff 
) [inline, inherited]

Return a const view of a buffer for use on the host.

Definition at line 152 of file Kokkos_StandardNodeMemoryModel.hpp.

template<class T >
ArrayRCP<T> Kokkos::StandardNodeMemoryModel::viewBufferNonConst ( ReadWriteOption  rw,
size_t  size,
const ArrayRCP< T > &  buff 
) [inline, inherited]

Return a non-const view of a buffer for use on the host.

Definition at line 161 of file Kokkos_StandardNodeMemoryModel.hpp.


Member Data Documentation

const bool Kokkos::StandardNodeMemoryModel::isHostNode = true [static, inherited]

Indicates that parallel buffers allocated by this node are available for use on the host thread.

Definition at line 61 of file Kokkos_StandardNodeMemoryModel.hpp.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends