mln::p_line2d Class Reference
[Basic types]

2D discrete line of points. More...

#include <p_line2d.hh>

Inherits mln::internal::site_set_base_< mln::point, mln::p_line2d >.

List of all members.

Public Types
typedef p_indexed_bkd_piter < self_ >	bkd_piter
	Backward Site_Iterator associated type.
typedef point2d	element
	Element associated type.
typedef p_indexed_fwd_piter < self_ >	fwd_piter
	Forward Site_Iterator associated type.
typedef p_indexed_fwd_piter < self_ >	piter
	Site_Iterator associated type.
typedef p_indexed_psite< self_ >	psite
	Psite associated type.
typedef const box2d &	q_box
	Box (qualified) associated type.
Public Member Functions
const box2d &	bbox () const
	Give the exact bounding box.
const point2d &	begin () const
	Give the point that begins the line.
const point2d &	end () const
	Give the point that ends the line.
bool	has (const util::index &i) const
	Test if index i belongs to this point set.
bool	has (const psite &p) const
	Test if p belongs to this point set.
bool	is_valid () const
	Test if this line is valid, i.e., initialized.
std::size_t	memory_size () const
	Return the size of this site set in memory.
unsigned	nsites () const
	Give the number of points.
const point2d &	operator[] (unsigned i) const
	Return the i-th point of the line.
	p_line2d (const point2d &beg, const point2d &end, bool is_end_excluded=false)
	Constructor from point beg to point end.
	p_line2d ()
	Constructor without argument.
const std::vector< point2d > &	std_vector () const
	Return the corresponding std::vector of points.
Related Functions
(Note that these are not member functions.)
template<typename Sl, typename Sr>
p_set< typename Sl::site >	diff (const Site_Set< Sl > &lhs, const Site_Set< Sr > &rhs)
	Set theoretic difference of lhs and rhs.
template<typename Sl, typename Sr>
p_set< typename Sl::site >	inter (const Site_Set< Sl > &lhs, const Site_Set< Sr > &rhs)
	Intersection between a couple of point sets.
template<typename Sl, typename Sr>
bool	operator< (const Site_Set< Sl > &lhs, const Site_Set< Sr > &rhs)
	Strict inclusion test between site sets lhs and rhs.
template<typename S>
std::ostream &	operator<< (std::ostream &ostr, const Site_Set< S > &set)
	Print a site set set into the output stream ostr.
template<typename Sl, typename Sr>
bool	operator<= (const Site_Set< Sl > &lhs, const Site_Set< Sr > &rhs)
	Inclusion test between site sets lhs and rhs.
template<typename Sl, typename Sr>
bool	operator== (const Site_Set< Sl > &lhs, const Site_Set< Sr > &rhs)
	Equality test between site sets lhs and rhs.
template<typename Sl, typename Sr>
p_set< typename Sl::site >	sym_diff (const Site_Set< Sl > &lhs, const Site_Set< Sr > &rhs)
	Set theoretic symmetrical difference of lhs and rhs.
template<typename Sl, typename Sr>
p_set< typename Sl::site >	uni (const Site_Set< Sl > &lhs, const Site_Set< Sr > &rhs)
	Union of a couple of point sets.
template<typename S>
p_set< typename S::site >	unique (const Site_Set< S > &s)
	Give the unique set of s.

---

Detailed Description

2D discrete line of points.

It is based on p_array.

---

Member Typedef Documentation

typedef p_indexed_bkd_piter<self_> mln::p_line2d::bkd_piter

Backward Site_Iterator associated type.

typedef point2d mln::p_line2d::element

Element associated type.

typedef p_indexed_fwd_piter<self_> mln::p_line2d::fwd_piter

Forward Site_Iterator associated type.

typedef p_indexed_fwd_piter<self_> mln::p_line2d::piter

Site_Iterator associated type.

typedef p_indexed_psite<self_> mln::p_line2d::psite

Psite associated type.

typedef const box2d& mln::p_line2d::q_box

Box (qualified) associated type.

---

Constructor & Destructor Documentation

mln::p_line2d::p_line2d

(

)

[inline]

