oln::neighborhood1d Class Reference

Neighborhood 1 dimension. More...

#include <neighborhood1d.hh>

Inheritance diagram for oln::neighborhood1d:

[legend]Collaboration diagram for oln::neighborhood1d:

[legend]List of all members.

Public Types
typedef abstract::neighborhoodnd< neighborhood1d >	super_type
	Super type.
typedef neighborhood1d	self_type
	Self type.
typedef struct_elt_traits< self_type >::iter_type	iter_type
	The associate image's type of iterator (move point).
typedef struct_elt_traits< self_type >::neighb_type	neighb_type
	Set the neighborhood type.
typedef struct_elt_traits< self_type >::dpoint_type	dpoint_type
	The associate image's type of dpoint (move point).
Public Member Functions
neighborhood1d &	add (const dpoint_type &dp)
	Add a dpoint (move point) to the neighborhood. dp The new point.
neighborhood1d &	add (coord col)
	Add a point by coordinates to the neighborhood. col The coordinate of the new point (1 dimension).
	neighborhood1d ()
	Construct a neighborhood of 1 dimension.
	neighborhood1d (unsigned size)
	Construct a neighborhood of 1 dimension. size Reserve 'size' elements for the neighborhood.
	neighborhood1d (unsigned n, const coord crd[])
	Construct a neighborhood of 1 dimension. n Add 'n' elements to the neighborhood. crd Coordinates of the 'n' elements.
Static Public Member Functions
std::string	name ()
	Return the name of the type.
Protected Member Functions
coord	delta_update_ (const dpoint_type &dp)
	Update delta. dp a move point.
Friends
class	abstract::window_base< abstract::neighborhood< neighborhood1d >, neighborhood1d >

---

Detailed Description

Neighborhood 1 dimension.

It looks like structuring elements but here, when you add an element, you add its opposite. Points (dpoint) have 1 dimension.

Definition at line 64 of file neighborhood1d.hh.

---

Member Typedef Documentation

typedef struct_elt_traits< self_type >::dpoint_type oln::neighborhood1d::dpoint_type

The associate image's type of dpoint (move point). Warning: Prefer the macros oln_dpoint_type(Pointable) and oln_dpoint_type_(Pointable) (the same without the 'typename' keyword) Reimplemented from oln::abstract::neighborhoodnd< neighborhood1d >. Definition at line 86 of file neighborhood1d.hh. Referenced by add(), and neighborhood1d().

typedef struct_elt_traits< self_type >::iter_type oln::neighborhood1d::iter_type

The associate image's type of iterator (move point). Warning: Prefer the macros oln_iter_type(Pointable) and oln_iter_type_(Pointable) (the same without the 'typename' keyword) Reimplemented from oln::abstract::neighborhood< neighborhood1d >. Definition at line 78 of file neighborhood1d.hh.

---

Member Function Documentation

neighborhood1d& oln::neighborhood1d::add (  coord  col  )  [inline]

Add a point by coordinates to the neighborhood. col The coordinate of the new point (1 dimension). Add a new member by its coordinates to the neighborhood. The coordinates are only the column number because the neighborhood has 1 dimension. Definition at line 113 of file neighborhood1d.hh. References add(), oln::coord, and dpoint_type. { return this->add(dpoint_type(col)); }

neighborhood1d& oln::neighborhood1d::add (  const dpoint_type &  dp  )  [inline]

Add a dpoint (move point) to the neighborhood. dp The new point. Add a new member to the neighborhood. This point must be of 1 dimension. Definition at line 98 of file neighborhood1d.hh. Referenced by add(), oln::mk_neighb_segment(), and neighborhood1d(). { this->exact().add_(dp); return this->exact().add_(-dp); }

coord oln::neighborhood1d::delta_update_ (  const dpoint_type &  dp  )  [inline, protected]

Update delta. dp a move point. Returns: Delta. If the point is the biggest element of the neighborhood, then this point is assigned to delta. Definition at line 160 of file neighborhood1d.hh. References oln::abstract::window_base< neighborhood< neighborhood1d >, neighborhood1d >::delta_. { delta_(abs(dp.col())); return delta_; }

---

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

• neighborhood1d.hh

---