Program Listing for File BitStream.h

↰ Return to documentation for file (ADS/succinct/BitStream.h)

/*--------------------------------------------------------------------------*/
/*---------------------------- File BitStream.h ----------------------------*/
/*--------------------------------------------------------------------------*/
/*--------------------------------------------------------------------------*/
/*----------------------------- DEFINITIONS --------------------------------*/
/*--------------------------------------------------------------------------*/

#ifndef __ADS_BitStream
 #define __ADS_BitStream
                      /* self-identification: #endif constant */

/*--------------------------------------------------------------------------*/
/*------------------------------ INCLUDES ----------------------------------*/
/*--------------------------------------------------------------------------*/

#include "ADS/Contract.h"
#include "ADS/combinatorial/Bitwise.h"
#include "ADS/succinct/BitVector.h"

#include <bit>
#include <cstddef>
#include <cstdint>
#include <type_traits>
#include <utility>

/*--------------------------------------------------------------------------*/
/*--------------------------- NAMESPACE ------------------------------------*/
/*--------------------------------------------------------------------------*/

namespace ADS {

/*--------------------------------------------------------------------------*/
/*---------------------------- CLASS BitWriter -----------------------------*/
/*--------------------------------------------------------------------------*/

class BitWriter {

/*--------------------------------------------------------------------------*/
 public:

 BitWriter( void ) = default;

 [[nodiscard]] std::size_t size( void ) const;

 void writeBit( bool b );

 void write( Word v , int len );

 void writeBinary( Word v , int len );

 void writeUnary( std::uint64_t q );

 [[nodiscard]] const BitVector & bits( void ) const;

 [[nodiscard]] BitVector release( void );

/*--------------------------------------------------------------------------*/
 private:

 BitVector f_b;

 };  // end( class BitWriter )

/*--------------------------------------------------------------------------*/
/*---------------------------- CLASS BitReader -----------------------------*/
/*--------------------------------------------------------------------------*/

class BitReader {

/*--------------------------------------------------------------------------*/
 public:

 explicit BitReader( const BitVector & b , std::size_t p = 0 );

 [[nodiscard]] std::size_t position( void ) const;

 void seek( std::size_t p );

 [[nodiscard]] bool atEnd( void ) const;

 [[nodiscard]] bool readBit( void );

 [[nodiscard]] Word read( int len );

 [[nodiscard]] Word readBinary( int len );

 [[nodiscard]] std::uint64_t readUnary( void );

/*--------------------------------------------------------------------------*/
 private:

 const BitVector * f_b;
 std::size_t f_p;

 };  // end( class BitReader )

/*--------------------------------------------------------------------------*/

}  // end( namespace ADS )

/*--------------------------------------------------------------------------*/
/*-------------------------- IMPLEMENTATION --------------------------------*/
/*--------------------------------------------------------------------------*/

#include "ADS/succinct/impl/BitStream.tpp"

/*--------------------------------------------------------------------------*/

#endif  /* BitStream.h included */

/*--------------------------------------------------------------------------*/
/*-------------------------- End File BitStream.h --------------------------*/
/*--------------------------------------------------------------------------*/