Constructor without argument.

References is_valid().

mln::p_line2d::p_line2d	(	const point2d &	beg,
		const point2d &	end,
		bool	is_end_excluded = false
	)			[inline]

Constructor from point beg to point end.

References is_valid().

---

Member Function Documentation

const box2d & mln::p_line2d::bbox

(

)

const [inline]

Give the exact bounding box.

References is_valid().

const point2d & mln::p_line2d::begin

(

)

const [inline]

Give the point that begins the line.

References is_valid().

Referenced by mln::debug::draw_graph().

const point2d & mln::p_line2d::end

(

)

const [inline]

Give the point that ends the line.

References is_valid(), and nsites().

Referenced by mln::debug::draw_graph().

bool mln::p_line2d::has

(

const util::index &

i

)

const [inline]

Test if index i belongs to this point set.

References nsites().

bool mln::p_line2d::has

(

const psite &

p

)

const [inline]

Test if p belongs to this point set.

References mln::p_indexed_psite< S >::index().

bool mln::p_line2d::is_valid

(

)

const [inline]

Test if this line is valid, i.e., initialized.

References mln::implies().

Referenced by bbox(), begin(), end(), and p_line2d().

std::size_t mln::p_line2d::memory_size

(

)

const [inline]

Return the size of this site set in memory.

unsigned mln::p_line2d::nsites

(

)

const [inline]

Give the number of points.

Referenced by end(), has(), and operator[]().

const point2d & mln::p_line2d::operator[]

(

unsigned

i

)

const [inline]

Return the i-th point of the line.

References nsites().

const std::vector< point2d > & mln::p_line2d::std_vector

(

)

const [inline]

Return the corresponding std::vector of points.

---

Friends And Related Function Documentation

template<typename Sl, typename Sr>

p_set< typename Sl::site > diff	(	const Site_Set< Sl > &	lhs,
		const Site_Set< Sr > &	rhs
	)			[related, inherited]

Set theoretic difference of lhs and rhs.

template<typename Sl, typename Sr>

p_set< typename Sl::site > inter	(	const Site_Set< Sl > &	lhs,
		const Site_Set< Sr > &	rhs
	)			[related, inherited]

Intersection between a couple of point sets.

template<typename Sl, typename Sr>

bool operator<	(	const Site_Set< Sl > &	lhs,
		const Site_Set< Sr > &	rhs
	)			[related, inherited]

Strict inclusion test between site sets lhs and rhs.

Parameters:

[in]	lhs	A site set (strictly included?).
[in]	rhs	Another site set (includer?).

template<typename S>

std::ostream & operator<<	(	std::ostream &	ostr,
		const Site_Set< S > &	set
	)			[related, inherited]

Print a site set set into the output stream ostr.

Parameters:

[in,out]	ostr	An output stream.
[in]	set	A site set.

Returns:

The modified output stream ostr.

template<typename Sl, typename Sr>

bool operator<=	(	const Site_Set< Sl > &	lhs,
		const Site_Set< Sr > &	rhs
	)			[related, inherited]

Inclusion test between site sets lhs and rhs.

Parameters:

[in]	lhs	A site set (included?).
[in]	rhs	Another site set (includer?).

template<typename Sl, typename Sr>

bool operator==	(	const Site_Set< Sl > &	lhs,
		const Site_Set< Sr > &	rhs
	)			[related, inherited]

Equality test between site sets lhs and rhs.

Parameters:

[in]	lhs	A site set.
[in]	rhs	Another site set.

template<typename Sl, typename Sr>

p_set< typename Sl::site > sym_diff	(	const Site_Set< Sl > &	lhs,
		const Site_Set< Sr > &	rhs
	)			[related, inherited]

Set theoretic symmetrical difference of lhs and rhs.

template<typename Sl, typename Sr>

p_set< typename Sl::site > uni	(	const Site_Set< Sl > &	lhs,
		const Site_Set< Sr > &	rhs
	)			[related, inherited]

Union of a couple of point sets.

template<typename S>

p_set< typename S::site > unique

(

const Site_Set< S > &

s

)

[related, inherited]

Give the unique set of s.