.. index:: pair: class; seams::Cages .. _doxid-classseams_1_1_cages: class seams::Cages ================== .. toctree:: :hidden: Overview ~~~~~~~~ Owned hexagonal and double-diamond membership. :ref:`More...` .. ref-code-block:: cpp :class: doxyrest-overview-code-block #include class Cages: public :ref:`seams::detail::Handle` { public: // methods :ref:`CageCounts` :ref:`counts`() const; std::vector :ref:`labels`(std::size_t n_atoms) 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_cages: Detailed Documentation ~~~~~~~~~~~~~~~~~~~~~~ Owned hexagonal and double-diamond membership. Methods ------- .. index:: pair: function; counts .. _doxid-classseams_1_1_cages_1a1f80642a50421420371555be19aaa6b5: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`CageCounts` counts() const Disjoint population counts. .. rubric:: Returns: Hexagonal, cubic, water, and both. .. index:: pair: function; labels .. _doxid-classseams_1_1_cages_1a5f04aad709697fb2aafb094e8ba51847: .. ref-code-block:: cpp :class: doxyrest-title-code-block std::vector labels(std::size_t n_atoms) const One cage code per atom. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - n_atoms - Length of the frame the cages were built from. .. rubric:: Returns: Codes matching ``:ref:`CageLabel ```.