oln::neighborhood1d Class Reference

Neighborhood 1 dimension. More...

#include <neighborhood1d.hh>

Inheritance diagram for oln::neighborhood1d:

Inheritance graph
[legend]
Collaboration diagram for oln::neighborhood1d:

Collaboration graph
[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
typedef struct_elt_traits<
self_type >::dpoint_type 
dpoint_type
 The associate image's type of dpoint (move point).

Public Member Functions

neighborhood1dadd (const dpoint_type &dp)
 Add a dpoint (move point) to the neighborhood.
neighborhood1dadd (coord col)
 Add a point by coordinates to the neighborhood.
 neighborhood1d ()
 Construct a neighborhood of 1 dimension.
 neighborhood1d (unsigned size)
 Construct a neighborhood of 1 dimension.
 neighborhood1d (unsigned n, const coord crd[])
 Construct a neighborhood of 1 dimension.

Static Public Member Functions

static std::string name ()
 Return the name of the type.

Protected Member Functions

coord delta_update_ (const dpoint_type &dp)
 Update delta.

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 >::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)

Definition at line 78 of file neighborhood1d.hh.

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< Exact >.

Definition at line 86 of file neighborhood1d.hh.


Constructor & Destructor Documentation

oln::neighborhood1d::neighborhood1d ( unsigned  size  )  [inline]

Construct a neighborhood of 1 dimension.

Definition at line 128 of file neighborhood1d.hh.

00128                                   : super_type(size)
00129     {}

oln::neighborhood1d::neighborhood1d ( unsigned  n,
const coord  crd[] 
) [inline]

Construct a neighborhood of 1 dimension.

Definition at line 136 of file neighborhood1d.hh.

References add().

00136                                                   : super_type()
00137     {
00138       for (unsigned i = 0; i < n; ++i)
00139         add(dpoint_type(crd[i]));
00140     }


Member Function Documentation

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

Add a dpoint (move point) to the neighborhood.

Add a new member to the neighborhood. This point must be of 1 dimension.

Definition at line 98 of file neighborhood1d.hh.

References oln::abstract::neighborhoodnd< Exact >::add_().

Referenced by add(), oln::mk_neighb_segment(), and neighborhood1d().

00099     {
00100       this->exact().add_(dp);
00101       return this->exact().add_(-dp);
00102     }

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

Add a point by coordinates to the neighborhood.

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().

00114     {
00115       return this->add(dpoint_type(col));
00116     }

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

Update delta.

Definition at line 160 of file neighborhood1d.hh.

References oln::abstract::window_base< Sup, Exact >::delta_.

00161     {
00162       delta_(abs(dp.col()));
00163       return delta_;
00164     }


The documentation for this class was generated from the following file:
Generated on Tue Feb 20 20:24:16 2007 for Olena by  doxygen 1.5.1