Files
rdkit/Code/DistGeom/FourthDimContribs.h
Greg Landrum 2c5ae534f2 Optimizations of the DistanceGeometry forcefield (#7600)
* First try at using DistViolationContribs

only the most basic of testing has been done

also add ForceField::distance2 to allow some optimizations

* allow testing using old approach

* optimization

At this point testUFFForceFieldHelpers fails since the check for std::max_element
in the e_contribs vector at Embedder.cpp:513 is now doing something totally different
(instead of a bunch of small distance violation contribs, we have one big one).
We'll need to come up with something for this.

With the benchmarking set that I'm using - 500 DG conformers for ~465 COD molecules
using 10 threads - this runs in almost 10% less time than master.

* backup;
builds, tests do not pass

* all tests pass except the old failure

* more constification

* backup/debugging

* add fourthdim contribs the same way

* tests now pass

* deprecations

* remove unused vars and code

* changes in response to review
2024-07-15 14:14:39 -04:00

85 lines
2.4 KiB
C++

//
// Copyright (C) 2024 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 <RDGeneral/export.h>
#ifndef RD_FOURTHDIMCONTRIBS_H
#define RD_FOURTHDIMCONTRIBS_H
#include <vector>
#include <RDGeneral/Invariant.h>
#include <ForceField/Contrib.h>
#include <ForceField/ForceField.h>
namespace DistGeom {
struct FourthDimContribsParams {
unsigned int idx{0};
double weight{0.0};
FourthDimContribsParams(unsigned int idx, double w) : idx(idx), weight(w) {};
};
//! A term used in penalizing the 4th dimension in order to move from 4D->3D
//!
class RDKIT_DISTGEOMETRY_EXPORT FourthDimContribs
: public ForceFields::ForceFieldContrib {
public:
FourthDimContribs() = default;
//! Constructor
/*!
\param owner pointer to the owning ForceField
\param idx the index of the atom to be considered
\param weight (optional) the weight to be used for this contrib
*/
FourthDimContribs(ForceFields::ForceField *owner) {
PRECONDITION(owner, "bad force field");
PRECONDITION(owner->dimension() == 4, "force field has wrong dimension");
dp_forceField = owner;
}
void addContrib(unsigned int idx, double weight) {
d_contribs.emplace_back(idx, weight);
}
//! return the contribution of this contrib to the energy of a given state
double getEnergy(double *pos) const override {
PRECONDITION(pos, "bad vector");
constexpr unsigned int ffdim = 4;
double res = 0.0;
for (const auto &contrib : d_contribs) {
unsigned int pid = contrib.idx * ffdim + 3;
res += contrib.weight * pos[pid] * pos[pid];
}
return res;
}
//! calculate the contribution of this contrib to the gradient at a given
/// state
void getGrad(double *pos, double *grad) const override {
PRECONDITION(pos, "bad vector");
constexpr unsigned int ffdim = 4;
for (const auto &contrib : d_contribs) {
unsigned int pid = contrib.idx * ffdim + 3;
grad[pid] += contrib.weight * pos[pid];
}
}
FourthDimContribs *copy() const override {
return new FourthDimContribs(*this);
}
bool empty() const { return d_contribs.empty(); }
unsigned int size() const { return d_contribs.size(); }
private:
std::vector<FourthDimContribsParams> d_contribs;
};
} // namespace DistGeom
#endif