oln::window1d Class Reference

Window 1 dimension. More...

#include <window1d.hh>

Inheritance diagram for oln::window1d:

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

Collaboration graph
[legend]
List of all members.

Public Types

typedef abstract::windownd<
window1d
super_type
 The super type.
typedef window1d self_type
 The self type.
typedef struct_elt_traits<
self_type >::iter_type 
iter_type
 The associate image's type of iterator.
typedef struct_elt_traits<
self_type >::neighb_type 
neighb_type
 Type of neighbor.
typedef struct_elt_traits<
self_type >::dpoint_type 
dpoint_type
 The associate image's type of dpoint (move point).

Public Member Functions

window1dadd (const dpoint_type &dp)
 Add a dpoint (move point) to the window.
window1dadd (coord col)
 Add a point by coordinates to the window.
 window1d ()
 Construct a window of 1 dimension.
 window1d (unsigned size)
 Construct a window of 1 dimension.
 window1d (unsigned n, const coord crd[])
 Construct a window of 1 dimension from several points.

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::window< window1d >, window1d >

Detailed Description

Window 1 dimension.

A window is a set of points. This class defines how to deal with. These points have 1 dimension.

Definition at line 63 of file window1d.hh.


Member Typedef Documentation

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

The associate image's type of iterator.

Warning:
Prefer the macros oln_iter_type(Iterable) and oln_iter_type_(Iterable) (the same without the 'typename' keyword)

Definition at line 77 of file window1d.hh.

typedef struct_elt_traits< self_type >::dpoint_type oln::window1d::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::windownd< Exact >.

Definition at line 87 of file window1d.hh.


Constructor & Destructor Documentation

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

Construct a window of 1 dimension.

Definition at line 128 of file window1d.hh.

00128                             : super_type(size)
00129     {}

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

Construct a window of 1 dimension from several points.

Definition at line 136 of file window1d.hh.

References add().

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


Member Function Documentation

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

Add a dpoint (move point) to the window.

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

Definition at line 99 of file window1d.hh.

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

Referenced by add(), oln::mk_win_segment(), oln::io::internal::read(), and window1d().

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

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

Add a point by coordinates to the window.

Add a new member by its coordinates to the window. The coordinates are only the column number because the window is of 1 dimension.

Definition at line 113 of file window1d.hh.

References add().

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

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

Update delta.

Definition at line 160 of file window1d.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:22 2007 for Olena by  doxygen 1.5.1