oln::abstract::image_with_dim< 1, Exact > Class Template Reference

The specialized version for image1d. More...

#include <image_with_dim.hh>

Inheritance diagram for oln::abstract::image_with_dim< 1, Exact >:

Inheritance graph
[legend]
Collaboration diagram for oln::abstract::image_with_dim< 1, Exact >:

Collaboration graph
[legend]
List of all members.

Public Types

typedef image_traits< Exact
>::point_type 
point_type
typedef image_traits< Exact
>::point_type 
dpoint_type
typedef image_traits< Exact
>::iter_type 
iter_type
typedef image_traits< Exact
>::fwd_iter_type 
fwd_iter_type
typedef image_traits< Exact
>::bkd_iter_type 
bkd_iter_type
typedef image_traits< Exact
>::value_type 
value_type
typedef image_traits< Exact
>::size_type 
size_type
typedef image< Exact > super_type
typedef image_with_dim<
1, Exact > 
self_type
typedef Exact exact_type

Public Member Functions

coord ncols () const
 Return the number of columns in the current image.

const value_type operator() (coord col) const
 Return the value stored at col coordinate in the current image.

value_typeoperator() (coord col)
 Return a reference to the value stored at col coordinate in the current image.

bool hold (coord col) const
 Test if a point belongs to the current image.

exact_type & operator= (self_type rhs)
 Perform a shallow copy from rhs to the current image, the points are not duplicated but shared between the two images.

bool hold (const abstract::point< point_type > &p) const
 Test if the point p belong to the image.


Static Public Member Functions

std::string name ()

Protected Member Functions

size_t npoints_ () const
 Return the total number of points in the current image.

 image_with_dim ()

Friends

class image< exact_type >

Detailed Description

template<class Exact>
class oln::abstract::image_with_dim< 1, Exact >

The specialized version for image1d.

Definition at line 156 of file image_with_dim.hh.


Member Typedef Documentation

template<class Exact>
typedef image_traits<Exact>::bkd_iter_type oln::abstract::image_with_dim< 1, Exact >::bkd_iter_type
 

Backward iterator type.

Reimplemented from oln::abstract::image< Exact >.

Definition at line 180 of file image_with_dim.hh.

template<class Exact>
typedef image_traits<Exact>::point_type oln::abstract::image_with_dim< 1, Exact >::dpoint_type
 

Prefer the macro oln_dpoint_type(I) to retrieve the dpoint_type of an image.

See also:
oln::dpoint1d

Reimplemented from oln::abstract::image< Exact >.

Definition at line 166 of file image_with_dim.hh.

template<class Exact>
typedef image_traits<Exact>::fwd_iter_type oln::abstract::image_with_dim< 1, Exact >::fwd_iter_type
 

Forward iterator type.

Reimplemented from oln::abstract::image< Exact >.

Definition at line 178 of file image_with_dim.hh.

template<class Exact>
typedef image_traits<Exact>::iter_type oln::abstract::image_with_dim< 1, Exact >::iter_type
 

Prefer the macro oln_iter_type(I) to retrieve the iter_type of an image.

See also:
iter1d

Reimplemented from oln::abstract::image< Exact >.

Definition at line 172 of file image_with_dim.hh.

template<class Exact>
typedef image_traits<Exact>::point_type oln::abstract::image_with_dim< 1, Exact >::point_type
 

Prefer the macro oln_point_type(I) to retrieve the point_type of an image.

See also:
oln::point1d

Reimplemented from oln::abstract::image< Exact >.

Definition at line 160 of file image_with_dim.hh.

template<class Exact>
typedef image_traits<Exact>::size_type oln::abstract::image_with_dim< 1, Exact >::size_type
 

Indicate how the image size is handled.

See also:
oln::image1d_size

Reimplemented from oln::abstract::image< Exact >.

Definition at line 186 of file image_with_dim.hh.

template<class Exact>
typedef image_traits<Exact>::value_type oln::abstract::image_with_dim< 1, Exact >::value_type
 

Prefer the macro oln_value_type(I) to retrieve the value_type of an image.

Reimplemented from oln::abstract::image< Exact >.

Definition at line 182 of file image_with_dim.hh.


Member Function Documentation

template<class Exact>
bool oln::abstract::image< Exact >::hold const abstract::point< point_type > &  p  )  const [inline]
 

Test if the point p belong to the image.

Returns:
True if p belong to the image, false otherwise.

Definition at line 173 of file core/abstract/image.hh.

00174       {
00175         assertion(has_impl());
00176         return this->exact().impl()->hold(p.exact());
00177       }

template<class Exact>
bool oln::abstract::image_with_dim< 1, Exact >::hold coord  col  )  const [inline]
 

Test if a point belongs to the current image.

  • col Column coordinate of the point.
Returns:
True if the point belongs to the image, false otherwise.

Definition at line 236 of file image_with_dim.hh.

References oln::coord.

00237       {
00238         return hold(point_type(col));
00239       }

template<class Exact>
exact_type& oln::abstract::image_with_dim< 1, Exact >::operator= self_type  rhs  )  [inline]
 

Perform a shallow copy from rhs to the current image, the points are not duplicated but shared between the two images.

See also:
image::clone()

Reimplemented from oln::abstract::image< Exact >.

Definition at line 249 of file image_with_dim.hh.

00250       {
00251         return this->exact().assign(rhs.exact());
00252       }


The documentation for this class was generated from the following file:
Generated on Thu Apr 15 20:14:48 2004 for Olena by doxygen 1.3.6-20040222