hip_stream Class Reference

hip_stream Class Reference#

Reference API: gko::hip_stream Class Reference
Reference API
gko::hip_stream Class Reference

#include <ginkgo/core/base/stream.hpp>

Public Member Functions

 hip_stream ()
 
 hip_stream (int device_id)
 
 ~hip_stream ()
 
 hip_stream (const hip_stream &)=delete
 
 hip_stream (hip_stream &&)
 
hip_streamoperator= (const hip_stream &)=delete
 
hip_streamoperator= (hip_stream &&)=delete
 
CUstream_st * get () const
 

Detailed Description

An RAII wrapper for a custom HIP stream. The stream will be created on construction and destroyed when the lifetime of the wrapper ends.

Constructor & Destructor Documentation

◆ hip_stream() [1/3]

gko::hip_stream::hip_stream ( )

Creates an empty stream wrapper, representing the default stream.

◆ hip_stream() [2/3]

gko::hip_stream::hip_stream ( int  device_id)

Creates a new custom HIP stream on the given device.

Parameters
device_idthe device ID to create the stream on.

◆ ~hip_stream()

gko::hip_stream::~hip_stream ( )

Destroys the custom HIP stream, if it isn't empty.

◆ hip_stream() [3/3]

gko::hip_stream::hip_stream ( hip_stream &&  )

Move-constructs from an existing stream, which will be emptied.

Member Function Documentation

◆ get()

CUstream_st * gko::hip_stream::get ( ) const

Returns the native HIP stream handle. In an empty hip_stream, this will return nullptr.

◆ operator=()

hip_stream & gko::hip_stream::operator= ( hip_stream &&  )
delete

Move-assigns from an existing stream, which will be emptied.


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