mln::util::site_pair< P > Class Template Reference [Utilities]

A pair of sites. More...

#include <site_pair.hh>

Inheritance diagram for mln::util::site_pair< P >:

List of all members.

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.

Definition at line 52 of file site_pair.hh.

---

Member Typedef Documentation

typedef Object<void> mln::Object< site_pair< P > >::category [inherited]

Definition at line 174 of file object.hh.

template<typename P>

typedef P ::coord mln::util::site_pair< P >::coord

Definition at line 57 of file site_pair.hh.

typedef site_pair< P > mln::Object< site_pair< P > >::exact_t [inherited]

Definition at line 173 of file object.hh.

---

Constructor & Destructor Documentation

template<typename P >

mln::util::site_pair< P >::site_pair

(

)

Definition at line 129 of file site_pair.hh.

template<typename P >

mln::util::site_pair< P >::site_pair	(	const P &	first,
		const P &	second
	)

Definition at line 134 of file site_pair.hh.

---

Member Function Documentation

template<typename P >

const P & mln::util::site_pair< P >::first

(

)

const [inline]

Return the first site.

Definition at line 142 of file site_pair.hh.

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.

Definition at line 158 of file site_pair.hh.

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.

Definition at line 150 of file site_pair.hh.

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]

Definition at line 71 of file site_pair.hh.

Referenced by mln::util::site_pair< P >::first(), mln::util::site_pair< P >::pair(), and mln::util::site_pair< P >::second().