A pair of sites. More...
#include <site_pair.hh>
Inheritance diagram for mln::util::site_pair< P >:
Public Types | |
| typedef Object< void > | category |
| typedef P::coord | coord |
| typedef site_pair< P > | exact_t |
Public Member Functions | |
| const P & | first () const |
| Return the first site. | |
| const util::ord_pair< P > & | pair () const |
| Return the underlying pair. | |
| const P & | second () const |
| Return the second site. | |
| site_pair () | |
| site_pair (const P &first, const P &second) | |
Private Attributes | |
| util::ord_pair< P > | pair_ |
Detailed Description
template<typename P>
class mln::util::site_pair< P >
A pair of sites.
It can be used as site.
Member Typedef Documentation
typedef Object<void> mln::Object< site_pair< P > >::category [inherited] |
template<typename P>
| typedef P ::coord mln::util::site_pair< P >::coord |
typedef site_pair< P > mln::Object< site_pair< P > >::exact_t [inherited] |
Constructor & Destructor Documentation
template<typename P >
| mln::util::site_pair< P >::site_pair | ( | ) |
template<typename P >
| mln::util::site_pair< P >::site_pair | ( | const P & | first, | |
| const P & | second | |||
| ) |
Member Function Documentation
template<typename P >
| const P & mln::util::site_pair< P >::first | ( | ) | const [inline] |
Return the first site.
References mln::util::ord_pair< T >::first(), and mln::util::site_pair< P >::pair_.
template<typename P >
| const util::ord_pair< P > & mln::util::site_pair< P >::pair | ( | ) | const [inline] |
Return the underlying pair.
References mln::util::site_pair< P >::pair_.
Referenced by mln::util::operator==().
template<typename P >
| const P & mln::util::site_pair< P >::second | ( | ) | const [inline] |
Return the second site.
References mln::util::site_pair< P >::pair_, and mln::util::ord_pair< T >::second().
Member Data Documentation
template<typename P>
util::ord_pair<P> mln::util::site_pair< P >::pair_ [private] |
