API Alphabetical - JBludau/kokkos GitHub Wiki

All functions and classes listed here are part of the Kokkos:: namespace.

Name	Library	Category	Description
Rand	Algorithm	Random Number	Generator Type (12), draw options (3)
Rand	Algorithm	Random Number	Generator Type (12), draw options (3)
Random_XorShift64_Pool	Algorithm	Random Number	Random Number Generator, pool for threads
Random_XorShift64	Algorithm	Random Number	Random Number Generator for 12 types, plus normal distribution
init	Algorithm	Random Number	initialize state using seed for Random_XorShift64_Pool
Random_XorShift1024_Pool	Algorithm	Random Number	Random Number Generator, 1024 bit, pool for threads
Random_XorShift1024	Algorithm	Random Number	Random Number Generator for 12 types, plus normal distribution)
fill_random	Algorithm	Random Number	create sample space to fit a (0 to) range or begin-end space

Name	Library	Category	Description
Bitset	Containers	View	A concurrent Bitset class.
DualView	Containers	View	Host-Device Mirror of View with Host-Device Memory
DynRankView	Containers	View	A view which can determine its rank at runtime.
DynamicView	Containers	View	A view which can change its size dynamically.
ErrorReporter	Containers	View	A class supporting error recording in parallel code.
OffsetView	Containers	View	View structure supporting non-zero start indicies.
ScatterView	Containers	View	View structure to transpartently support atomic and data replication strategies for scatter-reduce algorithms.
StaticCrsGraph	Containers	View	A non-resizable CRS graph structure with view semantics.
UnorderedMap	Containers	View	A map data structure optimized for concurrent inserts.
vector	Containers	View	A class providing similar interfaces to std::vector.

