<?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.8.14">
  <compounddef id="classforpy_1_1_renyi_entropy" kind="class" language="C++" prot="public">
    <compoundname>forpy::RenyiEntropy</compoundname>
    <basecompoundref refid="classforpy_1_1_i_entropy_function" prot="public" virt="non-virtual">forpy::IEntropyFunction</basecompoundref>
    <includes refid="renyientropy_8h" local="no">renyientropy.h</includes>
      <sectiondef kind="friend">
      <memberdef kind="friend" id="classforpy_1_1_renyi_entropy_1ab2f44cbb59a08132f4c843e5225bba0e" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>friend class</type>
        <definition>friend class cereal::access</definition>
        <argsstring></argsstring>
        <name>cereal::access</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/Users/classner/git/forpy/include/forpy/impurities/renyientropy.h" line="91" column="1" bodyfile="/Users/classner/git/forpy/include/forpy/impurities/renyientropy.h" bodystart="89" bodyend="-1"/>
      </memberdef>
      <memberdef kind="friend" id="classforpy_1_1_renyi_entropy_1a6cd19bf8dab0a8ada1bcb1ab6a183b6e" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
        <type>friend std::ostream &amp;</type>
        <definition>std::ostream&amp; operator&lt;&lt;</definition>
        <argsstring>(std::ostream &amp;stream, const RenyiEntropy &amp;self)</argsstring>
        <name>operator&lt;&lt;</name>
        <param>
          <type>std::ostream &amp;</type>
          <declname>stream</declname>
        </param>
        <param>
          <type>const <ref refid="classforpy_1_1_renyi_entropy" kindref="compound">RenyiEntropy</ref> &amp;</type>
          <declname>self</declname>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/Users/classner/git/forpy/include/forpy/impurities/renyientropy.h" line="76" column="1" bodyfile="/Users/classner/git/forpy/include/forpy/impurities/renyientropy.h" bodystart="76" bodyend="80"/>
      </memberdef>
      </sectiondef>
      <sectiondef kind="private-attrib">
      <memberdef kind="variable" id="classforpy_1_1_renyi_entropy_1a5d7ea08cb3ac0638fc4140dd9a515a37" prot="private" static="no" mutable="no">
        <type>float</type>
        <definition>float forpy::RenyiEntropy::q</definition>
        <argsstring></argsstring>
        <name>q</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/Users/classner/git/forpy/include/forpy/impurities/renyientropy.h" line="99" column="1" bodyfile="/Users/classner/git/forpy/include/forpy/impurities/renyientropy.h" bodystart="97" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="classforpy_1_1_renyi_entropy_1a95126d5f1adcfe98440a6810c1719b98" prot="private" static="no" mutable="no">
        <type>std::unique_ptr&lt; <ref refid="classforpy_1_1_shannon_entropy" kindref="compound">ShannonEntropy</ref> &gt;</type>
        <definition>std::unique_ptr&lt;ShannonEntropy&gt; forpy::RenyiEntropy::shannon_entropy</definition>
        <argsstring></argsstring>
        <name>shannon_entropy</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/Users/classner/git/forpy/include/forpy/impurities/renyientropy.h" line="100" column="1" bodyfile="/Users/classner/git/forpy/include/forpy/impurities/renyientropy.h" bodystart="100" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="classforpy_1_1_renyi_entropy_1a0584da34af0c36c89f41bff92255fb63" prot="private" static="no" mutable="no">
        <type>std::unique_ptr&lt; <ref refid="classforpy_1_1_induced_entropy" kindref="compound">InducedEntropy</ref> &gt;</type>
        <definition>std::unique_ptr&lt;InducedEntropy&gt; forpy::RenyiEntropy::induced_p</definition>
        <argsstring></argsstring>
        <name>induced_p</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/Users/classner/git/forpy/include/forpy/impurities/renyientropy.h" line="101" column="1" bodyfile="/Users/classner/git/forpy/include/forpy/impurities/renyientropy.h" bodystart="101" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="classforpy_1_1_renyi_entropy_1a6434f0324833aa756d03baa88667b80d" prot="private" static="no" mutable="no">
        <type>std::unique_ptr&lt; <ref refid="classforpy_1_1_classification_error" kindref="compound">ClassificationError</ref> &gt;</type>
        <definition>std::unique_ptr&lt;ClassificationError&gt; forpy::RenyiEntropy::classification_error</definition>
        <argsstring></argsstring>
        <name>classification_error</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/Users/classner/git/forpy/include/forpy/impurities/renyientropy.h" line="102" column="1" bodyfile="/Users/classner/git/forpy/include/forpy/impurities/renyientropy.h" bodystart="102" bodyend="-1"/>
      </memberdef>
      </sectiondef>
      <sectiondef kind="public-func">
      <memberdef kind="function" id="classforpy_1_1_renyi_entropy_1ae6460c899b7935d0c0ac68fe3c4f085d" prot="public" static="no" const="no" explicit="yes" inline="no" virt="non-virtual">
        <type></type>
        <definition>forpy::RenyiEntropy::RenyiEntropy</definition>
        <argsstring>(const float &amp;alpha)</argsstring>
        <name>RenyiEntropy</name>
        <param>
          <type>const float &amp;</type>
          <declname>alpha</declname>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/Users/classner/git/forpy/include/forpy/impurities/renyientropy.h" line="36" column="1"/>
      </memberdef>
      <memberdef kind="function" id="classforpy_1_1_renyi_entropy_1ab83acc57d483fa7f4717f01b74671050" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
        <type></type>
        <definition>forpy::RenyiEntropy::~RenyiEntropy</definition>
        <argsstring>()</argsstring>
        <name>~RenyiEntropy</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/Users/classner/git/forpy/include/forpy/impurities/renyientropy.h" line="37" column="1" bodyfile="/Users/classner/git/forpy/include/forpy/impurities/renyientropy.h" bodystart="37" bodyend="37"/>
      </memberdef>
      <memberdef kind="function" id="classforpy_1_1_renyi_entropy_1ad4c96374febb4af75a8178fadfa80e2c" prot="public" static="no" const="yes" explicit="no" inline="yes" virt="virtual">
        <type>float</type>
        <definition>virtual float forpy::RenyiEntropy::operator()</definition>
        <argsstring>(const float *class_members_numbers, const size_t &amp;n, const float &amp;fsum) const</argsstring>
        <name>operator()</name>
        <reimplements refid="classforpy_1_1_i_entropy_function_1a5ce363a6a07f37355cafe18cc946745b">operator()</reimplements>
        <param>
          <type>const float *</type>
          <declname>class_members_numbers</declname>
        </param>
        <param>
          <type>const size_t &amp;</type>
          <declname>n</declname>
        </param>
        <param>
          <type>const float &amp;</type>
          <declname>fsum</declname>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/Users/classner/git/forpy/include/forpy/impurities/renyientropy.h" line="39" column="1" bodyfile="/Users/classner/git/forpy/include/forpy/impurities/renyientropy.h" bodystart="39" bodyend="74"/>
      </memberdef>
      <memberdef kind="function" id="classforpy_1_1_renyi_entropy_1add765381c1128b2288f42d4e4117e8fa" prot="public" static="no" const="yes" explicit="no" inline="no" virt="virtual">
        <type>bool</type>
        <definition>bool forpy::RenyiEntropy::operator==</definition>
        <argsstring>(const IEntropyFunction &amp;rhs) const</argsstring>
        <name>operator==</name>
        <reimplements refid="classforpy_1_1_i_entropy_function_1a97e275c34b5a0df4d9293755563bad12">operator==</reimplements>
        <param>
          <type>const <ref refid="classforpy_1_1_i_entropy_function" kindref="compound">IEntropyFunction</ref> &amp;</type>
          <declname>rhs</declname>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>Deep equality comparison. </para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/Users/classner/git/forpy/include/forpy/impurities/renyientropy.h" line="81" column="1"/>
      </memberdef>
      <memberdef kind="function" id="classforpy_1_1_renyi_entropy_1abfdf05c835f395f882134f4854a17f63" prot="public" static="no" const="yes" explicit="no" inline="no" virt="non-virtual">
        <type>float</type>
        <definition>float forpy::RenyiEntropy::get_alpha</definition>
        <argsstring>() const</argsstring>
        <name>get_alpha</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>Returns the alpha value set in the constructor. </para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/Users/classner/git/forpy/include/forpy/impurities/renyientropy.h" line="84" column="1"/>
      </memberdef>
      </sectiondef>
      <sectiondef kind="private-func">
      <memberdef kind="function" id="classforpy_1_1_renyi_entropy_1a8b6aaf24605f1a3ac46c2b8601eae583" prot="private" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
        <type></type>
        <definition>forpy::RenyiEntropy::RenyiEntropy</definition>
        <argsstring>()</argsstring>
        <name>RenyiEntropy</name>
        <briefdescription>
