rapidsmpf::shuffler::detail Namespace Reference

Shuffler private interfaces. More...

Classes
class	Chunk
	Chunk with multiple messages. This class contains two buffers for concatenated metadata and data. More...
class	ReadyForDataMessage
	Represents a message indicating readiness to receive data for a specific chunk. More...
class	FinishCounter
	Helper to tally the finish status of a shuffle. More...
class	PostBox
	A thread-safe container for managing and retrieving data chunks by partition and chunk 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, ReadyForDataMessage const &obj)
	Overloads the stream insertion operator for the ReadyForDataMessage class. More...
template<typename KeyType >
std::ostream &	operator<< (std::ostream &os, PostBox< KeyType > const &obj)
	Overloads the stream insertion operator for the PostBox 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-2025, NVIDIA CORPORATION & AFFILIATES. SPDX-License-Identifier: Apache-2.0

Function Documentation

operator<<() [1/3]

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

inline

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.

Definition at line 450 of file chunk.hpp.

operator<<() [2/3]

template<typename KeyType >

std::ostream& rapidsmpf::shuffler::detail::operator<< ( std::ostream &  os, PostBox< KeyType > const &  obj  )

inline

Overloads the stream insertion operator for the PostBox class.

This function allows a description of a PostBox 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 146 of file postbox.hpp.

operator<<() [3/3]

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

inline

Overloads the stream insertion operator for the ReadyForDataMessage class.

This function allows a description of a ReadyForDataMessage 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 465 of file chunk.hpp.