CUDA Streams

Files
file	cuda_stream.hpp
file	cuda_stream_pool.hpp
file	cuda_stream_view.hpp

Classes
class	rmm::cuda_stream
	Owning wrapper for a CUDA stream. More...
class	rmm::cuda_stream_pool
	A pool of CUDA streams. More...
class	rmm::cuda_stream_view
	Strongly-typed non-owning wrapper for CUDA streams with default constructor. More...

Functions
bool	rmm::operator== (cuda_stream_view lhs, cuda_stream_view rhs)
	Equality comparison operator for streams. More...
template<std::same_as< cuda::stream_ref > StreamRef>
bool	rmm::operator== (cuda_stream_view lhs, StreamRef const &rhs)
	Equality comparison operator for streams. More...
template<std::same_as< cuda::stream_ref > StreamRef>
bool	rmm::operator== (StreamRef const &lhs, cuda_stream_view rhs)
	Equality comparison operator for streams. More...
bool	rmm::operator!= (cuda_stream_view lhs, cuda_stream_view rhs)
	Inequality comparison operator for streams. More...
template<std::same_as< cuda::stream_ref > StreamRef>
bool	rmm::operator!= (cuda_stream_view lhs, StreamRef const &rhs)
	Inequality comparison operator for streams. More...
template<std::same_as< cuda::stream_ref > StreamRef>
bool	rmm::operator!= (StreamRef const &lhs, cuda_stream_view rhs)
	Inequality comparison operator for streams. More...
std::ostream &	rmm::operator<< (std::ostream &os, cuda_stream_view stream)
	Output stream operator for printing / logging streams. More...

Variables
static constexpr cuda::stream_ref	rmm::cuda_stream_default {cudaStream_t{nullptr}}
	Static cuda::stream_ref of the default stream (stream 0), for convenience. More...
static const cuda::stream_ref	rmm::cuda_stream_legacy {cudaStream_t{cudaStreamLegacy}}
	Static cuda::stream_ref of cudaStreamLegacy, for convenience. More...
static const cuda::stream_ref	rmm::cuda_stream_per_thread {cudaStream_t{cudaStreamPerThread}}
	Static cuda::stream_ref of cudaStreamPerThread, for convenience. More...

Detailed Description

Function Documentation

operator!=() [1/3]

bool rmm::operator!=	(	cuda_stream_view	lhs,
		cuda_stream_view	rhs
	)

Inequality comparison operator for streams.

Parameters

lhs	The first stream to compare
rhs	The second stream to compare

Returns

true if unequal, false if equal

operator!=() [2/3]

template<std::same_as< cuda::stream_ref > StreamRef>

bool rmm::operator!=	(	cuda_stream_view	lhs,
		StreamRef const &	rhs
	)

Inequality comparison operator for streams.

Parameters

lhs	The first stream to compare
rhs	The second stream to compare

Returns

true if unequal, false if equal

operator!=() [3/3]

template<std::same_as< cuda::stream_ref > StreamRef>

bool rmm::operator!=	(	StreamRef const &	lhs,
		cuda_stream_view	rhs
	)

Inequality comparison operator for streams.

Parameters

lhs	The first stream to compare
rhs	The second stream to compare

Returns

true if unequal, false if equal

operator<<()

std::ostream& rmm::operator<<	(	std::ostream &	os,
		cuda_stream_view	stream
	)

Output stream operator for printing / logging streams.

Parameters

os	The output ostream
stream	The cuda_stream_view to output

Returns

std::ostream& The output ostream

operator==() [1/3]

bool rmm::operator==	(	cuda_stream_view	lhs,
		cuda_stream_view	rhs
	)

Equality comparison operator for streams.

Parameters

lhs	The first stream to compare
rhs	The second stream to compare

Returns

true if equal, false if unequal

operator==() [2/3]

template<std::same_as< cuda::stream_ref > StreamRef>

bool rmm::operator==	(	cuda_stream_view	lhs,
		StreamRef const &	rhs
	)

Equality comparison operator for streams.

Parameters

lhs	The first stream to compare
rhs	The second stream to compare

Returns

true if equal, false if unequal

operator==() [3/3]

template<std::same_as< cuda::stream_ref > StreamRef>

bool rmm::operator==	(	StreamRef const &	lhs,
		cuda_stream_view	rhs
	)

Equality comparison operator for streams.

Parameters

lhs	The first stream to compare
rhs	The second stream to compare

Returns

true if equal, false if unequal

Variable Documentation

cuda_stream_default

constexpr cuda::stream_ref rmm::cuda_stream_default {cudaStream_t{nullptr}}

staticconstexpr

Static cuda::stream_ref of the default stream (stream 0), for convenience.

Deprecated:

Use cuda::stream_ref{cudaStream_t{cudaStreamDefault}} instead.

cuda_stream_legacy

const cuda::stream_ref rmm::cuda_stream_legacy {cudaStream_t{cudaStreamLegacy}}

static

Static cuda::stream_ref of cudaStreamLegacy, for convenience.

Deprecated:

Use cuda::stream_ref{cudaStreamLegacy} instead.

cuda_stream_per_thread

const cuda::stream_ref rmm::cuda_stream_per_thread {cudaStream_t{cudaStreamPerThread}}

static

Static cuda::stream_ref of cudaStreamPerThread, for convenience.

Deprecated:

Use cuda::stream_ref{cudaStreamPerThread} instead.