<para>DON&apos;T USE. Non-initializing constructor for serialization purposes. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/Users/classner/git/forpy/include/forpy/impurities/renyientropy.h" line="89" column="1" bodyfile="/Users/classner/git/forpy/include/forpy/impurities/renyientropy.h" bodystart="89" bodyend="89"/>
      </memberdef>
      <memberdef kind="function" id="classforpy_1_1_renyi_entropy_1a742ad3779d726cf7999d3637f7207172" prot="private" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
        <templateparamlist>
          <param>
            <type>class Archive</type>
          </param>
        </templateparamlist>
        <type>void</type>
        <definition>void forpy::RenyiEntropy::serialize</definition>
        <argsstring>(Archive &amp;ar, const uint &amp;)</argsstring>
        <name>serialize</name>
        <param>
          <type>Archive &amp;</type>
          <declname>ar</declname>
        </param>
        <param>
          <type>const <ref refid="namespaceforpy_1ad05e34c62859518b61b76b5085e913d8" kindref="member">uint</ref> &amp;</type>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/Users/classner/git/forpy/include/forpy/impurities/renyientropy.h" line="93" column="1" bodyfile="/Users/classner/git/forpy/include/forpy/impurities/renyientropy.h" bodystart="93" bodyend="97"/>
      </memberdef>
      <memberdef kind="function" id="classforpy_1_1_renyi_entropy_1a68af460eda21fef13f4f65c8173333c3" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type></type>
        <definition>forpy::RenyiEntropy::DISALLOW_COPY_AND_ASSIGN</definition>
        <argsstring>(RenyiEntropy)</argsstring>
        <name>DISALLOW_COPY_AND_ASSIGN</name>
        <param>
          <type><ref refid="classforpy_1_1_renyi_entropy" kindref="compound">RenyiEntropy</ref></type>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/Users/classner/git/forpy/include/forpy/impurities/renyientropy.h" line="103" column="1"/>
      </memberdef>
      </sectiondef>
    <briefdescription>
