kokkos-execution 0.0.1
Loading...
Searching...
No Matches
Kokkos::Execution::Impl::ExecutionSpaceRef< Exec > Struct Template Reference

Wrap a Kokkos execution space to make it cheap to copy/move in new environments. More...

#include <get_exec.hpp>

Public Types

using execution_space = Exec

Public Member Functions

constexpr ExecutionSpaceRef (const execution_space &exec) noexcept
 ExecutionSpaceRef ()=delete
 ExecutionSpaceRef (const ExecutionSpaceRef &) noexcept=default
ExecutionSpaceRef & operator= (const ExecutionSpaceRef &) noexcept=default
 ExecutionSpaceRef (ExecutionSpaceRef &&) noexcept=default
ExecutionSpaceRef & operator= (ExecutionSpaceRef &&) noexcept=default
 ~ExecutionSpaceRef () noexcept=default
const execution_space & get () const noexcept
constexpr const ExecutionSpaceRef & query (const get_exec_t &) const noexcept

Public Attributes

execution_space const * m_exec_ptr

Friends

constexpr auto operator<=> (const ExecutionSpaceRef &, const ExecutionSpaceRef &) noexcept=default

Detailed Description

template<Kokkos::ExecutionSpace Exec>
struct Kokkos::Execution::Impl::ExecutionSpaceRef< Exec >

Wrap a Kokkos execution space to make it cheap to copy/move in new environments.

Warning
It does not extend the lifetime of the execution space instance (it does not own it).

Inspired by https://github.com/NVIDIA/cccl/blob/cc7c08209ed4b3ef4c80dc17fa1b8507e9d1e51f/libcudacxx/include/cuda/__stream/stream_ref.h.

Definition at line 27 of file get_exec.hpp.

Member Typedef Documentation

◆ execution_space

template<Kokkos::ExecutionSpace Exec>
using Kokkos::Execution::Impl::ExecutionSpaceRef< Exec >::execution_space = Exec

Definition at line 28 of file get_exec.hpp.

Constructor & Destructor Documentation

◆ ExecutionSpaceRef() [1/4]

template<Kokkos::ExecutionSpace Exec>
Kokkos::Execution::Impl::ExecutionSpaceRef< Exec >::ExecutionSpaceRef ( const execution_space & exec)
inlineexplicitconstexprnoexcept

Definition at line 32 of file get_exec.hpp.

◆ ExecutionSpaceRef() [2/4]

template<Kokkos::ExecutionSpace Exec>
Kokkos::Execution::Impl::ExecutionSpaceRef< Exec >::ExecutionSpaceRef ( )
delete

◆ ExecutionSpaceRef() [3/4]

template<Kokkos::ExecutionSpace Exec>
Kokkos::Execution::Impl::ExecutionSpaceRef< Exec >::ExecutionSpaceRef ( const ExecutionSpaceRef< Exec > & )
defaultnoexcept

References ExecutionSpaceRef().

◆ ExecutionSpaceRef() [4/4]

template<Kokkos::ExecutionSpace Exec>
Kokkos::Execution::Impl::ExecutionSpaceRef< Exec >::ExecutionSpaceRef ( ExecutionSpaceRef< Exec > && )
defaultnoexcept

References ExecutionSpaceRef().

◆ ~ExecutionSpaceRef()

template<Kokkos::ExecutionSpace Exec>
Kokkos::Execution::Impl::ExecutionSpaceRef< Exec >::~ExecutionSpaceRef ( )
defaultnoexcept

References ExecutionSpaceRef().

Member Function Documentation

◆ get()

template<Kokkos::ExecutionSpace Exec>
const execution_space & Kokkos::Execution::Impl::ExecutionSpaceRef< Exec >::get ( ) const
inlinenoexcept

Definition at line 43 of file get_exec.hpp.

References get(), and m_exec_ptr.

◆ operator=() [1/2]

template<Kokkos::ExecutionSpace Exec>
ExecutionSpaceRef & Kokkos::Execution::Impl::ExecutionSpaceRef< Exec >::operator= ( const ExecutionSpaceRef< Exec > & )
defaultnoexcept

References ExecutionSpaceRef().

◆ operator=() [2/2]

template<Kokkos::ExecutionSpace Exec>
ExecutionSpaceRef & Kokkos::Execution::Impl::ExecutionSpaceRef< Exec >::operator= ( ExecutionSpaceRef< Exec > && )
defaultnoexcept

References ExecutionSpaceRef().

◆ query()

template<Kokkos::ExecutionSpace Exec>
const ExecutionSpaceRef & Kokkos::Execution::Impl::ExecutionSpaceRef< Exec >::query ( const get_exec_t & ) const
inlinenodiscardconstexprnoexcept

Definition at line 50 of file get_exec.hpp.

References ExecutionSpaceRef().

◆ operator<=>

template<Kokkos::ExecutionSpace Exec>
auto operator<=> ( const ExecutionSpaceRef< Exec > & ,
const ExecutionSpaceRef< Exec > &  )
friend

References ExecutionSpaceRef().

Member Data Documentation

◆ m_exec_ptr

template<Kokkos::ExecutionSpace Exec>
execution_space const* Kokkos::Execution::Impl::ExecutionSpaceRef< Exec >::m_exec_ptr

Definition at line 30 of file get_exec.hpp.

The documentation for this struct was generated from the following file:
  • /__w/kokkos-execution/kokkos-execution/kokkos-execution/impl/get_exec.hpp