<?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_tsallis_entropy" kind="class" language="C++" prot="public">
    <compoundname>forpy::TsallisEntropy</compoundname>
    <basecompoundref refid="classforpy_1_1_i_entropy_function" prot="public" virt="non-virtual">forpy::IEntropyFunction</basecompoundref>
    <includes refid="tsallisentropy_8h" local="no">tsallisentropy.h</includes>
      <sectiondef kind="friend">
      <memberdef kind="friend" id="classforpy_1_1_tsallis_entropy_1aa21bd6134d88bb8583baa62a16a94559" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>friend class</type>
        <definition>friend class InducedEntropy</definition>
        <argsstring></argsstring>
        <name>InducedEntropy</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/Users/classner/git/forpy/include/forpy/impurities/tsallisentropy.h" line="78" column="1" bodyfile="/Users/classner/git/forpy/include/forpy/impurities/tsallisentropy.h" bodystart="78" bodyend="-1"/>
      </memberdef>
      <memberdef kind="friend" id="classforpy_1_1_tsallis_entropy_1a9ac4b5594783ae8e09932d026d368dd5" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>friend class</type>
        <definition>friend class ShannonEntropy</definition>
        <argsstring></argsstring>
        <name>ShannonEntropy</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/Users/classner/git/forpy/include/forpy/impurities/tsallisentropy.h" line="79" column="1" bodyfile="/Users/classner/git/forpy/include/forpy/impurities/tsallisentropy.h" bodystart="79" bodyend="-1"/>
      </memberdef>
      <memberdef kind="friend" id="classforpy_1_1_tsallis_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/tsallisentropy.h" line="89" column="1" bodyfile="/Users/classner/git/forpy/include/forpy/impurities/tsallisentropy.h" bodystart="89" bodyend="-1"/>
      </memberdef>
      <memberdef kind="friend" id="classforpy_1_1_tsallis_entropy_1ae38d12997dd728b460205b554421f01a" 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 TsallisEntropy &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_tsallis_entropy" kindref="compound">TsallisEntropy</ref> &amp;</type>
          <declname>self</declname>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/Users/classner/git/forpy/include/forpy/impurities/tsallisentropy.h" line="69" column="1" bodyfile="/Users/classner/git/forpy/include/forpy/impurities/tsallisentropy.h" bodystart="69" bodyend="73"/>
      </memberdef>
      </sectiondef>
      <sectiondef kind="private-attrib">
      <memberdef kind="variable" id="classforpy_1_1_tsallis_entropy_1a9add5681dec810a1fa91f6ebe496d1a0" prot="private" static="no" mutable="no">
        <type>float</type>
        <definition>float forpy::TsallisEntropy::q</definition>
        <argsstring></argsstring>
        <name>q</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/Users/classner/git/forpy/include/forpy/impurities/tsallisentropy.h" line="96" column="1" bodyfile="/Users/classner/git/forpy/include/forpy/impurities/tsallisentropy.h" bodystart="94" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="classforpy_1_1_tsallis_entropy_1a3ee73f969cb198c57c516e76bd23afe1" 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::TsallisEntropy::shannon_entropy</definition>
        <argsstring></argsstring>
        <name>shannon_entropy</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/Users/classner/git/forpy/include/forpy/impurities/tsallisentropy.h" line="97" column="1" bodyfile="/Users/classner/git/forpy/include/forpy/impurities/tsallisentropy.h" bodystart="97" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="classforpy_1_1_tsallis_entropy_1a9f5f76c79c2f808979e8d158926f31de" 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::TsallisEntropy::induced_p</definition>
        <argsstring></argsstring>
        <name>induced_p</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/Users/classner/git/forpy/include/forpy/impurities/tsallisentropy.h" line="98" column="1" bodyfile="/Users/classner/git/forpy/include/forpy/impurities/tsallisentropy.h" bodystart="98" bodyend="-1"/>
      </memberdef>
      </sectiondef>
      <sectiondef kind="public-func">
      <memberdef kind="function" id="classforpy_1_1_tsallis_entropy_1a066a246207b350fa16c0ba099309670d" prot="public" static="no" const="no" explicit="yes" inline="no" virt="non-virtual">
        <type></type>
        <definition>forpy::TsallisEntropy::TsallisEntropy</definition>
        <argsstring>(const float &amp;q)</argsstring>
        <name>TsallisEntropy</name>
        <param>
          <type>const float &amp;</type>
          <declname>q</declname>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>q</parametername>
