Tpetra parallel linear algebra  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | List of all members
Tpetra::Details::Spaces::Slot< ExecSpace > Class Template Reference

Lazily acquires and stores Kokkos Execution Spaces. More...

#include <Tpetra_Details_ExecutionSpacesSlot.hpp>

Public Member Functions

 Slot ()
 Default constructor that creates instances for each possible space priority level. More...
 
template<Spaces::Priority priority = Spaces::Priority::medium>
Teuchos::RCP< const
execution_space > 
space_instance () const
 Get a specific execution space instance based on the given priority level. More...
 
Teuchos::RCP< const
execution_space > 
space_instance (const Spaces::Priority &priority) const
 Get a specific execution space instance based on the given priority level. More...
 

Detailed Description

template<typename ExecSpace>
class Tpetra::Details::Spaces::Slot< ExecSpace >

Lazily acquires and stores Kokkos Execution Spaces.

Template Parameters
ExecSpacethe type of the execution space to be wrapped.

Definition at line 22 of file Tpetra_Details_ExecutionSpacesSlot.hpp.

Constructor & Destructor Documentation

template<typename ExecSpace >
Tpetra::Details::Spaces::Slot< ExecSpace >::Slot ( )
inline

Default constructor that creates instances for each possible space priority level.

Definition at line 30 of file Tpetra_Details_ExecutionSpacesSlot.hpp.

Member Function Documentation

template<typename ExecSpace >
template<Spaces::Priority priority = Spaces::Priority::medium>
Teuchos::RCP<const execution_space> Tpetra::Details::Spaces::Slot< ExecSpace >::space_instance ( ) const
inline

Get a specific execution space instance based on the given priority level.

Template Parameters
prioritythe priority level of the desired execution space instance. Default value is medium.
Returns
Teuchos::RCP<const execution_space> a smart pointer to a const execution_space object.
Note
This template method is used to get the execution space instance based on the template parameter priority.

Definition at line 50 of file Tpetra_Details_ExecutionSpacesSlot.hpp.

template<typename ExecSpace >
Teuchos::RCP<const execution_space> Tpetra::Details::Spaces::Slot< ExecSpace >::space_instance ( const Spaces::Priority &  priority) const
inline

Get a specific execution space instance based on the given priority level.

Parameters
prioritythe priority level of the desired execution space instance.
Returns
Teuchos::RCP<const execution_space> a smart pointer to a const execution_space object.
Note
This non-template method is used to get the execution space instance based on the runtime parameter priority. It returns the corresponding execution space instance by calling the corresponding template method. Throws a runtime error if the given priority is not valid.

Definition at line 67 of file Tpetra_Details_ExecutionSpacesSlot.hpp.


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