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

Owned hexagonal and double-diamond membership. More...

#include <include/seams.hpp>

Inheritance diagram for seams::Cages:

Public Member Functions

CageCounts counts () const
 Disjoint population counts.
std::vector< int > labels (std::size_t n_atoms) const
 One cage code per atom.
Public Member Functions inherited from seams::detail::Handle< seams_cage_set, seams_cages_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_cage_set, seams_cages_destroy >
seams_cage_set * get () const noexcept
void reset () noexcept
Protected Attributes inherited from seams::detail::Handle< seams_cage_set, seams_cages_destroy >
seams_cage_set * ptr_

Detailed Description

Owned hexagonal and double-diamond membership.

Definition at line 806 of file seams.hpp.

Member Function Documentation

◆ counts()

CageCounts seams::Cages::counts ( ) const
inlinenodiscard

Disjoint population counts.

Returns
Hexagonal, cubic, water, and both.

Definition at line 814 of file seams.hpp.

814 {
815 CageCounts out;
816 detail::check(seams_cages_counts(get(), &out.hexagonal, &out.cubic, &out.water, &out.both),
817 get());
818 return out;
819 }
SEAMS_API seams_status seams_cages_counts(const seams_cage_set *cages, int *n_hex, int *n_cubic, int *n_water, int *n_both)
Disjoint cage population counts.
void check(int status, const void *handle)
Definition seams.hpp:557

◆ labels()

std::vector< int > seams::Cages::labels ( std::size_t n_atoms) const
inlinenodiscard

One cage code per atom.

Parameters
n_atomsLength of the frame the cages were built from.
Returns
Codes matching CageLabel.

Definition at line 826 of file seams.hpp.

826 {
827 std::vector<int> per_atom(n_atoms);
828 detail::check(seams_cages_labels(get(), per_atom.data(), per_atom.size()), get());
829 return per_atom;
830 }
SEAMS_API seams_status seams_cages_labels(const seams_cage_set *cages, int *per_atom, size_t len)
Per-atom cage code.

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