seams-core v2.14.0
libyodaLib, the C++ engine of d-SEAMS
Loading...
Searching...
No Matches
cage_affiliation.hpp
Go to the documentation of this file.
1//-----------------------------------------------------------------------------------
2// d-SEAMS - Deferred Structural Elucidation Analysis for Molecular Simulations
3//
4// Copyright (c) 2018--present d-SEAMS core team
5//
6// SPDX-License-Identifier: MIT
7//-----------------------------------------------------------------------------------
8
9#ifndef SEAMS_CAGE_AFFILIATION_H_
10#define SEAMS_CAGE_AFFILIATION_H_
11
12#include <memory>
13#include <vector>
14
54
55namespace ring {
56
61 std::vector<bool> hc;
62 std::vector<bool> ddc;
63};
64
74 std::vector<bool> basal;
75 std::vector<bool> equatorial;
76};
77
79 const std::vector<std::vector<int>> &rings,
80 const std::vector<std::vector<int>> &nList);
81
86 const std::vector<std::vector<int>> &rings,
87 const std::vector<std::vector<int>> &nList);
88
101public:
105 AffiliationUpdater &operator=(AffiliationUpdater &&) noexcept;
107 AffiliationUpdater &operator=(const AffiliationUpdater &) = delete;
108
112 const CageAffiliation &update(const std::vector<std::vector<int>> &rings,
113 const std::vector<std::vector<int>> &nList);
114
117 [[nodiscard]] int lastReclassified() const;
118
123 void setBatchFraction(double fraction);
124
125private:
126 struct Impl;
127 std::unique_ptr<Impl> impl_;
128};
129
134 std::vector<bool> hc;
135 std::vector<bool> ddc;
136};
137
160 const std::vector<std::vector<int>> &strictRings,
161 const std::vector<std::vector<int>> &strictNList,
162 const std::vector<std::vector<int>> &permissiveRings,
163 const std::vector<std::vector<int>> &permissiveNList,
164 bool ringAdjacentCompletion = false);
165
178 const std::vector<std::vector<int>> &strictRings,
179 const CageAffiliation &strictAffiliation,
180 const std::vector<std::vector<int>> &permissiveRings,
181 const CageAffiliation &permissiveAffiliation,
182 const std::vector<std::vector<int>> &permissiveNList,
183 bool ringAdjacentCompletion = false);
184
203[[nodiscard]] SeededAtomLabels
205 const std::vector<std::vector<int>> &permissiveRings);
206
207} // namespace ring
208
209#endif // SEAMS_CAGE_AFFILIATION_H_
const CageAffiliation & update(const std::vector< std::vector< int > > &rings, const std::vector< std::vector< int > > &nList)
int lastReclassified() const
void setBatchFraction(double fraction)
AffiliationUpdater(AffiliationUpdater &&) noexcept
Topological network criteria functions.
SeededAtomLabels seededCageAffiliation(const std::vector< std::vector< int > > &strictRings, const std::vector< std::vector< int > > &strictNList, const std::vector< std::vector< int > > &permissiveRings, const std::vector< std::vector< int > > &permissiveNList, bool ringAdjacentCompletion=false)
Seeded affiliation over two graphs on the same atoms: the strict graph (typically the mutual k-neares...
SeededAtomLabels ringAdjacentCompletion(const SeededAtomLabels &labels, const std::vector< std::vector< int > > &permissiveRings)
Ring completion of seeded labels.
CageAffiliation cageAffiliation(const std::vector< std::vector< int > > &rings, const std::vector< std::vector< int > > &nList)
StackingPlanes stackingPlanes(const std::vector< std::vector< int > > &rings, const std::vector< std::vector< int > > &nList)
Per-ring affiliation flags, indexed like the input ring vector.
std::vector< bool > ddc
Basal or prismatic of a passing basal pair.
std::vector< bool > hc
Per-atom cage flags from seeded (hysteresis) affiliation.
std::vector< bool > ddc
Atom belongs to an accepted HC-affiliated ring.
Six-rings that are ice-I stacking planes.
std::vector< bool > equatorial
HC basal of a passing pair.
std::vector< bool > basal