Kokkos Core Kernels Package  Version of the Day
Public Member Functions | Static Public Member Functions | List of all members
Kokkos::Qthread Class Reference

Execution space supported by Qthread. More...

#include <Kokkos_Qthread.hpp>

Public Types

Type declarations that all Kokkos devices must provide.
typedef Qthread execution_space
 Tag this class as an execution space. More...
 
typedef Kokkos::HostSpace memory_space
 
typedef Kokkos::Device< execution_space, memory_spacedevice_type
 This execution space preferred device_type. More...
 
typedef Kokkos::LayoutRight array_layout
 
typedef memory_space::size_type size_type
 
typedef ScratchMemorySpace< Qthreadscratch_memory_space
 

Public Member Functions

bool sleep ()
 Set the execution space to a "sleep" state. More...
 

Static Public Member Functions

static Qthreadinstance (int=0)
 Initialization will construct one or more instances. More...
 
static bool wake ()
 Wake from the sleep state. More...
 
static void fence ()
 Wait until all dispatched functions to complete. More...
 
static void print_configuration (std::ostream &, const bool detail=false)
 Print configuration information to the given output stream. More...
 

Detailed Description

Execution space supported by Qthread.

Definition at line 69 of file Kokkos_Qthread.hpp.

Member Typedef Documentation

Tag this class as an execution space.

Definition at line 75 of file Kokkos_Qthread.hpp.

This execution space preferred device_type.

Definition at line 78 of file Kokkos_Qthread.hpp.

Member Function Documentation

static Qthread& Kokkos::Qthread::instance ( int  = 0)
static

Initialization will construct one or more instances.

bool Kokkos::Qthread::sleep ( )

Set the execution space to a "sleep" state.

This function sets the "sleep" state in which it is not ready for work. This may consume less resources than in an "ready" state, but it may also take time to transition to the "ready" state.

Returns
True if enters or is in the "sleep" state. False if functions are currently executing.
static bool Kokkos::Qthread::wake ( )
static

Wake from the sleep state.

Returns
True if enters or is in the "ready" state. False if functions are currently executing.
static void Kokkos::Qthread::fence ( )
static

Wait until all dispatched functions to complete.

The parallel_for or parallel_reduce dispatch of a functor may return asynchronously, before the functor completes. This method does not return until all dispatched functors on this device have completed.

static void Kokkos::Qthread::print_configuration ( std::ostream &  ,
const bool  detail = false 
)
static

Print configuration information to the given output stream.


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