</parameternamelist>
<parameterdescription>
<para>float&gt;0.f The entropy parameter. </para></parameterdescription>
</parameteritem>
</parameterlist>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/Users/classner/git/forpy/include/forpy/impurities/tsallisentropy.h" line="38" column="1"/>
      </memberdef>
      <memberdef kind="function" id="classforpy_1_1_tsallis_entropy_1a73010447f4b407c0d4779c367448cf86" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type></type>
        <definition>forpy::TsallisEntropy::~TsallisEntropy</definition>
        <argsstring>()</argsstring>
        <name>~TsallisEntropy</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/Users/classner/git/forpy/include/forpy/impurities/tsallisentropy.h" line="39" column="1"/>
      </memberdef>
      <memberdef kind="function" id="classforpy_1_1_tsallis_entropy_1a166675686252188d14e9e3efadc0bf25" prot="public" static="no" const="yes" explicit="no" inline="yes" virt="virtual">
        <type>float</type>
        <definition>float forpy::TsallisEntropy::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/tsallisentropy.h" line="41" column="1" bodyfile="/Users/classner/git/forpy/include/forpy/impurities/tsallisentropy.h" bodystart="41" bodyend="67"/>
      </memberdef>
      <memberdef kind="function" id="classforpy_1_1_tsallis_entropy_1a8ae1562b65bea792d6669a93e83c9b2a" prot="public" static="no" const="yes" explicit="no" inline="no" virt="virtual">
        <type>bool</type>
        <definition>bool forpy::TsallisEntropy::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/tsallisentropy.h" line="74" column="1"/>
      </memberdef>
      <memberdef kind="function" id="classforpy_1_1_tsallis_entropy_1ae9fe39e7da188e8df091a8634dc0a2b8" prot="public" static="no" const="yes" explicit="no" inline="no" virt="non-virtual">
        <type>float</type>
        <definition>float forpy::TsallisEntropy::get_q</definition>
        <argsstring>() const</argsstring>
        <name>get_q</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>Returns q as set in the constructor. </para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/Users/classner/git/forpy/include/forpy/impurities/tsallisentropy.h" line="77" column="1"/>
      </memberdef>
      </sectiondef>
      <sectiondef kind="private-func">
      <memberdef kind="function" id="classforpy_1_1_tsallis_entropy_1ac4869a51496a415f73286bf9c7cee043" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type></type>
        <definition>forpy::TsallisEntropy::TsallisEntropy</definition>
        <argsstring>()</argsstring>
        <name>TsallisEntropy</name>
        <briefdescription>
<para>DON&apos;T USE. Non-initializing constructor for serialization purposes. </para>        </briefdescription>
        <detaileddescription>
<para>It is currently used by the Shannon entropy to break a dependency circle. </para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/Users/classner/git/forpy/include/forpy/impurities/tsallisentropy.h" line="87" column="1"/>
      </memberdef>
      <memberdef kind="function" id="classforpy_1_1_tsallis_entropy_1a702837b820416116b13c8effabf5a432" 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::TsallisEntropy::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/tsallisentropy.h" line="91" column="1" bodyfile="/Users/classner/git/forpy/include/forpy/impurities/tsallisentropy.h" bodystart="91" bodyend="94"/>
      </memberdef>
      <memberdef kind="function" id="classforpy_1_1_tsallis_entropy_1ae4507830bc51cf853c6fce396bdc8155" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type></type>
        <definition>forpy::TsallisEntropy::DISALLOW_COPY_AND_ASSIGN</definition>
        <argsstring>(TsallisEntropy)</argsstring>
        <name>DISALLOW_COPY_AND_ASSIGN</name>
        <param>
          <type><ref refid="classforpy_1_1_tsallis_entropy" kindref="compound">TsallisEntropy</ref></type>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/Users/classner/git/forpy/include/forpy/impurities/tsallisentropy.h" line="99" column="1"/>
      </memberdef>
      </sectiondef>
    <briefdescription>
<para>Computes the Tsallis 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 Tsallis entropy, as introduced by Constantino Tsallis (see <ulink url="http://en.wikipedia.org/wiki/Tsallis_entropy">http://en.wikipedia.org/wiki/Tsallis_entropy</ulink>). </para>    </detaileddescription>
    <inheritancegraph>
      <node id="230">
        <label>forpy::IEntropyFunction</label>
        <link refid="classforpy_1_1_i_entropy_function"/>
      </node>
      <node id="229">
        <label>forpy::TsallisEntropy</label>
        <link refid="classforpy_1_1_tsallis_entropy"/>
        <childnode refid="230" relation="public-inheritance">
        </childnode>
      </node>
    </inheritancegraph>
    <collaborationgraph>
      <node id="236">
        <label>forpy::ShannonEntropy</label>
        <link refid="classforpy_1_1_shannon_entropy"/>
        <childnode refid="232" relation="public-inheritance">
        </childnode>
      </node>
      <node id="233">
        <label>std::unique_ptr&lt; forpy::InducedEntropy &gt;</label>
        <childnode refid="234" relation="usage">
          <edgelabel>ptr</edgelabel>
        </childnode>
      </node>
      <node id="232">
        <label>forpy::IEntropyFunction</label>
        <link refid="classforpy_1_1_i_entropy_function"/>
      </node>
      <node id="234">
        <label>forpy::InducedEntropy</label>
        <link refid="classforpy_1_1_induced_entropy"/>
        <childnode refid="232" relation="public-inheritance">
        </childnode>
      </node>
      <node id="235">
        <label>std::unique_ptr&lt; forpy::ShannonEntropy &gt;</label>
        <childnode refid="236" relation="usage">
          <edgelabel>ptr</edgelabel>
        </childnode>
      </node>
      <node id="231">
        <label>forpy::TsallisEntropy</label>
        <link refid="classforpy_1_1_tsallis_entropy"/>
        <childnode refid="232" relation="public-inheritance">
        </childnode>
        <childnode refid="233" relation="usage">
          <edgelabel>induced_p</edgelabel>
        </childnode>
        <childnode refid="235" relation="usage">
          <edgelabel>shannon_entropy</edgelabel>
        </childnode>
      </node>
    </collaborationgraph>
    <location file="/Users/classner/git/forpy/include/forpy/impurities/tsallisentropy.h" line="32" column="1" bodyfile="/Users/classner/git/forpy/include/forpy/impurities/tsallisentropy.h" bodystart="32" bodyend="100"/>
    <listofallmembers>
      <member refid="classforpy_1_1_tsallis_entropy_1ab2f44cbb59a08132f4c843e5225bba0e" prot="public" virt="non-virtual"><scope>forpy::TsallisEntropy</scope><name>cereal::access</name></member>
      <member refid="classforpy_1_1_tsallis_entropy_1ae4507830bc51cf853c6fce396bdc8155" prot="private" virt="non-virtual"><scope>forpy::TsallisEntropy</scope><name>DISALLOW_COPY_AND_ASSIGN</name></member>
      <member refid="classforpy_1_1_tsallis_entropy_1ae9fe39e7da188e8df091a8634dc0a2b8" prot="public" virt="non-virtual"><scope>forpy::TsallisEntropy</scope><name>get_q</name></member>
      <member refid="classforpy_1_1_i_entropy_function_1a70fe1569ee2a5cab7c0b155631a4dea9" prot="protected" virt="non-virtual"><scope>forpy::TsallisEntropy</scope><name>IEntropyFunction</name></member>
      <member refid="classforpy_1_1_tsallis_entropy_1a9f5f76c79c2f808979e8d158926f31de" prot="private" virt="non-virtual"><scope>forpy::TsallisEntropy</scope><name>induced_p</name></member>
      <member refid="classforpy_1_1_tsallis_entropy_1aa21bd6134d88bb8583baa62a16a94559" prot="public" virt="non-virtual"><scope>forpy::TsallisEntropy</scope><name>InducedEntropy</name></member>
      <member refid="classforpy_1_1_tsallis_entropy_1a166675686252188d14e9e3efadc0bf25" prot="public" virt="virtual"><scope>forpy::TsallisEntropy</scope><name>operator()</name></member>
      <member refid="classforpy_1_1_i_entropy_function_1a993c16c7cf4f90b21dcd10bc4c29d01a" prot="public" virt="virtual" ambiguityscope="forpy::IEntropyFunction::"><scope>forpy::TsallisEntropy</scope><name>operator()</name></member>
      <member refid="classforpy_1_1_i_entropy_function_1a2f12be4c28fe3ea10e85ff0f62d8ed91" prot="public" virt="virtual" ambiguityscope="forpy::IEntropyFunction::"><scope>forpy::TsallisEntropy</scope><name>operator()</name></member>
      <member refid="classforpy_1_1_tsallis_entropy_1ae38d12997dd728b460205b554421f01a" prot="public" virt="non-virtual"><scope>forpy::TsallisEntropy</scope><name>operator&lt;&lt;</name></member>
      <member refid="classforpy_1_1_tsallis_entropy_1a8ae1562b65bea792d6669a93e83c9b2a" prot="public" virt="virtual"><scope>forpy::TsallisEntropy</scope><name>operator==</name></member>
      <member refid="classforpy_1_1_tsallis_entropy_1a9add5681dec810a1fa91f6ebe496d1a0" prot="private" virt="non-virtual"><scope>forpy::TsallisEntropy</scope><name>q</name></member>
      <member refid="classforpy_1_1_tsallis_entropy_1a702837b820416116b13c8effabf5a432" prot="private" virt="non-virtual"><scope>forpy::TsallisEntropy</scope><name>serialize</name></member>
      <member refid="classforpy_1_1_tsallis_entropy_1a3ee73f969cb198c57c516e76bd23afe1" prot="private" virt="non-virtual"><scope>forpy::TsallisEntropy</scope><name>shannon_entropy</name></member>
      <member refid="classforpy_1_1_tsallis_entropy_1a9ac4b5594783ae8e09932d026d368dd5" prot="public" virt="non-virtual"><scope>forpy::TsallisEntropy</scope><name>ShannonEntropy</name></member>
      <member refid="classforpy_1_1_tsallis_entropy_1a066a246207b350fa16c0ba099309670d" prot="public" virt="non-virtual"><scope>forpy::TsallisEntropy</scope><name>TsallisEntropy</name></member>
      <member refid="classforpy_1_1_tsallis_entropy_1ac4869a51496a415f73286bf9c7cee043" prot="private" virt="non-virtual"><scope>forpy::TsallisEntropy</scope><name>TsallisEntropy</name></member>
      <member refid="classforpy_1_1_i_entropy_function_1a763fc026d02d50934931e690761beecf" prot="public" virt="virtual"><scope>forpy::TsallisEntropy</scope><name>~IEntropyFunction</name></member>
      <member refid="classforpy_1_1_tsallis_entropy_1a73010447f4b407c0d4779c367448cf86" prot="public" virt="non-virtual"><scope>forpy::TsallisEntropy</scope><name>~TsallisEntropy</name></member>
    </listofallmembers>
  </compounddef>
</doxygen>
