rapidsmpf::shuffler::detail Namespace Reference

Shuffler private interfaces. More...

Classes
class	Chunk
	A partition chunk representing either a data message or a control message. More...
class	FinishCounter
	Helper to tally the finish status of a shuffle. More...
class	ChunksToSend
	A thread-safe container for managing outgoing (to send) chunks. More...
class	ReceivedChunks
	A thread-safe container for managing received chunks stratified by partition ID. More...

Typedefs
using	ChunkID = std::uint64_t
	The globally unique ID of a chunk.

Functions
std::ostream &	operator<< (std::ostream &os, Chunk const &obj)
	Overloads the stream insertion operator for the Chunk class. More...
std::ostream &	operator<< (std::ostream &os, ChunksToSend const &obj)
	Overloads the stream insertion operator for the ChunksToSend class. More...
std::ostream &	operator<< (std::ostream &os, ReceivedChunks const &obj)
	Overloads the stream insertion operator for the ReceivedChunks class. More...

Detailed Description

Shuffler private interfaces.

This namespace contains private interfaces for internal workings of the shuffler. These interfaces may change without notice and should not be relied upon directly.

SPDX-FileCopyrightText: Copyright (c) 2024-2026, NVIDIA CORPORATION & AFFILIATES. All rights reserved. SPDX-License-Identifier: Apache-2.0

Function Documentation

operator<<() [1/3]

std::ostream& rapidsmpf::shuffler::detail::operator<<	(	std::ostream &	os,
		Chunk const &	obj
	)

Overloads the stream insertion operator for the Chunk class.

This function allows a description of a Chunk to be written to an output stream.

Parameters

os	The output stream to write to.
obj	The object to write.

Returns

A reference to the modified output stream.

operator<<() [2/3]

std::ostream& rapidsmpf::shuffler::detail::operator<< ( std::ostream &  os, ChunksToSend const &  obj  )

inline

Overloads the stream insertion operator for the ChunksToSend class.

This function allows a description of ChunksToSend to be written to an output stream.

Parameters

os	The output stream to write to.
obj	The object to write.

Returns

A reference to the modified output stream.

Definition at line 64 of file postbox.hpp.

operator<<() [3/3]

std::ostream& rapidsmpf::shuffler::detail::operator<< ( std::ostream &  os, ReceivedChunks const &  obj  )

inline

Overloads the stream insertion operator for the ReceivedChunks class.

This function allows a description of ReceivedChunks be written to an output stream.

Parameters

os	The output stream to write to.
obj	The object to write.

Returns

A reference to the modified output stream.

Definition at line 155 of file postbox.hpp.