<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.16.1" xml:lang="en-US">
  <compounddef id="classgr_1_1blocks_1_1kernel_1_1unpack__k__bits" kind="class" language="C++" prot="public">
    <compoundname>gr::blocks::kernel::unpack_k_bits</compoundname>
    <includes refid="unpack__k__bits_8h" local="no">gnuradio/blocks/unpack_k_bits.h</includes>
    <sectiondef kind="private-attrib">
      <memberdef kind="variable" id="classgr_1_1blocks_1_1kernel_1_1unpack__k__bits_1a96e45e2d2f7109daaca192a2663418da" prot="private" static="no" mutable="no">
        <type>unsigned</type>
        <definition>unsigned gr::blocks::kernel::unpack_k_bits::d_k</definition>
        <argsstring></argsstring>
        <name>d_k</name>
        <qualifiedname>gr::blocks::kernel::unpack_k_bits::d_k</qualifiedname>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="gr-blocks/include/gnuradio/blocks/unpack_k_bits.h" line="67" column="14" bodyfile="gr-blocks/include/gnuradio/blocks/unpack_k_bits.h" bodystart="67" bodyend="-1"/>
      </memberdef>
    </sectiondef>
    <sectiondef kind="public-func">
      <memberdef kind="function" id="classgr_1_1blocks_1_1kernel_1_1unpack__k__bits_1a491f3018fd04671c96e06ad364b5b384" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type></type>
        <definition>gr::blocks::kernel::unpack_k_bits::unpack_k_bits</definition>
        <argsstring>(unsigned k)</argsstring>
        <name>unpack_k_bits</name>
        <qualifiedname>gr::blocks::kernel::unpack_k_bits::unpack_k_bits</qualifiedname>
        <param>
          <type>unsigned</type>
          <declname>k</declname>
        </param>
        <briefdescription>
<para>Make an <ref refid="classgr_1_1blocks_1_1kernel_1_1unpack__k__bits" kindref="compound">unpack_k_bits</ref> object. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername><ref refid="classgr_1_1blocks_1_1kernel_1_1unpack__k__bits_1af826cd3cd28e49f64a1844a52ddd6938" kindref="member">k</ref></parametername>
</parameternamelist>
<parameterdescription>
<para>number of bits to unpack. </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="gr-blocks/include/gnuradio/blocks/unpack_k_bits.h" line="43" column="5"/>
        <references refid="classgr_1_1blocks_1_1kernel_1_1unpack__k__bits_1af826cd3cd28e49f64a1844a52ddd6938">k</references>
      </memberdef>
      <memberdef kind="function" id="classgr_1_1blocks_1_1kernel_1_1unpack__k__bits_1aeadb4a664a6587b7e106a94cc5c65ec4" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type></type>
        <definition>gr::blocks::kernel::unpack_k_bits::~unpack_k_bits</definition>
        <argsstring>()</argsstring>
        <name>~unpack_k_bits</name>
        <qualifiedname>gr::blocks::kernel::unpack_k_bits::~unpack_k_bits</qualifiedname>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="gr-blocks/include/gnuradio/blocks/unpack_k_bits.h" line="44" column="5"/>
      </memberdef>
      <memberdef kind="function" id="classgr_1_1blocks_1_1kernel_1_1unpack__k__bits_1a84d34884382012ca6e0e8efa7efff490" prot="public" static="no" const="yes" explicit="no" inline="no" virt="non-virtual">
        <type>void</type>
        <definition>void gr::blocks::kernel::unpack_k_bits::unpack</definition>
        <argsstring>(unsigned char *bits, const unsigned char *bytes, int nbytes) const</argsstring>
        <name>unpack</name>
        <qualifiedname>gr::blocks::kernel::unpack_k_bits::unpack</qualifiedname>
        <param>
          <type>unsigned char *</type>
          <declname>bits</declname>
        </param>
        <param>
          <type>const unsigned char *</type>
          <declname>bytes</declname>
        </param>
        <param>
          <type>int</type>
          <declname>nbytes</declname>
        </param>
        <briefdescription>
<para>Perform the unpacking. </para>
        </briefdescription>
        <detaileddescription>
<para>This function performs no bounds checking. It assumes that the input, <computeroutput>in</computeroutput>, has of length <computeroutput>nbytes</computeroutput> and that the output vector, <computeroutput>out</computeroutput>, has k*nbytes available for writing.</para>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>bits</parametername>
</parameternamelist>
<parameterdescription>
<para>output vector (1-bit per byte) of the unpacked data </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>bytes</parametername>
</parameternamelist>
<parameterdescription>
<para>The input vector of bytes to unpack </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>nbytes</parametername>
</parameternamelist>
<parameterdescription>
<para>The number of input bytes </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="gr-blocks/include/gnuradio/blocks/unpack_k_bits.h" line="57" column="10"/>
      </memberdef>
      <memberdef kind="function" id="classgr_1_1blocks_1_1kernel_1_1unpack__k__bits_1a230bd9047f5ae1864db6d5718584cef7" prot="public" static="no" const="yes" explicit="no" inline="no" virt="non-virtual">
        <type>void</type>
        <definition>void gr::blocks::kernel::unpack_k_bits::unpack_rev</definition>
        <argsstring>(unsigned char *bits, const unsigned char *bytes, int nbytes) const</argsstring>
        <name>unpack_rev</name>
        <qualifiedname>gr::blocks::kernel::unpack_k_bits::unpack_rev</qualifiedname>
        <param>
          <type>unsigned char *</type>
          <declname>bits</declname>
        </param>
        <param>
          <type>const unsigned char *</type>
          <declname>bytes</declname>
        </param>
        <param>
          <type>int</type>
          <declname>nbytes</declname>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>Unpacks in reverse order from <ref refid="classgr_1_1blocks_1_1kernel_1_1unpack__k__bits_1a84d34884382012ca6e0e8efa7efff490" kindref="member">unpack()</ref>. </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="gr-blocks/include/gnuradio/blocks/unpack_k_bits.h" line="62" column="10"/>
      </memberdef>
      <memberdef kind="function" id="classgr_1_1blocks_1_1kernel_1_1unpack__k__bits_1af826cd3cd28e49f64a1844a52ddd6938" prot="public" static="no" const="yes" explicit="no" inline="no" virt="non-virtual">
        <type>int</type>
        <definition>int gr::blocks::kernel::unpack_k_bits::k</definition>
        <argsstring>() const</argsstring>
        <name>k</name>
        <qualifiedname>gr::blocks::kernel::unpack_k_bits::k</qualifiedname>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="gr-blocks/include/gnuradio/blocks/unpack_k_bits.h" line="64" column="9"/>
        <referencedby refid="classgr_1_1blocks_1_1kernel_1_1unpack__k__bits_1a491f3018fd04671c96e06ad364b5b384">unpack_k_bits</referencedby>
      </memberdef>
    </sectiondef>
    <briefdescription>
<para>Converts a byte with k relevant bits to k output bytes with 1 bit in the LSB. </para>
    </briefdescription>
    <detaileddescription>
<para>This is the algorithm kernel for the <ref refid="classgr_1_1blocks_1_1unpack__k__bits__bb" kindref="compound">gr::blocks::unpack_k_bits_bb</ref> block.</para>
<para>Example: k = 4 in = [0xf5, 0x08] out = [0,1,0,1, 1,0,0,0]</para>
<para>k = 8 in = [0xf5, 0x08] out = [1,1,1,1, 0,1,0,1, 0,0,0,0, 1,0,0,0] </para>
    </detaileddescription>
    <location file="gr-blocks/include/gnuradio/blocks/unpack_k_bits.h" line="36" column="1" bodyfile="gr-blocks/include/gnuradio/blocks/unpack_k_bits.h" bodystart="37" bodyend="68"/>
    <listofallmembers>
      <member refid="classgr_1_1blocks_1_1kernel_1_1unpack__k__bits_1a96e45e2d2f7109daaca192a2663418da" prot="private" virt="non-virtual"><scope>gr::blocks::kernel::unpack_k_bits</scope><name>d_k</name></member>
      <member refid="classgr_1_1blocks_1_1kernel_1_1unpack__k__bits_1af826cd3cd28e49f64a1844a52ddd6938" prot="public" virt="non-virtual"><scope>gr::blocks::kernel::unpack_k_bits</scope><name>k</name></member>
      <member refid="classgr_1_1blocks_1_1kernel_1_1unpack__k__bits_1a84d34884382012ca6e0e8efa7efff490" prot="public" virt="non-virtual"><scope>gr::blocks::kernel::unpack_k_bits</scope><name>unpack</name></member>
      <member refid="classgr_1_1blocks_1_1kernel_1_1unpack__k__bits_1a491f3018fd04671c96e06ad364b5b384" prot="public" virt="non-virtual"><scope>gr::blocks::kernel::unpack_k_bits</scope><name>unpack_k_bits</name></member>
      <member refid="classgr_1_1blocks_1_1kernel_1_1unpack__k__bits_1a230bd9047f5ae1864db6d5718584cef7" prot="public" virt="non-virtual"><scope>gr::blocks::kernel::unpack_k_bits</scope><name>unpack_rev</name></member>
      <member refid="classgr_1_1blocks_1_1kernel_1_1unpack__k__bits_1aeadb4a664a6587b7e106a94cc5c65ec4" prot="public" virt="non-virtual"><scope>gr::blocks::kernel::unpack_k_bits</scope><name>~unpack_k_bits</name></member>
    </listofallmembers>
  </compounddef>
</doxygen>