Name	Library	Category	Description
abort	Core	Utilities	Causes abnormal program termination.
atomic_exchange	Core	Atomic-Operations	Atomic operation which exchanges a value and returns the old.
atomic_compare_exchange	Core	Atomic-Operations	Atomic operation which exchanges a value only if the old value matches a comparison value and returns the old value.
atomic_compare_exchange_strong	Core	Atomic-Operations	Atomic operation which exchanges a value only if the old value matches a comparison value and returns true if the exchange is executed.
atomic_load	Core	Atomic-Operations	Atomic operation which loads a value.
atomic_[op]	Core	Atomic-Operations	Atomic operation which don't return anything.
atomic_fetch_[op]	Core	Atomic-Operations	Various atomic operations which return the old value.
atomic_[op]_fetch	Core	Atomic-Operations	Various atomic operations which return the updated value.
atomic_store	Core	Atomic-Operations	Atomic operation which stores a value.
BAnd	Core	Data-Parallelism	Reducer for Binary 'And' reduction
BOr	Core	Data-Parallelism	Reducer for Binary 'Or' reduction
complex	Core	STL Compatibility	Complex numbers which work on host and device
(X)create_mirror	Core	View	Mirror Host data to Device data
(X)create_mirror_view	Core	View	Mirror Host data to Device data
Cuda	Core	Spaces	The CUDA Execution Space.
CudaSpace	Core	Spaces	The primary CUDA Memory Space.
CudaUVMSpace	Core	Spaces	The CUDA Memory Space providing access to unified memory page migratable allocations.
CudaHostPinnedSpace	Core	Spaces	The CUDA Memrory Space providing access to host pinned GPU-accessible host memory.
deep_copy	Core	View	Copy Views
ExecutionPolicy Concept	Core	Execution Policies	Concept for execution policies.
ExecutionSpace concept	Core	Spaces	Concept for execution spaces.
fence	Core	Data-Parallelism	Fences execution spaces.
finalize	Core	Initialization and Finalization	function to finalize Kokkos
HostSpace	Core	Spaces	The primary Host Memory Space.
HPX	Core	Spaces	Execution space using the HPX runtime system execution mechanisms.
initialize	Core	Initialization and Finalization	function to initialize Kokkos
is_array_layout	Core		Trait to detect types that model the Layout concept
is_execution_policy	Core		Trait to detect types that model ExecutionPolicy concept
is_execution_space	Core		Trait to detect types that model ExecutionSpace concept
is_memory_space	Core		Trait to detect types that model MemorySpace concept
is_memory_traits	Core		Trait to detect specializations of Kokkos::MemoryTraits
is_reducer	Core		Trait to detect types that model the Reducer concept
is_space	Core		Trait to detect types that model the Space concept
LayoutLeft	Core	Views	Memory Layout matching Fortran
LayoutRight	Core	Views	Memory Layout matching C
LayoutStride	Core	Views	Memory Layout for arbitrary strides
kokkos_free	Core	Spaces	Dellocates previously allocated memory
kokkos_malloc	Core	Spaces	Allocates memory
kokkos_realloc	Core	Spaces	Expands previously allocated memory block
LAnd	Core	Data-Parallelism	Reducer for Logical 'And' reduction
LOr	Core	Data-Parallelism	Reducer for Logical 'Or' reduction
Max	Core	Data-Parallelism	Reducer for Maximum reduction
MaxLoc	Core	Data-Parallelism	Reducer for Reduction providing maximum and an associated index
(U)MDRangePolicy	Core	Execution Policies	Policy to iterate over a multidimensional index range.
MemorySpace concept	Core	Spaces	Concept for execution spaces.
Min	Core	Data-Parallelism	Reducer for Minimum reduction
MinLoc	Core	Data-Parallelism	Reducer for Reduction providing minimum and an associated index
MinMax	Core	Data-Parallelism	Reducer for Reduction providing both minimum and maximum
MinMaxLoc	Core	Data-Parallelism	Reducer for Reduction providing both minimum and maximum and associated indicies
OpenMP	Core	Spaces	Execution space using non-target OpenMP parallel execution mechanisms.
OpenMPTarget	Core	Spaces	Execution space using targetoffload OpenMP parallel execution mechanisms.
pair	Core	STL Compatibility	Device compatible std::pair analogue
parallel_for	Core	Data-Parallelism	Bulk execute of independent work items.
ParallelForTag	Core	Data-Parallelism	Tag passed to team_size functions
parallel_reduce	Core	Data-Parallelism	Bulk execute of independent work items, which contribute to a reduction.
ParallelReduceTag	Core	Data-Parallelism	Tag passed to team_size functions
parallel_scan	Core	Data-Parallelism	Bulk execute of work items, which a simple pre- or postfix scan dependency.
ParallelScanTag	Core	Data-Parallelism	Tag passed to team_size functions
PerTeam	Core	Execution Policies	Policy used in single construct to indicate once per team execution.
PerThread	Core	Execution Policies	Policy used in single construct to indicate once per thread execution.
Prod	Core	Data-Parallelism	Reducer for Multiplicative reduction
RangePolicy	Core	Execution Policies	Policy to iterate over a 1D index range.
realloc	Core	View	Resize an existing view without maintaining the content
ReducerConcept	Core	Data-Parallelism	Provides the concept for Reducers.
resize	Core	View	Resize an existing view while maintaining the content
ScopeGuard	Core	Initialization and Finalization	class to aggregate initializing and finalizing Kokkos
SpaceAccessibility	Core	Spaces	Facility to query accessibility rules between execution and memory spaces.
subview	Core	View	Crating multi-dimensional array which is a slice of a view
Sum	Core	Data-Parallelism	Reducer for Sum reduction
TeamHandle concept	Core	Execution Policies	Provides the concept for the member_type of a TeamPolicy.
(U)TeamPolicy	Core	Execution Policies	Policy to iterate over a 1D index range, assigning to each iteration a team of threads.
TeamThreadRange	Core	Execution Policies	Policy to iterate over a 1D index range with the threads of a team.
TeamVectorRange	Core	Execution Policies	Policy to iterate over a 1D index range with the threads and vector lanes of a team.
ThreadVectorRange	Core	Execution Policies	Policy to iterate over a 1D index range with the vector lanes of a thread.
Timer	Core	Utilities	A basic timer returning seconds
View	Core	View	A multi-dimensional array
View-like Type Concept	Core	View	A set of class templates that act like a View