pub_soft/rdkit
3
0
Fork 0
mirror of https://github.com/rdkit/rdkit.git synced 2026-06-03 21:44:30 +08:00
Code Issues Packages Projects Releases Wiki Activity

Docs: fix CosineSimilarity formula and clarify similarity metric names in BitOps.h (#9264)

Browse Source 
* Fix CosineSimilarity doc formula and clarify similarity metric names in BitOps.h

* Fix CosineSimilarity formula in BitOps.h and adjust similarity docs
This commit is contained in:
reza bagheri alashti
2026-05-06 18:42:53 +03:30
committed by GitHub
parent 67fc0708e5
commit bd73a574ad
1 changed files with 8 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
Code/DataStructs/BitOps.h
View File

@@ -105,7 +105,8 @@ RDKIT_DATASTRUCTS_EXPORT double TanimotoSimilarity(const T1 &bv1,
//! returns the Cosine similarity between two bit vects
/*!
\return <tt>(bv1&bv2)_o / sqrt(bv1_o + bv2_o)</tt>
Also known as the Ochiai coefficient.
\return <tt>(bv1&bv2)_o / sqrt(bv1_o * bv2_o)</tt>
*/
template <typename T1, typename T2>
RDKIT_DATASTRUCTS_EXPORT double CosineSimilarity(const T1 &bv1, const T2 &bv2);
@@ -157,6 +158,7 @@ RDKIT_DATASTRUCTS_EXPORT double McConnaugheySimilarity(const T1 &bv1,
//! returns the Asymmetric similarity between two bit vects
/*!
Also known as the **Simpson similarity** or **Overlap coefficient**.
\return <tt>(bv1&bv2)_o / min(bv1_o,bv2_o)</tt>
*/
template <typename T1, typename T2>
@@ -209,8 +211,12 @@ RDKIT_DATASTRUCTS_EXPORT int NumBitsInCommon(const ExplicitBitVect &bv1,
const ExplicitBitVect &bv2);
//! returns the common-bit similarity (on and off) between two bit vects
//! This is also called Manhattan similarity.
/*!
Also known as:
- **Simple Matching Coefficient**
- **Rand similarity**
- **Sokal–Michener similarity**
\return <tt>[bv1_n - (bv1^bv2)_o] / bv1_n</tt>
*/
template <typename T1, typename T2>