BondView Class Reference

Immutable view on a bond. More...

#include <BondList.hpp>

Public Member Functions
	BondView ()=default
	BondView (int id, std::span< const int > partners)
int	bond_id () const
auto const &	partner_ids () const
bool	operator== (BondView const &rhs) const
bool	operator!= (BondView const &rhs) const

Detailed Description

Immutable view on a bond.

The bond id and ids of the partner particles of a bond can be inspected (but not changed) via this view.

Definition at line 44 of file BondList.hpp.

Constructor & Destructor Documentation

BondView() [1/2]

BondView::BondView ( )

default

BondView() [2/2]

BondView::BondView ( int  id, std::span< const int >  partners  )

inline

Definition at line 51 of file BondList.hpp.

Member Function Documentation

bond_id()

int BondView::bond_id ( ) const

inline

Definition at line 54 of file BondList.hpp.

operator!=()

bool BondView::operator!= ( BondView const &  rhs ) const

inline

Definition at line 61 of file BondList.hpp.

References stream.

operator==()

bool BondView::operator== ( BondView const &  rhs ) const

inline

Definition at line 57 of file BondList.hpp.

References stream.

partner_ids()

auto const & BondView::partner_ids ( ) const

inline

Definition at line 55 of file BondList.hpp.

---

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

• BondList.hpp