cudf::io::writer_compression_statistics Class Reference

Statistics about compression performed by a writer. More...

#include <cudf/io/types.hpp>

Public Member Functions
	writer_compression_statistics ()=default
	Default constructor.
	writer_compression_statistics (size_t num_compressed_bytes, size_t num_failed_bytes, size_t num_skipped_bytes, size_t num_compressed_output_bytes)
	Constructor with initial values. More...
writer_compression_statistics &	operator+= (writer_compression_statistics const &other) noexcept
	Adds the values from another writer_compression_statistics object. More...
auto	num_compressed_bytes () const noexcept
	Returns the number of bytes in blocks that were successfully compressed. More...
auto	num_failed_bytes () const noexcept
	Returns the number of bytes in blocks that failed to compress. More...
auto	num_skipped_bytes () const noexcept
	Returns the number of bytes in blocks that were skipped during compression. More...
auto	num_total_input_bytes () const noexcept
	Returns the total size of compression inputs. More...
auto	compression_ratio () const noexcept
	Returns the compression ratio for the successfully compressed blocks. More...

Detailed Description

Statistics about compression performed by a writer.

Definition at line 116 of file types.hpp.

Constructor & Destructor Documentation

writer_compression_statistics()

cudf::io::writer_compression_statistics::writer_compression_statistics ( size_t  num_compressed_bytes, size_t  num_failed_bytes, size_t  num_skipped_bytes, size_t  num_compressed_output_bytes  )

inline

Constructor with initial values.

Parameters

num_compressed_bytes	The number of bytes that were successfully compressed
num_failed_bytes	The number of bytes that failed to compress
num_skipped_bytes	The number of bytes that were skipped during compression
num_compressed_output_bytes	The number of bytes in the compressed output

Definition at line 131 of file types.hpp.

Member Function Documentation

compression_ratio()

auto cudf::io::writer_compression_statistics::compression_ratio ( ) const

inlinenoexcept

Returns the compression ratio for the successfully compressed blocks.

Returns nan if there were no successfully compressed blocks.

Returns

double The ratio between the size of the compression inputs and the size of the compressed output.

Definition at line 199 of file types.hpp.

num_compressed_bytes()

auto cudf::io::writer_compression_statistics::num_compressed_bytes ( ) const

inlinenoexcept

Returns the number of bytes in blocks that were successfully compressed.

This is the number of bytes that were actually compressed, not the size of the compressed output.

Returns

size_t The number of bytes that were successfully compressed

Definition at line 165 of file types.hpp.

num_failed_bytes()

auto cudf::io::writer_compression_statistics::num_failed_bytes ( ) const

inlinenoexcept

Returns the number of bytes in blocks that failed to compress.

Returns

size_t The number of bytes that failed to compress

Definition at line 172 of file types.hpp.

num_skipped_bytes()

auto cudf::io::writer_compression_statistics::num_skipped_bytes ( ) const

inlinenoexcept

Returns the number of bytes in blocks that were skipped during compression.

Returns

size_t The number of bytes that were skipped during compression

Definition at line 179 of file types.hpp.

num_total_input_bytes()

auto cudf::io::writer_compression_statistics::num_total_input_bytes ( ) const

inlinenoexcept

Returns the total size of compression inputs.

Returns

size_t The total size of compression inputs

Definition at line 186 of file types.hpp.

operator+=()

writer_compression_statistics& cudf::io::writer_compression_statistics::operator+= ( writer_compression_statistics const &  other )

inlinenoexcept

Adds the values from another writer_compression_statistics object.

Parameters

other

The other writer_compression_statistics object

Returns

writer_compression_statistics& Reference to this object

Definition at line 148 of file types.hpp.

---

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

• cudf/io/types.hpp