fz::NegabinaryStage< TIn, TOut > Class Template Reference

#include <negabinary_stage.h>

Inheritance diagram for fz::NegabinaryStage< TIn, TOut >:

Public Member Functions
void	setInverse (bool inv) override
std::string	getName () const override
std::vector< size_t >	estimateOutputSizes (const std::vector< size_t > &input_sizes) const override
std::unordered_map< std::string, size_t >	getActualOutputSizesByName () const override
size_t	getActualOutputSize (int index) const override
uint16_t	getStageTypeId () const override
uint8_t	getOutputDataType (size_t) const override
uint8_t	getInputDataType (size_t) const override
size_t	serializeHeader (size_t, uint8_t *buf, size_t max_size) const override
void	deserializeHeader (const uint8_t *, size_t) override
size_t	getMaxHeaderSize (size_t) const override
void	execute (cudaStream_t stream, MemoryPool *pool, const std::vector< void * > &inputs, const std::vector< void * > &outputs, const std::vector< size_t > &sizes) override
Public Member Functions inherited from fz::Stage
virtual size_t	getRequiredInputAlignment () const
virtual std::vector< std::string >	getOutputNames () const
int	getOutputIndex (const std::string &name) const
virtual void	saveState ()
virtual void	setDims (const std::array< size_t, 3 > &dims)
virtual void	postStreamSync (cudaStream_t stream)
virtual bool	isGraphCompatible () const
virtual size_t	estimateScratchBytes (const std::vector< size_t > &input_sizes) const

Detailed Description

template<typename TIn, typename TOut = typename std::make_unsigned<TIn>::type>
class fz::NegabinaryStage< TIn, TOut >

Element-wise negabinary encode/decode stage. Forward: TIn[] → TOut[]; inverse: TOut[] → TIn[].

Template Parameters

TIn	Signed integer type.
TOut	Corresponding unsigned type (same width as TIn).

Member Function Documentation

setInverse()

template<typename TIn , typename TOut = typename std::make_unsigned<TIn>::type>

void fz::NegabinaryStage< TIn, TOut >::setInverse ( bool  inverse )

inlineoverridevirtual

Switch between forward (compression) and inverse (decompression) mode. Affects getNumInputs()/getNumOutputs() for stages with asymmetric port counts.

Reimplemented from fz::Stage.

getName()

template<typename TIn , typename TOut = typename std::make_unsigned<TIn>::type>

std::string fz::NegabinaryStage< TIn, TOut >::getName ( ) const

inlineoverridevirtual

Human-readable name used in error messages and debug output.

Implements fz::Stage.

estimateOutputSizes()

template<typename TIn , typename TOut = typename std::make_unsigned<TIn>::type>

std::vector< size_t > fz::NegabinaryStage< TIn, TOut >::estimateOutputSizes ( const std::vector< size_t > &  input_sizes ) const

inlineoverridevirtual

Estimate output buffer sizes given input sizes. Used for buffer allocation planning in PREALLOCATE mode — must be a safe upper bound; under-estimation causes buffer overruns.

Implements fz::Stage.

getActualOutputSizesByName()

template<typename TIn , typename TOut = typename std::make_unsigned<TIn>::type>

std::unordered_map< std::string, size_t > fz::NegabinaryStage< TIn, TOut >::getActualOutputSizesByName ( ) const

inlineoverridevirtual

Actual output sizes after execute(), keyed by output port name.

Implements fz::Stage.

getActualOutputSize()

template<typename TIn , typename TOut = typename std::make_unsigned<TIn>::type>

size_t fz::NegabinaryStage< TIn, TOut >::getActualOutputSize ( int  index ) const

inlineoverridevirtual

Actual size of a single output by index after execute(). Avoids constructing the map for the common single-output case. Default delegates to getActualOutputSizesByName(); override to return directly from an internal field.

Reimplemented from fz::Stage.

getStageTypeId()

template<typename TIn , typename TOut = typename std::make_unsigned<TIn>::type>

uint16_t fz::NegabinaryStage< TIn, TOut >::getStageTypeId ( ) const

inlineoverridevirtual

Stage type identifier written into the FZM file header.

Implements fz::Stage.

getOutputDataType()

template<typename TIn , typename TOut = typename std::make_unsigned<TIn>::type>

uint8_t fz::NegabinaryStage< TIn, TOut >::getOutputDataType ( size_t  output_index ) const

inlineoverridevirtual

DataType enum of the given output port.

Implements fz::Stage.

getInputDataType()

template<typename TIn , typename TOut = typename std::make_unsigned<TIn>::type>

uint8_t fz::NegabinaryStage< TIn, TOut >::getInputDataType ( size_t  ) const

inlineoverridevirtual

Expected DataType of the given input port.

Used by Pipeline::finalize() to detect type mismatches between connected stages before any execution. Return DataType::UNKNOWN to opt out of checking — byte-transparent stages (Bitshuffle, RZE) and mock stages must return UNKNOWN; finalize() skips any connection where either side is UNKNOWN.

Reimplemented from fz::Stage.

serializeHeader()

template<typename TIn , typename TOut = typename std::make_unsigned<TIn>::type>

size_t fz::NegabinaryStage< TIn, TOut >::serializeHeader ( size_t  output_index, uint8_t *  header_buffer, size_t  max_size  ) const

inlineoverridevirtual

Serialize stage config into header_buffer (max 128 bytes) for the FZM file. Return the number of bytes written, or 0 if the stage has no config.

Reimplemented from fz::Stage.

deserializeHeader()

template<typename TIn , typename TOut = typename std::make_unsigned<TIn>::type>

void fz::NegabinaryStage< TIn, TOut >::deserializeHeader ( const uint8_t *  header_buffer, size_t  size  )

inlineoverridevirtual

Restore stage config from header_buffer during decompression.

Reimplemented from fz::Stage.

getMaxHeaderSize()

template<typename TIn , typename TOut = typename std::make_unsigned<TIn>::type>

size_t fz::NegabinaryStage< TIn, TOut >::getMaxHeaderSize ( size_t  output_index ) const

inlineoverridevirtual

Maximum bytes this stage writes into its per-output FZM header slot.

Reimplemented from fz::Stage.

execute()

template<typename TIn , typename TOut = typename std::make_unsigned<TIn>::type>

void fz::NegabinaryStage< TIn, TOut >::execute ( cudaStream_t  stream, MemoryPool *  pool, const std::vector< void * > &  inputs, const std::vector< void * > &  outputs, const std::vector< size_t > &  sizes  )

overridevirtual

Execute the stage. Inputs, outputs, and sizes are device pointers/bytes.

Implements fz::Stage.