1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371
|
//
// Copyright (C) 2003-2021 greg Landrum and other RDKit contributors
//
// @@ All Rights Reserved @@
// This file is part of the RDKit.
// The contents are covered by the terms of the BSD license
// which is included in the file license.txt, found at the root
// of the RDKit source tree.
//
#include <RDBoost/python.h>
#include <DataStructs/BitVects.h>
#include <DataStructs/BitOps.h>
namespace python = boost::python;
namespace {
template <typename T>
python::object BVToBinaryText(const T &bv) {
std::string res = BitVectToBinaryText(bv);
python::object retval = python::object(
python::handle<>(PyBytes_FromStringAndSize(res.c_str(), res.length())));
return retval;
}
} // namespace
template <typename T>
double SimilarityWrapper(const T &bv1, const std::string &pkl,
double (*metric)(const T &, const T &),
bool returnDistance) {
T bv2(pkl);
return SimilarityWrapper(bv1, bv2, metric, returnDistance);
}
template <typename T>
double SimilarityWrapper(const T &bv1, const std::string &pkl, double a,
double b,
double (*metric)(const T &, const T &, double, double),
bool returnDistance) {
T bv2(pkl);
return SimilarityWrapper(bv1, bv2, a, b, metric, returnDistance);
}
template <typename T>
python::list NeighborWrapper(python::object queries, python::object bvs,
double (*metric)(const T &, const T &)) {
python::list res;
unsigned int nbvs = python::extract<unsigned int>(bvs.attr("__len__")());
unsigned int nqs = python::extract<unsigned int>(queries.attr("__len__")());
for (unsigned int i = 0; i < nqs; ++i) {
const T *bv1 = python::extract<const T *>(queries[i])();
double closest = -1;
unsigned nbr;
for (unsigned int j = 0; j < nbvs; ++j) {
const T *bv2 = python::extract<const T *>(bvs[j])();
auto sim = metric(*bv1, *bv2);
if (sim > closest) {
closest = sim;
nbr = j;
}
}
res.append(python::make_tuple(nbr, closest));
}
return res;
}
template <typename T>
python::list BulkWrapper(const T *bv1, python::object bvs,
double (*metric)(const T &, const T &),
bool returnDistance) {
python::list res;
unsigned int nbvs = python::extract<unsigned int>(bvs.attr("__len__")());
for (unsigned int i = 0; i < nbvs; ++i) {
const T *bv2 = python::extract<const T *>(bvs[i])();
auto sim = metric(*bv1, *bv2);
if (returnDistance) {
sim = 1.0 - sim;
}
res.append(sim);
}
return res;
}
template <typename T>
python::list BulkWrapper(const T *bv1, python::object bvs, double a, double b,
double (*metric)(const T &, const T &, double, double),
bool returnDistance) {
python::list res;
unsigned int nbvs = python::extract<unsigned int>(bvs.attr("__len__")());
for (unsigned int i = 0; i < nbvs; ++i) {
const T *bv2 = python::extract<T *>(bvs[i])();
auto sim = metric(*bv1, *bv2, a, b);
if (returnDistance) {
sim = 1.0 - sim;
}
res.append(sim);
}
return res;
}
#define METRIC_DEFS(_metricname_) \
template <typename T1, typename T2> \
double _metricname_##_w(const T1 &bv1, const T2 &bv2, bool returnDistance) { \
return SimilarityWrapper(bv1, bv2, \
(double (*)(const T1 &, const T1 &))_metricname_, \
returnDistance); \
} \
template <typename T> \
python::list Bulk##_metricname_(const T *bv1, python::object bvs, \
bool returnDistance) { \
return BulkWrapper(bv1, bvs, \
(double (*)(const T &, const T &))_metricname_, \
returnDistance); \
} \
template <typename T> \
python::list _metricname_##Neighbors(python::object queries, \
python::object bvs) { \
return NeighborWrapper(queries, bvs, \
(double (*)(const T &, const T &))_metricname_); \
}
METRIC_DEFS(TanimotoSimilarity)
METRIC_DEFS(CosineSimilarity)
METRIC_DEFS(KulczynskiSimilarity)
METRIC_DEFS(DiceSimilarity)
METRIC_DEFS(SokalSimilarity)
METRIC_DEFS(McConnaugheySimilarity)
METRIC_DEFS(AsymmetricSimilarity)
METRIC_DEFS(BraunBlanquetSimilarity)
METRIC_DEFS(RusselSimilarity)
METRIC_DEFS(RogotGoldbergSimilarity)
METRIC_DEFS(OnBitSimilarity)
METRIC_DEFS(AllBitSimilarity)
template <typename T1, typename T2>
double TverskySimilarity_w(const T1 &bv1, const T2 &bv2, double a, double b,
bool returnDistance) {
return SimilarityWrapper(
bv1, bv2, a, b,
(double (*)(const T1 &, const T1 &, double, double))TverskySimilarity,
returnDistance);
}
template <typename T>
python::list BulkTverskySimilarity(const T *bv1, python::object bvs, double a,
double b, bool returnDistance) {
return BulkWrapper(
bv1, bvs, a, b,
(double (*)(const T &, const T &, double, double))TverskySimilarity,
returnDistance);
}
#define DBL_DEF(_funcname_, _bulkname_, _help_) \
{ \
python::def(#_funcname_, (double (*)(const SBV &, const SBV &))_funcname_, \
(python::args("v1"), python::args("v2"))); \
python::def(#_funcname_, (double (*)(const EBV &, const EBV &))_funcname_, \
(python::args("v1"), python::args("v2")), _help_); \
python::def( \
#_bulkname_, \
(python::list(*)(const EBV *, python::object, bool))_bulkname_, \
(python::args("v1"), python::args("v2"), \
python::args("returnDistance") = 0)); \
python::def( \
#_bulkname_, \
(python::list(*)(const EBV *, python::object, bool))_bulkname_, \
(python::args("v1"), python::args("v2"), \
python::args("returnDistance") = 0), \
_help_); \
}
#define BIG_DEF(_funcname_, _name_w_, _bulkname_, _help_) \
{ \
python::def(#_funcname_, \
(double (*)(const SBV &, const SBV &, bool))_name_w_, \
(python::args("bv1"), python::args("bv2"), \
python::args("returnDistance") = 0)); \
python::def(#_funcname_, \
(double (*)(const EBV &, const EBV &, bool))_name_w_, \
(python::args("bv1"), python::args("bv2"), \
python::args("returnDistance") = 0), \
_help_); \
python::def(#_funcname_, \
(double (*)(const SBV &, const std::string &, bool))_name_w_, \
(python::args("bv1"), python::args("pkl"), \
python::args("returnDistance") = 0)); \
python::def(#_funcname_, \
(double (*)(const EBV &, const std::string &, bool))_name_w_, \
(python::args("bv1"), python::args("pkl"), \
python::args("returnDistance") = 0), \
_help_); \
python::def( \
#_bulkname_, \
(python::list(*)(const SBV *, python::object, bool))_bulkname_, \
(python::args("bv1"), python::args("bvList"), \
python::args("returnDistance") = 0)); \
python::def( \
#_bulkname_, \
(python::list(*)(const EBV *, python::object, bool))_bulkname_, \
(python::args("bv1"), python::args("bvList"), \
python::args("returnDistance") = 0), \
_help_); \
python::def(#_funcname_ "Neighbors", \
(python::list(*)(python::object, python::object)) \
_funcname_##Neighbors<ExplicitBitVect>, \
(python::args("bvqueries"), python::args("bvList")), _help_); \
python::def(#_funcname_ "Neighbors_sparse", \
(python::list(*)(python::object, python::object)) \
_funcname_##Neighbors<SparseBitVect>, \
(python::args("bvqueries"), python::args("bvList")), _help_); \
}
struct BitOps_wrapper {
static void wrap() {
BIG_DEF(TanimotoSimilarity, TanimotoSimilarity_w, BulkTanimotoSimilarity,
"B(bv1&bv2) / (B(bv1) + B(bv2) - B(bv1&bv2))");
BIG_DEF(CosineSimilarity, CosineSimilarity_w, BulkCosineSimilarity,
"B(bv1&bv2) / sqrt(B(bv1) * B(bv2))");
BIG_DEF(KulczynskiSimilarity, KulczynskiSimilarity_w,
BulkKulczynskiSimilarity,
"B(bv1&bv2)*(B(bv1) + B(bv2)) / (2 * B(bv1) * B(bv2))");
BIG_DEF(DiceSimilarity, DiceSimilarity_w, BulkDiceSimilarity,
"2*B(bv1&bv2) / (B(bv1) + B(bv2))");
BIG_DEF(SokalSimilarity, SokalSimilarity_w, BulkSokalSimilarity,
"B(bv1&bv2) / (2*B(bv1) + 2*B(bv2) - 3*B(bv1&bv2))");
BIG_DEF(
McConnaugheySimilarity, McConnaugheySimilarity_w,
BulkMcConnaugheySimilarity,
"(B(bv1&bv2) * (B(bv1)+B(bv2)) - B(bv1)*B(bv2)) / (B(bv1) * B(bv2))");
BIG_DEF(AsymmetricSimilarity, AsymmetricSimilarity_w,
BulkAsymmetricSimilarity, "B(bv1&bv2) / min(B(bv1),B(bv2))");
BIG_DEF(BraunBlanquetSimilarity, BraunBlanquetSimilarity_w,
BulkBraunBlanquetSimilarity, "B(bv1&bv2) / max(B(bv1),B(bv2))");
BIG_DEF(RusselSimilarity, RusselSimilarity_w, BulkRusselSimilarity,
"B(bv1&bv2) / B(bv1)");
BIG_DEF(RogotGoldbergSimilarity, RogotGoldbergSimilarity_w,
BulkRogotGoldbergSimilarity, "B(bv1&bv2) / B(bv1)");
{
std::string help = "B(bv1&bv2) / (a*B(bv1)+b*B(bv2)+(1-a-b)*B(bv1&bv2)";
python::def("TverskySimilarity",
(double (*)(const SBV &, const SBV &, double, double,
bool))TverskySimilarity_w,
(python::args("bv1"), python::args("bv2"), python::args("a"),
python::args("b"), python::args("returnDistance") = 0));
python::def("TverskySimilarity",
(double (*)(const EBV &, const EBV &, double, double,
bool))TverskySimilarity_w,
(python::args("bv1"), python::args("bv2"), python::args("a"),
python::args("b"), python::args("returnDistance") = 0),
help.c_str());
python::def("TverskySimilarity",
(double (*)(const SBV &, const std::string &, double, double,
bool))TverskySimilarity_w,
(python::args("bv1"), python::args("pkl"), python::args("a"),
python::args("b"), python::args("returnDistance") = 0));
python::def("TverskySimilarity",
(double (*)(const EBV &, const std::string &, double, double,
bool))TverskySimilarity_w,
(python::args("bv1"), python::args("pkl"), python::args("a"),
python::args("b"), python::args("returnDistance") = 0),
help.c_str());
python::def(
"BulkTverskySimilarity",
(python::list(*)(const SBV *, python::object, double, double,
bool))BulkTverskySimilarity,
(python::args("bv1"), python::args("bvList"), python::args("a"),
python::args("b"), python::args("returnDistance") = 0));
python::def(
"BulkTverskySimilarity",
(python::list(*)(const EBV *, python::object, double, double,
bool))BulkTverskySimilarity,
(python::args("bv1"), python::args("bvList"), python::args("a"),
python::args("b"), python::args("returnDistance") = 0),
help.c_str());
}
DBL_DEF(OnBitSimilarity, BulkOnBitSimilarity, "B(bv1&bv2) / B(bv1|bv2)");
DBL_DEF(AllBitSimilarity, BulkAllBitSimilarity,
"(B(bv1) - B(bv1^bv2)) / B(bv1)");
python::def("OnBitProjSimilarity",
(DoubleVect(*)(const SBV &, const SBV &))OnBitProjSimilarity,
python::args("bv1", "bv2"));
python::def(
"OnBitProjSimilarity",
(DoubleVect(*)(const EBV &, const EBV &))OnBitProjSimilarity,
python::args("bv1", "bv2"),
"Returns a 2-tuple: (B(bv1&bv2) / B(bv1), B(bv1&bv2) / B(bv2))");
python::def("OffBitProjSimilarity",
(DoubleVect(*)(const SBV &, const SBV &))OffBitProjSimilarity,
python::args("bv1", "bv2"));
python::def("OffBitProjSimilarity",
(DoubleVect(*)(const EBV &, const EBV &))OffBitProjSimilarity,
python::args("bv1", "bv2"));
python::def("NumBitsInCommon",
(int (*)(const SBV &, const SBV &))NumBitsInCommon,
python::args("bv1", "bv2"));
python::def("NumBitsInCommon",
(int (*)(const EBV &, const EBV &))NumBitsInCommon,
python::args("bv1", "bv2"),
"Returns the total number of bits in common between the two "
"bit vectors");
python::def("OnBitsInCommon",
(IntVect(*)(const SBV &, const SBV &))OnBitsInCommon,
python::args("bv1", "bv2"));
python::def(
"OnBitsInCommon", (IntVect(*)(const EBV &, const EBV &))OnBitsInCommon,
python::args("bv1", "bv2"),
"Returns the number of on bits in common between the two bit vectors");
python::def("OffBitsInCommon",
(IntVect(*)(const SBV &, const SBV &))OffBitsInCommon,
python::args("bv1", "bv2"));
python::def(
"OffBitsInCommon",
(IntVect(*)(const EBV &, const EBV &))OffBitsInCommon,
python::args("bv1", "bv2"),
"Returns the number of off bits in common between the two bit vectors");
python::def("FoldFingerprint",
(SBV * (*)(const SBV &, unsigned int)) FoldFingerprint,
(python::arg("bv"), python::arg("foldFactor") = 2),
python::return_value_policy<python::manage_new_object>());
python::def("FoldFingerprint",
(EBV * (*)(const EBV &, unsigned int)) FoldFingerprint,
(python::arg("bv"), python::arg("foldFactor") = 2),
python::return_value_policy<python::manage_new_object>(),
"Folds the fingerprint by the provided amount. The default, "
"foldFactor=2, returns a fingerprint that is half the size of "
"the original.");
python::def("AllProbeBitsMatch",
(bool (*)(const SBV &, const SBV &))AllProbeBitsMatch,
python::args("probe", "ref"));
python::def("AllProbeBitsMatch",
(bool (*)(const EBV &, const EBV &))AllProbeBitsMatch,
python::args("probe", "ref"));
python::def("AllProbeBitsMatch",
(bool (*)(const SBV &, const std::string &))AllProbeBitsMatch,
python::args("probe", "ref"));
python::def(
"AllProbeBitsMatch",
(bool (*)(const EBV &, const std::string &))AllProbeBitsMatch,
python::args("probe", "ref"),
"Returns True if all bits in the first argument match all bits in the \n\
vector defined by the pickle in the second argument.\n");
python::def("BitVectToText", (std::string(*)(const SBV &))BitVectToText,
python::args("bv1"));
python::def(
"BitVectToText", (std::string(*)(const EBV &))BitVectToText,
python::args("bv1"),
"Returns a string of zeros and ones representing the bit vector.");
python::def("BitVectToFPSText",
(std::string(*)(const SBV &))BitVectToFPSText,
python::args("bv1"));
python::def("BitVectToFPSText",
(std::string(*)(const EBV &))BitVectToFPSText,
python::args("bv1"),
"Returns an FPS string representing the bit vector.");
python::def("BitVectToBinaryText",
(python::object(*)(const SBV &))BVToBinaryText,
python::args("bv"));
python::def(
"BitVectToBinaryText", (python::object(*)(const EBV &))BVToBinaryText,
python::args("bv"),
"Returns a binary string (byte array) representing the bit vector.");
}
};
void wrap_BitOps() { BitOps_wrapper::wrap(); }
|