CDPL::Descr::TanimotoSimilarity Class Reference

Functor class for calculating Tanimoto Similarities [CITB] of bitsets and vectors. More...

#include <SimilarityFunctors.hpp>

Public Member Functions
double	operator() (const Util::BitSet &bs1, const Util::BitSet &bs2) const
	Calculates the Tanimoto Similarity of the bitsets bs1 and bs2. More...
template<typename V >
double	operator() (const V &v1, const V &v2) const
	Calculates the Tanimoto Similarity of the vectors v1 and v2. More...

Detailed Description

Functor class for calculating Tanimoto Similarities [CITB] of bitsets and vectors.

Member Function Documentation

operator()() [1/2]

double CDPL::Descr::TanimotoSimilarity::operator() ( const Util::BitSet &  bs1, const Util::BitSet &  bs2  ) const

inline

Calculates the Tanimoto Similarity of the bitsets bs1 and bs2.

The Tanimoto Similarity \( S_{ab} \) is calculated by:

\[ S_{ab} = \frac{N_{ab}}{N_a + N_b - N_{ab}} \]

where \( N_{ab} \) is the number of bits that are set in both bitsets, \( N_a \) is the number of bits that are set in the first bitset and \( N_b \) is the number of bits that are set in the second bitset.

If the specified bitsets bs1 and bs2 are of different size, missing bits at the end of the smaller bitset are assumed to be zero.

Parameters

bs1	The first bitset.
bs2	The second bitset.

Returns

The calculated similarity measure.

operator()() [2/2]

template<typename V >

double CDPL::Descr::TanimotoSimilarity::operator() ( const V &  v1, const V &  v2  ) const

inline

Calculates the Tanimoto Similarity of the vectors v1 and v2.

The Tanimoto Similarity \( S_{12} \) is calculated by:

\[ S_{12} = \frac{\vec{v}_1 \cdot \vec{v}_2}{{\left \| \vec{v}_1 \right \|}^2 + {\left \| \vec{v}_2 \right \|}^2 - \vec{v}_1 \cdot \vec{v}_2} \]

Parameters

v1	The first vector.
v2	The second vector.

Returns

The calculated similarity measure.

---

The documentation for this class was generated from the following file:

• SimilarityFunctors.hpp