class seams::Rings¶
Overview¶
Owned primitive-ring set. More…
#include <include/seams.hpp>
class Rings: public seams::detail::Handle {
public:
// classes
class iterator;
// methods
int size() const;
std::vector<int> vertices(int index) const;
std::vector<int> histogram(int up_to) const;
double fraction(int ring_size) const;
iterator begin() const;
iterator end() const;
};
Inherited Members¶
Detailed Documentation¶
Owned primitive-ring set.
Move-only. begin and end walk the rings and yield vertex indices.
Methods¶
int size() const
Number of primitive rings.
Returns:
The ring count. A moved-from handle reports 0.
std::vector<int> vertices(int index) const
Atom indices of one ring.
Parameters:
index |
Ring index, from 0 to |
Returns:
Frame indices, in ring order.
std::vector<int> histogram(int up_to) const
Histogram of ring size.
Parameters:
up_to |
Highest size stored. |
Returns:
The histogram. Length is up_to + 1.
double fraction(int ring_size) const
Fraction of atoms that sit on a ring of one size.
Parameters:
ring_size |
Size to count. Zero counts every ring. |
Returns:
Dimensionless fraction.
iterator begin() const
First ring.
iterator end() const
Past the last ring.