.. index:: pair: class; seams::Neighbours .. _doxid-classseams_1_1_neighbours: class seams::Neighbours ======================= .. toctree:: :hidden: Overview ~~~~~~~~ Owned neighbour list. :ref:`More...` .. ref-code-block:: cpp :class: doxyrest-overview-code-block #include class Neighbours: public :ref:`seams::detail::Handle` { public: // methods std::size_t :ref:`nnz`() const; std::vector :ref:`degrees`() const; std::vector> :ref:`pairs`() const; :ref:`ChordlessCycles` :ref:`chordless`(int size) 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_neighbours: Detailed Documentation ~~~~~~~~~~~~~~~~~~~~~~ Owned neighbour list. Move-only. Destruction frees the C handle. The self entry is omitted. A neighbour list is not safe to share across threads. Methods ------- .. index:: pair: function; nnz .. _doxid-classseams_1_1_neighbours_1abd527879d1fe10c5c111a7d9bbdd9d96: .. ref-code-block:: cpp :class: doxyrest-title-code-block std::size_t nnz() const Number of neighbour pairs, omitting self. .. rubric:: Returns: The pair count. .. index:: pair: function; degrees .. _doxid-classseams_1_1_neighbours_1a37d5bc28acddb1f0011ff398a81cd1db: .. ref-code-block:: cpp :class: doxyrest-title-code-block std::vector degrees() const Degree of each atom. .. rubric:: Returns: One integer per atom. The self entry is not counted. .. index:: pair: function; pairs .. _doxid-classseams_1_1_neighbours_1a791751da6ff0a3728f76715180b12887: .. ref-code-block:: cpp :class: doxyrest-title-code-block std::vector> pairs() const Directed pairs ``(atom, neighbour)``. .. rubric:: Returns: One pair per stored column. Self is omitted. .. index:: pair: function; chordless .. _doxid-classseams_1_1_neighbours_1a13edfc37618cf2779867c27eb72ed1fd: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`ChordlessCycles` chordless(int size) const Chordless cycles of one length on this graph. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - size - Cycle length, from 3 through 12. .. rubric:: Returns: The rows and the per-atom counts of seams_rings_chordless.