Computes the Tsallis entropy.
More...
#include <tsallisentropy.h>
Computes the Tsallis entropy.
Works correctly up to a total sum of elements of numeric_limits<float>::max().
This is the Tsallis entropy, as introduced by Constantino Tsallis (see http://en.wikipedia.org/wiki/Tsallis_entropy).
Definition at line 32 of file tsallisentropy.h.
◆ TsallisEntropy() [1/2]
forpy::TsallisEntropy::TsallisEntropy |
( |
const float & |
q | ) |
|
|
explicit |
- Parameters
-
q | float>0.f The entropy parameter. |
◆ ~TsallisEntropy()
forpy::TsallisEntropy::~TsallisEntropy |
( |
| ) |
|
◆ TsallisEntropy() [2/2]
forpy::TsallisEntropy::TsallisEntropy |
( |
| ) |
|
|
private |
DON'T USE. Non-initializing constructor for serialization purposes.
It is currently used by the Shannon entropy to break a dependency circle.
◆ DISALLOW_COPY_AND_ASSIGN()
◆ get_q()
float forpy::TsallisEntropy::get_q |
( |
| ) |
const |
Returns q as set in the constructor.
◆ operator()()
float forpy::TsallisEntropy::operator() |
( |
const float * |
class_members_numbers, |
|
|
const size_t & |
n, |
|
|
const float & |
fsum |
|
) |
| const |
|
inlinevirtual |
◆ operator==()
◆ serialize()
template<class Archive >
void forpy::TsallisEntropy::serialize |
( |
Archive & |
ar, |
|
|
const uint & |
|
|
) |
| |
|
inlineprivate |
◆ cereal::access
friend class cereal::access |
|
friend |
◆ InducedEntropy
◆ operator<<
std::ostream& operator<< |
( |
std::ostream & |
stream, |
|
|
const TsallisEntropy & |
self |
|
) |
| |
|
friend |
◆ ShannonEntropy
◆ induced_p
float forpy::TsallisEntropy::q |
|
private |
◆ shannon_entropy
std::unique_ptr<ShannonEntropy> forpy::TsallisEntropy::shannon_entropy |
|
private |
The documentation for this class was generated from the following file: