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
|
//
// Copyright (C) David Cosgrove 2024.
//
// @@ 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.
//
#ifndef RDKIT_SYNTHONSPACE_SEARCHRESULTS_H
#define RDKIT_SYNTHONSPACE_SEARCHRESULTS_H
#include <RDGeneral/export.h>
#include <GraphMol/ROMol.h>
namespace RDKit::SynthonSpaceSearch {
// A class holding a set of results from a search. Contains the hit
// molecules and information about how the search progressed, whether
// it timed out etc.
class RDKIT_SYNTHONSPACESEARCH_EXPORT SearchResults {
public:
explicit SearchResults() : d_maxNumResults(0) {}
SearchResults(std::vector<std::unique_ptr<ROMol>> &&mols, std::uint64_t maxNumRes,
bool timedOut, bool cancelled);
SearchResults(const SearchResults &other);
SearchResults(SearchResults &&other) = default;
~SearchResults() = default;
SearchResults &operator=(const SearchResults &other);
SearchResults &operator=(SearchResults &&other) = default;
/*!
* Returns the upper bound on the number of results the search might return.
* There may be fewer than this in practice for several reasons such as
* duplicate reagent sets being removed or the final product not matching the
* query even though the synthons suggested it would.
*
* @return int
*/
std::uint64_t getMaxNumResults() const { return d_maxNumResults; }
/*!
* Returns the hit molecules from the search. Not necessarily all
* those possible, just the maximum number requested.
*
* @return std::vector<std::unique_ptr<ROMol>>
*/
const std::vector<std::unique_ptr<ROMol>> &getHitMolecules() const {
return d_hitMolecules;
}
/*!
* Returns whether the search timed out or not,
* @return bool
*/
bool getTimedOut() const { return d_timedOut; }
/*!
* Returns whether the search was cancelled or not,
* @return bool
*/
bool getCancelled() const { return d_cancelled; }
// Merge other into this, keeping only molecules with unique
// names and destroying contents of other on exit.
void mergeResults(SearchResults &other);
private:
std::vector<std::unique_ptr<ROMol>> d_hitMolecules;
// Only used when merging in another set, so will be
// filled in then if needed, empty otherwise.
std::unordered_set<std::string> d_molNames;
std::uint64_t d_maxNumResults;
bool d_timedOut{false};
bool d_cancelled{false};
};
} // namespace RDKit::SynthonSpaceSearch
#endif // RDKIT_SYNTHONSPACE_SEARCHRESULTS_H
|
