seams-core v2.14.0
libyodaLib, the C++ engine of d-SEAMS
Loading...
Searching...
No Matches
seams::Rings Class Reference

Owned primitive-ring set. More...

#include <include/seams.hpp>

Inheritance diagram for seams::Rings:

Classes

class  iterator
 Input iterator. More...

Public Member Functions

int size () const
 Number of primitive rings.
std::vector< int > vertices (int index) const
 Atom indices of one ring.
std::vector< int > histogram (int up_to) const
 Histogram of ring size.
double fraction (int ring_size) const
 Fraction of atoms that sit on a ring of one size.
iterator begin () const
 First ring.
iterator end () const
 Past the last ring.
Public Member Functions inherited from seams::detail::Handle< seams_rings, seams_rings_destroy >
 Handle ()=default
Handle & operator= (const Handle &)=delete
 ~Handle ()
 operator bool () const noexcept

Additional Inherited Members

Protected Member Functions inherited from seams::detail::Handle< seams_rings, seams_rings_destroy >
seams_rings * get () const noexcept
void reset () noexcept
Protected Attributes inherited from seams::detail::Handle< seams_rings, seams_rings_destroy >
seams_rings * ptr_

Detailed Description

Owned primitive-ring set.

Move-only. begin and end walk the rings and yield vertex indices.

Definition at line 731 of file seams.hpp.

Member Function Documentation

◆ begin()

iterator seams::Rings::begin ( ) const
inlinenodiscard

First ring.

Definition at line 797 of file seams.hpp.

797{ return iterator(this, 0); }
Input iterator.
Definition seams.hpp:778

◆ end()

iterator seams::Rings::end ( ) const
inlinenodiscard

Past the last ring.

Definition at line 799 of file seams.hpp.

799{ return iterator(this, size()); }
int size() const
Number of primitive rings.
Definition seams.hpp:739

◆ fraction()

double seams::Rings::fraction ( int ring_size) const
inlinenodiscard

Fraction of atoms that sit on a ring of one size.

Parameters
ring_sizeSize to count. Zero counts every ring.
Returns
Dimensionless fraction.

Definition at line 771 of file seams.hpp.

771 {
772 double value = 0;
773 detail::check(seams_rings_fraction(get(), ring_size, &value), get());
774 return value;
775 }
SEAMS_API seams_status seams_rings_fraction(const seams_rings *rings, int size, double *fraction)
Fraction of atoms that sit on a ring.
void check(int status, const void *handle)
Definition seams.hpp:557

◆ histogram()

std::vector< int > seams::Rings::histogram ( int up_to) const
inlinenodiscard

Histogram of ring size.

Parameters
up_toHighest size stored. counts[k] is the number of rings of size k.
Returns
The histogram. Length is up_to + 1.

Definition at line 760 of file seams.hpp.

760 {
761 std::vector<int> counts(static_cast<std::size_t>(up_to + 1));
762 detail::check(seams_rings_histogram(get(), counts.data(), up_to + 1), get());
763 return counts;
764 }
SEAMS_API seams_status seams_rings_histogram(const seams_rings *rings, int *counts, int counts_len)
Count primitive rings by size, with an int length.

◆ size()

int seams::Rings::size ( ) const
inlinenodiscard

Number of primitive rings.

Returns
The ring count. A moved-from handle reports 0.

Definition at line 739 of file seams.hpp.

739{ return seams_rings_count(get()); }
SEAMS_API int seams_rings_count(const seams_rings *rings)
Number of primitive rings, as an int.

◆ vertices()

std::vector< int > seams::Rings::vertices ( int index) const
inlinenodiscard

Atom indices of one ring.

Parameters
indexRing index, from 0 to size() - 1.
Returns
Frame indices, in ring order.

Definition at line 746 of file seams.hpp.

746 {
747 std::size_t n_out = 0;
748 detail::check(seams_rings_vertices(get(), index, nullptr, 0, &n_out), get());
749 std::vector<int> atoms(n_out);
750 detail::check(seams_rings_vertices(get(), index, atoms.data(), n_out, &n_out), get());
751 atoms.resize(n_out);
752 return atoms;
753 }
SEAMS_API seams_status seams_rings_vertices(const seams_rings *rings, int index, int *atoms, size_t cap, size_t *n_out)
Atom indices of one ring.

The documentation for this class was generated from the following file: