.. index:: pair: class; seams::Rings .. _doxid-classseams_1_1_rings: class seams::Rings ================== .. toctree:: :hidden: class_seams_Rings_iterator.rst Overview ~~~~~~~~ Owned primitive-ring set. :ref:`More...` .. ref-code-block:: cpp :class: doxyrest-overview-code-block #include class Rings: public :ref:`seams::detail::Handle` { public: // classes class :ref:`iterator`; // methods int :ref:`size`() const; std::vector :ref:`vertices`(int index) const; std::vector :ref:`histogram`(int up_to) const; double :ref:`fraction`(int ring_size) const; :ref:`iterator` :ref:`begin`() const; :ref:`iterator` :ref:`end`() const; }; Inherited Members ----------------- .. ref-code-block:: cpp :class: doxyrest-overview-inherited-code-block public: // methods :ref:`Handle`& :ref:`operator=`(const :ref:`Handle`&); :ref:`Handle`& :ref:`operator=`(:ref:`Handle`&& other); :ref:`operator bool`() const; .. _details-classseams_1_1_rings: Detailed Documentation ~~~~~~~~~~~~~~~~~~~~~~ Owned primitive-ring set. Move-only. ``:ref:`begin ``` and ``:ref:`end ``` walk the rings and yield vertex indices. Methods ------- .. index:: pair: function; size .. _doxid-classseams_1_1_rings_1a8f4d567dfc956ba765e61efd7615be4c: .. ref-code-block:: cpp :class: doxyrest-title-code-block int size() const Number of primitive rings. .. rubric:: Returns: The ring count. A moved-from handle reports 0. .. index:: pair: function; vertices .. _doxid-classseams_1_1_rings_1ab64a4d0b73b2a9ead71b3e9963fa2220: .. ref-code-block:: cpp :class: doxyrest-title-code-block std::vector vertices(int index) const Atom indices of one ring. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - index - Ring index, from 0 to ``:ref:`size() ` - 1``. .. rubric:: Returns: Frame indices, in ring order. .. index:: pair: function; histogram .. _doxid-classseams_1_1_rings_1a0e2e276b5b38e404dae71e295cb0abfb: .. ref-code-block:: cpp :class: doxyrest-title-code-block std::vector histogram(int up_to) const Histogram of ring size. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - up_to - Highest size stored. ``counts[k]`` is the number of rings of size k. .. rubric:: Returns: The histogram. Length is ``up_to + 1``. .. index:: pair: function; fraction .. _doxid-classseams_1_1_rings_1acfab520584df981bc771426f1044344b: .. ref-code-block:: cpp :class: doxyrest-title-code-block double fraction(int ring_size) const Fraction of atoms that sit on a ring of one size. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ring_size - Size to count. Zero counts every ring. .. rubric:: Returns: Dimensionless fraction. .. index:: pair: function; begin .. _doxid-classseams_1_1_rings_1a3a503b36e7192dd58ce09db1f75c2664: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`iterator` begin() const First ring. .. index:: pair: function; end .. _doxid-classseams_1_1_rings_1a2776439d24c3f74b0e26587f4aed29e7: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`iterator` end() const Past the last ring.