<para>Computes the Renyi entropy. </para>    </briefdescription>
    <detaileddescription>
<para>Works correctly up to a total sum of elements of numeric_limits&lt;float&gt;::max().</para><para>This is the Renyi entropy, as introduced by Alfred Renyi (see <ulink url="http://en.wikipedia.org/wiki/R%C3%A9nyi_entropy">http://en.wikipedia.org/wiki/R%C3%A9nyi_entropy</ulink>). </para>    </detaileddescription>
    <inheritancegraph>
      <node id="179">
        <label>forpy::IEntropyFunction</label>
        <link refid="classforpy_1_1_i_entropy_function"/>
      </node>
      <node id="178">
        <label>forpy::RenyiEntropy</label>
        <link refid="classforpy_1_1_renyi_entropy"/>
        <childnode refid="179" relation="public-inheritance">
        </childnode>
      </node>
    </inheritancegraph>
    <collaborationgraph>
      <node id="185">
        <label>forpy::ClassificationError</label>
        <link refid="classforpy_1_1_classification_error"/>
        <childnode refid="181" relation="public-inheritance">
        </childnode>
      </node>
      <node id="187">
        <label>forpy::ShannonEntropy</label>
        <link refid="classforpy_1_1_shannon_entropy"/>
        <childnode refid="181" relation="public-inheritance">
        </childnode>
      </node>
      <node id="182">
        <label>std::unique_ptr&lt; forpy::InducedEntropy &gt;</label>
        <childnode refid="183" relation="usage">
          <edgelabel>ptr</edgelabel>
        </childnode>
      </node>
      <node id="181">
        <label>forpy::IEntropyFunction</label>
        <link refid="classforpy_1_1_i_entropy_function"/>
      </node>
      <node id="180">
        <label>forpy::RenyiEntropy</label>
        <link refid="classforpy_1_1_renyi_entropy"/>
        <childnode refid="181" relation="public-inheritance">
        </childnode>
        <childnode refid="182" relation="usage">
          <edgelabel>induced_p</edgelabel>
        </childnode>
        <childnode refid="184" relation="usage">
          <edgelabel>classification_error</edgelabel>
        </childnode>
        <childnode refid="186" relation="usage">
          <edgelabel>shannon_entropy</edgelabel>
        </childnode>
      </node>
      <node id="183">
        <label>forpy::InducedEntropy</label>
        <link refid="classforpy_1_1_induced_entropy"/>
        <childnode refid="181" relation="public-inheritance">
        </childnode>
      </node>
      <node id="184">
        <label>std::unique_ptr&lt; forpy::ClassificationError &gt;</label>
        <childnode refid="185" relation="usage">
          <edgelabel>ptr</edgelabel>
        </childnode>
      </node>
      <node id="186">
        <label>std::unique_ptr&lt; forpy::ShannonEntropy &gt;</label>
        <childnode refid="187" relation="usage">
          <edgelabel>ptr</edgelabel>
        </childnode>
      </node>
    </collaborationgraph>
    <location file="/Users/classner/git/forpy/include/forpy/impurities/renyientropy.h" line="34" column="1" bodyfile="/Users/classner/git/forpy/include/forpy/impurities/renyientropy.h" bodystart="34" bodyend="104"/>
    <listofallmembers>
      <member refid="classforpy_1_1_renyi_entropy_1ab2f44cbb59a08132f4c843e5225bba0e" prot="public" virt="non-virtual"><scope>forpy::RenyiEntropy</scope><name>cereal::access</name></member>
      <member refid="classforpy_1_1_renyi_entropy_1a6434f0324833aa756d03baa88667b80d" prot="private" virt="non-virtual"><scope>forpy::RenyiEntropy</scope><name>classification_error</name></member>
      <member refid="classforpy_1_1_renyi_entropy_1a68af460eda21fef13f4f65c8173333c3" prot="private" virt="non-virtual"><scope>forpy::RenyiEntropy</scope><name>DISALLOW_COPY_AND_ASSIGN</name></member>
      <member refid="classforpy_1_1_renyi_entropy_1abfdf05c835f395f882134f4854a17f63" prot="public" virt="non-virtual"><scope>forpy::RenyiEntropy</scope><name>get_alpha</name></member>
      <member refid="classforpy_1_1_i_entropy_function_1a70fe1569ee2a5cab7c0b155631a4dea9" prot="protected" virt="non-virtual"><scope>forpy::RenyiEntropy</scope><name>IEntropyFunction</name></member>
      <member refid="classforpy_1_1_renyi_entropy_1a0584da34af0c36c89f41bff92255fb63" prot="private" virt="non-virtual"><scope>forpy::RenyiEntropy</scope><name>induced_p</name></member>
      <member refid="classforpy_1_1_renyi_entropy_1ad4c96374febb4af75a8178fadfa80e2c" prot="public" virt="virtual"><scope>forpy::RenyiEntropy</scope><name>operator()</name></member>
      <member refid="classforpy_1_1_i_entropy_function_1a993c16c7cf4f90b21dcd10bc4c29d01a" prot="public" virt="virtual" ambiguityscope="forpy::IEntropyFunction::"><scope>forpy::RenyiEntropy</scope><name>operator()</name></member>
      <member refid="classforpy_1_1_i_entropy_function_1a2f12be4c28fe3ea10e85ff0f62d8ed91" prot="public" virt="virtual" ambiguityscope="forpy::IEntropyFunction::"><scope>forpy::RenyiEntropy</scope><name>operator()</name></member>
      <member refid="classforpy_1_1_renyi_entropy_1a6cd19bf8dab0a8ada1bcb1ab6a183b6e" prot="public" virt="non-virtual"><scope>forpy::RenyiEntropy</scope><name>operator&lt;&lt;</name></member>
      <member refid="classforpy_1_1_renyi_entropy_1add765381c1128b2288f42d4e4117e8fa" prot="public" virt="virtual"><scope>forpy::RenyiEntropy</scope><name>operator==</name></member>
      <member refid="classforpy_1_1_renyi_entropy_1a5d7ea08cb3ac0638fc4140dd9a515a37" prot="private" virt="non-virtual"><scope>forpy::RenyiEntropy</scope><name>q</name></member>
      <member refid="classforpy_1_1_renyi_entropy_1ae6460c899b7935d0c0ac68fe3c4f085d" prot="public" virt="non-virtual"><scope>forpy::RenyiEntropy</scope><name>RenyiEntropy</name></member>
      <member refid="classforpy_1_1_renyi_entropy_1a8b6aaf24605f1a3ac46c2b8601eae583" prot="private" virt="non-virtual"><scope>forpy::RenyiEntropy</scope><name>RenyiEntropy</name></member>
      <member refid="classforpy_1_1_renyi_entropy_1a742ad3779d726cf7999d3637f7207172" prot="private" virt="non-virtual"><scope>forpy::RenyiEntropy</scope><name>serialize</name></member>
      <member refid="classforpy_1_1_renyi_entropy_1a95126d5f1adcfe98440a6810c1719b98" prot="private" virt="non-virtual"><scope>forpy::RenyiEntropy</scope><name>shannon_entropy</name></member>
      <member refid="classforpy_1_1_i_entropy_function_1a763fc026d02d50934931e690761beecf" prot="public" virt="virtual"><scope>forpy::RenyiEntropy</scope><name>~IEntropyFunction</name></member>
      <member refid="classforpy_1_1_renyi_entropy_1ab83acc57d483fa7f4717f01b74671050" prot="public" virt="non-virtual"><scope>forpy::RenyiEntropy</scope><name>~RenyiEntropy</name></member>
    </listofallmembers>
  </compounddef>
</doxygen>
