[#BitStreamReader]
= BitStreamReader
:mrdocs:

Reads individual bits, most significant first, from an underlying byte stream.

== Synopsis

Declared in `<streams.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<typename IStream>
class BitStreamReader;
----

== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BitStreamReader/2constructor.adoc[`BitStreamReader`]         [.small]#[constructor]#
| Construct a bit reader over the given input byte stream.
| xref:BitStreamReader/Read.adoc[`Read`] 
| Read the specified number of bits from the stream. The data is returned in the nbits least significant bits of a 64‐bit uint.
|===


== Non-Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:GolombRiceDecode.adoc[`GolombRiceDecode`]
| Golomb‐Rice decode a value from a bit stream.
|===


[.small]#Created with https://www.mrdocs.com[MrDocs]#