Chemical Data Processing Library C++ API - Version 1.1.1
SimilarityFunctions.hpp
Go to the documentation of this file.
1 /*
2  * SimilarityFunctions.hpp
3  *
4  * This file is part of the Chemical Data Processing Toolkit
5  *
6  * Copyright (C) 2003 Thomas Seidel <thomas.seidel@univie.ac.at>
7  *
8  * This library is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Lesser General Public
10  * License as published by the Free Software Foundation; either
11  * version 2 of the License, or (at your option) any later version.
12  *
13  * This library is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16  * Lesser General Public License for more details.
17  *
18  * You should have received a copy of the GNU Lesser General Public License
19  * along with this library; see the file COPYING. If not, write to
20  * the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21  * Boston, MA 02111-1307, USA.
22  */
23 
29 #ifndef CDPL_DESCR_SIMILARITYFUNCTIONS_HPP
30 #define CDPL_DESCR_SIMILARITYFUNCTIONS_HPP
31 
32 #include <cstddef>
33 
34 #include "CDPL/Descr/APIPrefix.hpp"
35 #include "CDPL/Util/BitSet.hpp"
36 
37 
38 namespace CDPL
39 {
40 
41  namespace Descr
42  {
43 
64 
85 
107 
129 
150 
175  CDPL_DESCR_API double calcTverskySimilarity(const Util::BitSet& bs1, const Util::BitSet& bs2, double a, double b);
176 
196  CDPL_DESCR_API std::size_t calcHammingDistance(const Util::BitSet& bs1, const Util::BitSet& bs2);
197 
218  } // namespace Descr
219 } // namespace CDPL
220 
221 #endif // CDPL_DESCR_SIMILARITYFUNCTIONS_HPP
CDPL::Descr::calcCosineSimilarity
CDPL_DESCR_API double calcCosineSimilarity(const Util::BitSet &bs1, const Util::BitSet &bs2)
Calculates the Cosine Similarity Measure [WCOS] for the given bitsets bs1 and bs2.
CDPL::Descr::calcEuclideanDistance
CDPL_DESCR_API double calcEuclideanDistance(const Util::BitSet &bs1, const Util::BitSet &bs2)
Calculates the Euclidean Distance [CITB] between the bitsets bs1 and bs2.
CDPL::Descr::calcDiceSimilarity
CDPL_DESCR_API double calcDiceSimilarity(const Util::BitSet &bs1, const Util::BitSet &bs2)
Calculates the Dice Similarity Measure [GSIM] for the given bitsets bs1 and bs2.
CDPL::Util::BitSet
boost::dynamic_bitset BitSet
A dynamic bitset class.
Definition: BitSet.hpp:46
CDPL::Descr::calcTverskySimilarity
CDPL_DESCR_API double calcTverskySimilarity(const Util::BitSet &bs1, const Util::BitSet &bs2, double a, double b)
Calculates the Tversky Similarity Measure [GSIM] for the given bitsets bs1 and bs2.
BitSet.hpp
Definition of the type CDPL::Util::BitSet.
CDPL::Descr::calcHammingDistance
CDPL_DESCR_API std::size_t calcHammingDistance(const Util::BitSet &bs1, const Util::BitSet &bs2)
Calculates the Hamming Distance [WHAM, CITB] between the bitsets bs1 and bs2.
CDPL::Descr::calcEuclideanSimilarity
CDPL_DESCR_API double calcEuclideanSimilarity(const Util::BitSet &bs1, const Util::BitSet &bs2)
Calculates the Euclidean Similarity Measure [GSIM] for the given bitsets bs1 and bs2.
CDPL::Descr::calcManhattanSimilarity
CDPL_DESCR_API double calcManhattanSimilarity(const Util::BitSet &bs1, const Util::BitSet &bs2)
Calculates the Manhattan Similarity Measure [GSIM] for the given bitsets bs1 and bs2.
CDPL
The namespace of the Chemical Data Processing Library.
CDPL::Descr::calcTanimotoSimilarity
CDPL_DESCR_API double calcTanimotoSimilarity(const Util::BitSet &bs1, const Util::BitSet &bs2)
Calculates the Tanimoto Similarity Measure [CITB] for the given bitsets bs1 and bs2.
APIPrefix.hpp
Definition of the preprocessor macro CDPL_DESCR_API.
CDPL_DESCR_API
#define CDPL_DESCR_API
Tells the compiler/linker which classes, functions and variables are part of the library API.