Chemical Data Processing Library C++ API - Version 1.4.0
ScoringFunctions.hpp
Go to the documentation of this file.
1 /*
2  * ScoringFunctions.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_SHAPE_SCORINGFUNCTIONS_HPP
30 #define CDPL_SHAPE_SCORINGFUNCTIONS_HPP
31 
32 #include "CDPL/Shape/APIPrefix.hpp"
33 
34 
35 namespace CDPL
36 {
37 
38  namespace Shape
39  {
40 
41  class AlignmentResult;
42 
49 
56 
63 
70 
71 
79  CDPL_SHAPE_API double calcTotalOverlapTverskyScore(const AlignmentResult& res, double alpha = 0.95, double beta = 0.05);
80 
88  CDPL_SHAPE_API double calcShapeTverskyScore(const AlignmentResult& res, double alpha = 0.95, double beta = 0.05);
89 
97  CDPL_SHAPE_API double calcColorTverskyScore(const AlignmentResult& res, double alpha = 0.95, double beta = 0.05);
98 
106  CDPL_SHAPE_API double calcTverskyComboScore(const AlignmentResult& res, double alpha = 0.95, double beta = 0.05);
107 
108 
116 
123  CDPL_SHAPE_API double calcReferenceShapeTverskyScore(const AlignmentResult& res, double alpha = 0.95);
124 
131  CDPL_SHAPE_API double calcReferenceColorTverskyScore(const AlignmentResult& res, double alpha = 0.95);
132 
139  CDPL_SHAPE_API double calcReferenceTverskyComboScore(const AlignmentResult& res, double alpha = 0.95);
140 
141 
149 
156  CDPL_SHAPE_API double calcAlignedShapeTverskyScore(const AlignmentResult& res, double beta = 0.95);
157 
164  CDPL_SHAPE_API double calcAlignedColorTverskyScore(const AlignmentResult& res, double beta = 0.95);
165 
172  CDPL_SHAPE_API double calcAlignedTverskyComboScore(const AlignmentResult& res, double beta = 0.95);
173  } // namespace Shape
174 } // namespace CDPL
175 
176 #endif // CDPL_SHAPE_SCORINGFUNCTIONS_HPP
Definition of the preprocessor macro CDPL_SHAPE_API.
#define CDPL_SHAPE_API
Tells the compiler/linker which classes, functions and variables are part of the library API.
Result of a Gaussian-shape alignment between a reference and an aligned shape.
Definition: AlignmentResult.hpp:52
CDPL_SHAPE_API double calcColorTverskyScore(const AlignmentResult &res, double alpha=0.95, double beta=0.05)
Returns the color (pharmacophore) symmetric Tversky similarity score of res.
CDPL_SHAPE_API double calcShapeTverskyScore(const AlignmentResult &res, double alpha=0.95, double beta=0.05)
Returns the shape-only symmetric Tversky similarity score of res.
CDPL_SHAPE_API double calcReferenceTverskyComboScore(const AlignmentResult &res, double alpha=0.95)
Returns the combined shape + color reference-normalized Tversky score of res.
CDPL_SHAPE_API double calcAlignedTverskyComboScore(const AlignmentResult &res, double beta=0.95)
Returns the combined shape + color aligned-normalized Tversky score of res.
CDPL_SHAPE_API double calcTotalOverlapTverskyScore(const AlignmentResult &res, double alpha=0.95, double beta=0.05)
Returns the (shape + color) total-overlap symmetric Tversky similarity score of res.
CDPL_SHAPE_API double calcAlignedShapeTverskyScore(const AlignmentResult &res, double beta=0.95)
Returns the shape-only aligned-normalized Tversky similarity score of res.
CDPL_SHAPE_API double calcShapeTanimotoScore(const AlignmentResult &res)
Returns the shape-only Tanimoto similarity score of res.
CDPL_SHAPE_API double calcAlignedTotalOverlapTverskyScore(const AlignmentResult &res, double beta=0.95)
Returns the (shape + color) total-overlap aligned-normalized Tversky similarity score of res.
CDPL_SHAPE_API double calcReferenceTotalOverlapTverskyScore(const AlignmentResult &res, double alpha=0.95)
Returns the (shape + color) total-overlap reference-normalized Tversky similarity score of res.
CDPL_SHAPE_API double calcTotalOverlapTanimotoScore(const AlignmentResult &res)
Returns the (shape + color) total-overlap Tanimoto similarity score of res.
CDPL_SHAPE_API double calcTanimotoComboScore(const AlignmentResult &res)
Returns the combined shape + color Tanimoto score of res.
CDPL_SHAPE_API double calcReferenceColorTverskyScore(const AlignmentResult &res, double alpha=0.95)
Returns the color (pharmacophore) reference-normalized Tversky similarity score of res.
CDPL_SHAPE_API double calcColorTanimotoScore(const AlignmentResult &res)
Returns the color (pharmacophore) Tanimoto similarity score of res.
CDPL_SHAPE_API double calcReferenceShapeTverskyScore(const AlignmentResult &res, double alpha=0.95)
Returns the shape-only reference-normalized Tversky similarity score of res.
CDPL_SHAPE_API double calcAlignedColorTverskyScore(const AlignmentResult &res, double beta=0.95)
Returns the color (pharmacophore) aligned-normalized Tversky similarity score of res.
CDPL_SHAPE_API double calcTverskyComboScore(const AlignmentResult &res, double alpha=0.95, double beta=0.05)
Returns the combined shape + color symmetric Tversky score of res.
The namespace of the Chemical Data Processing Library.