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
|
//
// Copyright (C) 2018-2022 Boran Adas 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 <GraphMol/Fingerprints/RDKitFPGenerator.h>
#include <GraphMol/RDKitBase.h>
#include <GraphMol/Fingerprints/FingerprintGenerator.h>
#include <RDGeneral/hash/hash.hpp>
#include <cstdint>
#include <GraphMol/QueryOps.h>
#include <DataStructs/ExplicitBitVect.h>
#include <DataStructs/BitOps.h>
#include <GraphMol/Subgraphs/Subgraphs.h>
#include <GraphMol/Subgraphs/SubgraphUtils.h>
#include <GraphMol/Substruct/SubstructMatch.h>
#include <GraphMol/SmilesParse/SmilesParse.h>
#include <RDGeneral/Invariant.h>
#include <RDGeneral/BoostStartInclude.h>
#include <boost/random.hpp>
#include <RDGeneral/BoostEndInclude.h>
#include <climits>
#include <RDGeneral/hash/hash.hpp>
#include <RDGeneral/types.h>
#include <algorithm>
#include <boost/dynamic_bitset.hpp>
#include <GraphMol/Fingerprints/FingerprintUtil.h>
namespace RDKit {
namespace RDKitFP {
std::vector<std::uint32_t> *RDKitFPAtomInvGenerator::getAtomInvariants(
const ROMol &mol) const {
auto *result = new std::vector<std::uint32_t>();
result->reserve(mol.getNumAtoms());
for (ROMol::ConstAtomIterator atomIt = mol.beginAtoms();
atomIt != mol.endAtoms(); ++atomIt) {
unsigned int aHash = ((*atomIt)->getAtomicNum() % 128) << 1 |
static_cast<unsigned int>((*atomIt)->getIsAromatic());
result->push_back(aHash);
}
return result;
}
std::string RDKitFPAtomInvGenerator::infoString() const {
return "RDKitFPAtomInvGenerator";
}
RDKitFPAtomInvGenerator *RDKitFPAtomInvGenerator::clone() const {
return new RDKitFPAtomInvGenerator();
}
template <typename OutputType>
OutputType RDKitFPEnvGenerator<OutputType>::getResultSize() const {
return std::numeric_limits<OutputType>::max();
}
std::string RDKitFPArguments::infoString() const {
return "RDKitFPArguments minPath=" + std::to_string(d_minPath) +
" maxPath=" + std::to_string(d_maxPath) +
" useHs=" + std::to_string(df_useHs) +
" branchedPaths=" + std::to_string(df_branchedPaths) +
" useBondOrder=" + std::to_string(df_useBondOrder);
}
RDKitFPArguments::RDKitFPArguments(unsigned int minPath, unsigned int maxPath,
bool useHs, bool branchedPaths,
bool useBondOrder, bool countSimulation,
const std::vector<std::uint32_t> countBounds,
std::uint32_t fpSize,
std::uint32_t numBitsPerFeature)
: FingerprintArguments(countSimulation, countBounds, fpSize,
numBitsPerFeature),
d_minPath(minPath),
d_maxPath(maxPath),
df_useHs(useHs),
df_branchedPaths(branchedPaths),
df_useBondOrder(useBondOrder) {
PRECONDITION(minPath != 0, "minPath==0");
PRECONDITION(maxPath >= minPath, "maxPath<minPath");
}
template <typename OutputType>
void RDKitFPAtomEnv<OutputType>::updateAdditionalOutput(
AdditionalOutput *additionalOutput, size_t bitId) const {
PRECONDITION(additionalOutput, "bad output pointer");
if (additionalOutput->bitPaths) {
(*additionalOutput->bitPaths)[bitId].push_back(d_bondPath);
}
if (additionalOutput->atomToBits || additionalOutput->atomCounts) {
for (size_t i = 0; i < d_atomsInPath.size(); ++i) {
if (d_atomsInPath[i]) {
if (additionalOutput->atomToBits) {
auto &alist = additionalOutput->atomToBits->at(i);
if (std::find(alist.begin(), alist.end(), bitId) == alist.end()) {
alist.push_back(bitId);
}
}
if (additionalOutput->atomCounts) {
additionalOutput->atomCounts->at(i)++;
}
}
}
}
}
template <typename OutputType>
OutputType RDKitFPAtomEnv<OutputType>::getBitId(
FingerprintArguments *, // arguments
const std::vector<std::uint32_t> *, // atomInvariants
const std::vector<std::uint32_t> *, // bondInvariants
AdditionalOutput *, // additional Output
const bool, // hashResults
const std::uint64_t // fpSize
) const {
return d_bitId;
}
template <typename OutputType>
std::string RDKitFPEnvGenerator<OutputType>::infoString() const {
return "RDKitFPEnvGenerator";
}
template <typename OutputType>
std::vector<AtomEnvironment<OutputType> *>
RDKitFPEnvGenerator<OutputType>::getEnvironments(
const ROMol &mol, FingerprintArguments *arguments,
const std::vector<std::uint32_t> *fromAtoms,
const std::vector<std::uint32_t> *, // ignoreAtoms
const int, // confId
const AdditionalOutput *, // additionalOutput
const std::vector<std::uint32_t> *atomInvariants,
const std::vector<std::uint32_t> *, // bondInvariants
const bool // hashResults
) const {
PRECONDITION(!atomInvariants || atomInvariants->size() >= mol.getNumAtoms(),
"bad atomInvariants size");
auto *fpArguments = dynamic_cast<RDKitFPArguments *>(arguments);
std::vector<AtomEnvironment<OutputType> *> result;
// get all paths
INT_PATH_LIST_MAP allPaths;
RDKitFPUtils::enumerateAllPaths(
mol, allPaths, fromAtoms, fpArguments->df_branchedPaths,
fpArguments->df_useHs, fpArguments->d_minPath, fpArguments->d_maxPath);
// identify query bonds
std::vector<short> isQueryBond(mol.getNumBonds(), 0);
std::vector<const Bond *> bondCache;
RDKitFPUtils::identifyQueryBonds(mol, bondCache, isQueryBond);
boost::dynamic_bitset<> atomsInPath(mol.getNumAtoms());
for (INT_PATH_LIST_MAP_CI paths = allPaths.begin(); paths != allPaths.end();
paths++) {
for (const auto &path : paths->second) {
// the bond hashes of the path
std::vector<std::uint32_t> bondHashes = RDKitFPUtils::generateBondHashes(
mol, atomsInPath, bondCache, isQueryBond, path,
fpArguments->df_useBondOrder, atomInvariants);
if (!bondHashes.size()) {
continue;
}
// hash the path to generate a seed:
unsigned long seed;
if (path.size() > 1) {
std::sort(bondHashes.begin(), bondHashes.end());
// finally, we will add the number of distinct atoms in the path at the
// end
// of the vect. This allows us to distinguish C1CC1 from CC(C)C
bondHashes.push_back(static_cast<std::uint32_t>(atomsInPath.count()));
seed = gboost::hash_range(bondHashes.begin(), bondHashes.end());
} else {
seed = bondHashes[0];
}
result.push_back(new RDKitFPAtomEnv<OutputType>(
static_cast<OutputType>(seed), atomsInPath, path));
}
}
return result;
}
template <typename OutputType>
FingerprintGenerator<OutputType> *getRDKitFPGenerator(
const RDKitFPArguments &args,
AtomInvariantsGenerator *atomInvariantsGenerator, bool ownsAtomInvGen) {
auto *envGenerator = new RDKitFPEnvGenerator<OutputType>();
bool ownsAtomInvGenerator = ownsAtomInvGen;
if (!atomInvariantsGenerator) {
atomInvariantsGenerator = new RDKitFPAtomInvGenerator();
ownsAtomInvGenerator = true;
}
return new FingerprintGenerator<OutputType>(
envGenerator, new RDKitFPArguments(args), atomInvariantsGenerator,
nullptr, ownsAtomInvGenerator, false);
}
template <typename OutputType>
FingerprintGenerator<OutputType> *getRDKitFPGenerator(
unsigned int minPath, unsigned int maxPath, bool useHs, bool branchedPaths,
bool useBondOrder, AtomInvariantsGenerator *atomInvariantsGenerator,
bool countSimulation, const std::vector<std::uint32_t> countBounds,
std::uint32_t fpSize, std::uint32_t numBitsPerFeature,
bool ownsAtomInvGen) {
RDKitFPArguments arguments(minPath, maxPath, useHs, branchedPaths,
useBondOrder, countSimulation, countBounds, fpSize,
numBitsPerFeature);
return getRDKitFPGenerator<OutputType>(arguments, atomInvariantsGenerator,
ownsAtomInvGen);
}
template RDKIT_FINGERPRINTS_EXPORT FingerprintGenerator<std::uint32_t> *
getRDKitFPGenerator(unsigned int minPath, unsigned int maxPath, bool useHs,
bool branchedPaths, bool useBondOrder,
AtomInvariantsGenerator *atomInvariantsGenerator,
bool countSimulation,
const std::vector<std::uint32_t> countBounds,
std::uint32_t fpSize, std::uint32_t numBitsPerFeature,
bool ownsAtomInvGen);
template RDKIT_FINGERPRINTS_EXPORT FingerprintGenerator<std::uint64_t> *
getRDKitFPGenerator(unsigned int minPath, unsigned int maxPath, bool useHs,
bool branchedPaths, bool useBondOrder,
AtomInvariantsGenerator *atomInvariantsGenerator,
bool countSimulation,
const std::vector<std::uint32_t> countBounds,
std::uint32_t fpSize, std::uint32_t numBitsPerFeature,
bool ownsAtomInvGen);
template RDKIT_FINGERPRINTS_EXPORT FingerprintGenerator<std::uint32_t> *
getRDKitFPGenerator(const RDKitFPArguments &, AtomInvariantsGenerator *, bool);
template RDKIT_FINGERPRINTS_EXPORT FingerprintGenerator<std::uint64_t> *
getRDKitFPGenerator(const RDKitFPArguments &, AtomInvariantsGenerator *, bool);
} // namespace RDKitFP
} // namespace RDKit
|