Commit 1cc37c7a authored by Thierry Geraud's avatar Thierry Geraud
Browse files

Renaming some concepts with more explicit and longer names.

	* mln/core/concept/piter.hh,
	* mln/core/concept/genpoint.hh,
	* mln/core/concept/psite.hh,
	* mln/core/concept/viter.hh,
	* mln/core/concept/doc/genpoint.hh,
	* mln/core/concept/doc/piter.hh,
	* mln/core/concept/doc/viter.hh,
	* mln/core/concept/doc/genpixel.hh,
	* mln/core/concept/genpixel.hh: Rename respectively as...
	* mln/core/concept/point_iterator.hh,
	* mln/core/concept/generalized_point.hh,
	* mln/core/concept/point_site.hh,
	* mln/core/concept/value_iterator.hh,
	* mln/core/concept/doc/generalized_point.hh,
	* mln/core/concept/doc/point_iterator.hh,
	* mln/core/concept/doc/value_iterator.hh,
	* mln/core/concept/doc/generalized_pixel.hh,
	* mln/core/concept/generalized_pixel.hh: ...these.

	* mln/convert/to_dpoint.hh,
	* mln/geom/pmin_pmax.hh,
	* mln/core/dpoints_piter.hh,
	* mln/core/psubset.hh,
	* mln/core/box.hh,
	* mln/core/psubset_piter.hh,
	* mln/core/rectangle2d.hh,
	* mln/core/box_piter.hh,
	* mln/core/window.hh,
	* mln/core/dpoints_pixter.hh,
	* mln/core/internal/image_adaptor.hh,
	* mln/core/internal/image_base.hh,
	* mln/core/internal/piter_adaptor.hh,
	* mln/core/pixel.hh,
	* mln/core/hline2d.hh,
	* mln/core/neighb.hh,
	* mln/core/concept/value_set.hh,
	* mln/core/concept/point.hh,
	* mln/core/concept/pixel_iterator.hh,
	* mln/core/concept/point_set.hh,
	* mln/core/concept/doc/image.hh,
	* mln/core/concept/doc/value_set.hh,
	* mln/core/concept/doc/pixel_iterator.hh,
	* mln/core/concept/doc/point_set.hh,
	* mln/core/concept/doc/window.hh,
	* mln/core/concept/doc/neighborhood.hh,
	* mln/core/vline2d.hh,
	* mln/level/approx/median.hh,
	* mln/value/lut_vec.hh,
	* mln/value/viter.hh,
	* mln/value/set.hh: Update.

	* TODO: Update.


git-svn-id: https://svn.lrde.epita.fr/svn/oln/trunk@1027 4aad255d-cdde-0310-9447-f3009e2ae8c0
parent 3f4396fc
2007-07-23 Thierry Geraud <thierry.geraud@lrde.epita.fr>
Renaming some concepts with more explicit and longer names.
* mln/core/concept/piter.hh,
* mln/core/concept/genpoint.hh,
* mln/core/concept/psite.hh,
* mln/core/concept/viter.hh,
* mln/core/concept/doc/genpoint.hh,
* mln/core/concept/doc/piter.hh,
* mln/core/concept/doc/viter.hh,
* mln/core/concept/doc/genpixel.hh,
* mln/core/concept/genpixel.hh: Rename respectively as...
* mln/core/concept/point_iterator.hh,
* mln/core/concept/generalized_point.hh,
* mln/core/concept/point_site.hh,
* mln/core/concept/value_iterator.hh,
* mln/core/concept/doc/generalized_point.hh,
* mln/core/concept/doc/point_iterator.hh,
* mln/core/concept/doc/value_iterator.hh,
* mln/core/concept/doc/generalized_pixel.hh,
* mln/core/concept/generalized_pixel.hh: ...these.
* mln/convert/to_dpoint.hh,
* mln/geom/pmin_pmax.hh,
* mln/core/dpoints_piter.hh,
* mln/core/psubset.hh,
* mln/core/box.hh,
* mln/core/psubset_piter.hh,
* mln/core/rectangle2d.hh,
* mln/core/box_piter.hh,
* mln/core/window.hh,
* mln/core/dpoints_pixter.hh,
* mln/core/internal/image_adaptor.hh,
* mln/core/internal/image_base.hh,
* mln/core/internal/piter_adaptor.hh,
* mln/core/pixel.hh,
* mln/core/hline2d.hh,
* mln/core/neighb.hh,
* mln/core/concept/value_set.hh,
* mln/core/concept/point.hh,
* mln/core/concept/pixel_iterator.hh,
* mln/core/concept/point_set.hh,
* mln/core/concept/doc/image.hh,
* mln/core/concept/doc/value_set.hh,
* mln/core/concept/doc/pixel_iterator.hh,
* mln/core/concept/doc/point_set.hh,
* mln/core/concept/doc/window.hh,
* mln/core/concept/doc/neighborhood.hh,
* mln/core/vline2d.hh,
* mln/level/approx/median.hh,
* mln/value/lut_vec.hh,
* mln/value/viter.hh,
* mln/value/set.hh: Update.
* TODO: Update.
2007-07-20 Thierry Geraud <thierry.geraud@lrde.epita.fr>
Handle low quantization and fast properties.
......
......@@ -25,17 +25,13 @@ image defined by f/pset
in Fast_Image: memcpy and memset-like methods (?)
.offset() into GenPixel
notion of low-quantization
vset and .values() in Image
built-in op objects -> reverse lhs/rhs
* renaming
GenPixel, GenPoint, Psite, Piter: longer name (?)
mlc into metal
point-wise material: pw::value_of, pw::constant, and pw::variable
kind-related: mln_value_kind(I) and mln_kind(V)
* clean-up
......@@ -52,3 +48,16 @@ sorting points w.r.t. their value (array of offsets, psites, points)
border::* and no-op versions if not fast image
arith::inplace_plus et al.
linear:: for convolutions
svn mv genpoint.hh generalized_point.hh
svn mv genpixel.hh generalized_pixel.hh
svn mv psite.hh point_site.hh
svn mv viter.hh value_iterator.hh
svn mv piter.hh point_iterator.hh
svn mv doc/genpoint.hh doc/generalized_point.hh
svn mv doc/genpixel.hh doc/generalized_pixel.hh
svn mv doc/viter.hh doc/value_iterator.hh
svn mv doc/piter.hh doc/point_iterator.hh
......@@ -33,7 +33,7 @@
* \brief Convertions to mln::Dpoint.
*/
# include <mln/core/concept/genpoint.hh>
# include <mln/core/concept/generalized_point.hh>
namespace mln
......@@ -44,13 +44,13 @@ namespace mln
/// Convert a generalized point \p p into a delta-point.
template <typename P>
mln_dpoint(P) to_dpoint(const GenPoint<P>& p);
mln_dpoint(P) to_dpoint(const Generalized_Point<P>& p);
# ifndef MLN_INCLUDE_ONLY
template <typename P>
mln_dpoint(P) to_dpoint(const GenPoint<P>& p_)
mln_dpoint(P) to_dpoint(const Generalized_Point<P>& p_)
{
const P& p = internal::force_exact<P>(p_);
mln_dpoint(P) tmp;
......
......@@ -54,7 +54,7 @@ namespace mln
struct box_ : public Box< box_<P> >,
public internal::box_impl_< P::dim, mln_coord(P), box_<P> >
{
/*! \brief Psite associated type.
/*! \brief Point_Site associated type.
*/
typedef P psite;
......@@ -62,11 +62,11 @@ namespace mln
*/
typedef P point;
/*! \brief Forward Piter associated type.
/*! \brief Forward Point_Iterator associated type.
*/
typedef box_fwd_piter_<P> fwd_piter;
/*! \brief Backward Piter associated type.
/*! \brief Backward Point_Iterator associated type.
*/
typedef box_bkd_piter_<P> bkd_piter;
......
......@@ -33,7 +33,7 @@
* \brief Definition of iterators on points of boxes.
*/
# include <mln/core/concept/piter.hh>
# include <mln/core/concept/point_iterator.hh>
# include <mln/core/concept/box.hh>
......@@ -47,14 +47,14 @@ namespace mln
* \see mln::box_
*/
template <typename P>
class box_fwd_piter_ : public Piter< box_fwd_piter_<P> >
class box_fwd_piter_ : public Point_Iterator< box_fwd_piter_<P> >
{
public:
/// Space dimension.
enum { dim = P::dim };
/// Psite associated type.
/// Point_Site associated type.
typedef P psite;
/// Point associated type.
......@@ -107,14 +107,14 @@ namespace mln
* \see mln::box_
*/
template <typename P>
class box_bkd_piter_ : public Piter< box_bkd_piter_<P> >
class box_bkd_piter_ : public Point_Iterator< box_bkd_piter_<P> >
{
public:
/// Space dimension.
enum { dim = P::dim };
/// Psite associated type.
/// Point_Site associated type.
typedef P psite;
/// Point associated type.
......
......@@ -28,8 +28,8 @@
#ifndef MLN_CORE_CONCEPT_DOC_GENPIXEL_HH
# define MLN_CORE_CONCEPT_DOC_GENPIXEL_HH
/*! \file mln/core/concept/doc/genpixel.hh
* \brief This file documents the concept of mln::GenPixel.
/*! \file mln/core/concept/doc/generalized_pixel.hh
* \brief This file documents the concept of mln::Generalized_Pixel.
*/
......@@ -39,12 +39,12 @@ namespace mln
namespace doc
{
/*! \brief Documentation class for mln::GenPixel.
/*! \brief Documentation class for mln::Generalized_Pixel.
*
* \see mln::GenPixel
* \see mln::Generalized_Pixel
*/
template <typename E>
struct GenPixel
struct Generalized_Pixel
{
/// Value associated type.
......@@ -70,7 +70,7 @@ namespace mln
value** address_() const;
protected:
GenPixel();
Generalized_Pixel();
};
} // end of namespace mln::doc
......
......@@ -25,8 +25,8 @@
// reasons why the executable file might be covered by the GNU General
// Public License.
/*! \file mln/core/concept/doc/genpoint.hh
* \brief This file documents the concept of mln::GenPoint.
/*! \file mln/core/concept/doc/generalized_point.hh
* \brief This file documents the concept of mln::Generalized_Point.
*/
namespace mln
......@@ -35,12 +35,12 @@ namespace mln
namespace doc
{
/*! \brief Documentation class for mln::GenPoint.
/*! \brief Documentation class for mln::Generalized_Point.
*
* \see mln::GenPoint
* \see mln::Generalized_Point
*/
template <typename E>
struct GenPoint
struct Generalized_Point
{
/*! \var dim
* \brief Dimension of the space.
......
......@@ -127,8 +127,8 @@ namespace mln
*/
typedef void point;
/*! \brief Psite associated type.
* \invariant This type has to derive from mln::Psite.
/*! \brief Point_Site associated type.
* \invariant This type has to derive from mln::Point_Site.
*/
typedef void psite;
......@@ -144,12 +144,12 @@ namespace mln
/*! \brief Forward point iterator associated type.
* \invariant This type has to derive from mln::Piter.
* \invariant This type has to derive from mln::Point_Iterator.
*/
typedef void fwd_piter;
/*! \brief Backward point iterator associated type.
* \invariant This type has to derive from mln::Piter.
* \invariant This type has to derive from mln::Point_Iterator.
*/
typedef void bkd_piter;
......
......@@ -42,17 +42,17 @@ namespace mln
template <typename E>
struct Neighborhood : public Object<E>
{
/*! \brief Piter type associated to this neighborhood to browse
/*! \brief Point_Iterator type associated to this neighborhood to browse
* neighbors.
*/
typedef void niter;
/*! \brief Piter type associated to this neighborhood to browse
/*! \brief Point_Iterator type associated to this neighborhood to browse
* neighbors in a forward way.
*/
typedef void fwd_niter;
/*! \brief Piter type associated to this neighborhood to browse
/*! \brief Point_Iterator type associated to this neighborhood to browse
* neighbors in a backward way.
*/
typedef void bkd_niter;
......
......@@ -41,7 +41,7 @@ namespace mln
*/
template <typename E>
struct Pixel_Iterator : public Iterator<E>,
public GenPixel<E>
public Generalized_Pixel<E>
{
/*! \brief Type returned by the read-write dereference operator.
*/
......
......@@ -25,8 +25,8 @@
// reasons why the executable file might be covered by the GNU General
// Public License.
/*! \file mln/core/concept/doc/piter.hh
* \brief This file documents the concept of mln::Piter.
/*! \file mln/core/concept/doc/point_iterator.hh
* \brief This file documents the concept of mln::Point_Iterator.
*/
namespace mln
......@@ -35,16 +35,16 @@ namespace mln
namespace doc
{
/*! \brief Documentation class for mln::Piter.
/*! \brief Documentation class for mln::Point_Iterator.
*
* \see mln::Piter
* \see mln::Point_Iterator
*/
template <typename E>
struct Piter : public Iterator<E>,
public GenPoint<E>
struct Point_Iterator : public Iterator<E>,
public Generalized_Point<E>
{
/*! \brief Psite associated type.
* \invariant This type has to derive from mln::Psite.
/*! \brief Point_Site associated type.
* \invariant This type has to derive from mln::Point_Site.
*/
typedef void psite;
......
......@@ -46,15 +46,15 @@ namespace mln
*/
typedef void point;
/*! \brief Psite associated type.
/*! \brief Point_Site associated type.
*/
typedef void psite;
/*! \brief Forward Piter associated type.
/*! \brief Forward Point_Iterator associated type.
*/
typedef void fwd_piter;
/*! \brief Backward Piter associated type.
/*! \brief Backward Point_Iterator associated type.
*/
typedef void bkd_piter;
......
......@@ -25,8 +25,8 @@
// reasons why the executable file might be covered by the GNU General
// Public License.
/*! \file mln/core/concept/doc/viter.hh
* \brief This file documents the concept of mln::Viter.
/*! \file mln/core/concept/doc/value_iterator.hh
* \brief This file documents the concept of mln::Value_Iterator.
*/
namespace mln
......@@ -35,12 +35,12 @@ namespace mln
namespace doc
{
/*! \brief Documentation class for mln::Viter.
/*! \brief Documentation class for mln::Value_Iterator.
*
* \see mln::Viter
* \see mln::Value_Iterator
*/
template <typename E>
struct Viter : public Iterator<E>
struct Value_Iterator : public Iterator<E>
{
/*! \brief Value associated type.
*/
......
......@@ -46,11 +46,11 @@ namespace mln
*/
typedef void value;
/*! \brief Forward Viter associated type.
/*! \brief Forward Value_Iterator associated type.
*/
typedef void fwd_viter;
/*! \brief Backward Viter associated type.
/*! \brief Backward Value_Iterator associated type.
*/
typedef void bkd_viter;
......
......@@ -45,17 +45,17 @@ namespace mln
template <typename E>
struct Window : public Object<E>
{
/*! \brief Piter type associated to this window to browse its
/*! \brief Point_Iterator type associated to this window to browse its
* points.
*/
typedef void qiter;
/*! \brief Piter type associated to this window to browse its
/*! \brief Point_Iterator type associated to this window to browse its
* points in a forward way.
*/
typedef void fwd_qiter;
/*! \brief Piter type associated to this window to browse its
/*! \brief Point_Iterator type associated to this window to browse its
* points in a backward way.
*/
typedef void bkd_qiter;
......
......@@ -28,7 +28,7 @@
#ifndef MLN_CORE_CONCEPT_GENPIXEL_HH
# define MLN_CORE_CONCEPT_GENPIXEL_HH
/*! \file mln/core/concept/genpixel.hh
/*! \file mln/core/concept/generalized_pixel.hh
*
* \brief Definition of the concept of mln::Genpixel.
*/
......@@ -40,21 +40,21 @@
namespace mln
{
// FIXME: \class GenPixel GenPixel.hh "mln/core/concept/doc/GenPixel.hh"
// FIXME: \class Generalized_Pixel Generalized_Pixel.hh "mln/core/concept/doc/Generalized_Pixel.hh"
/*! \brief Base class for implementation classes that are pixels or that
* have the behavior of pixels.
*
* "GenPixel" is "Generalized Pixel" for short.
* "Generalized_Pixel" is "Generalized Pixel" for short.
*
* \warning This class does \em not derive from mln::Object; it is
* for use as a parallel hierarchy.
*
* \see mln::doc::GenPixel for a complete documentation of this
* \see mln::doc::Generalized_Pixel for a complete documentation of this
* class contents.
*/
template <typename E>
struct GenPixel
struct Generalized_Pixel
{
/*
typedef value;
......@@ -64,14 +64,14 @@ namespace mln
value** address_() const;
*/
protected:
GenPixel();
Generalized_Pixel();
};
# ifndef MLN_INCLUDE_ONLY
template <typename E>
GenPixel<E>::GenPixel()
Generalized_Pixel<E>::Generalized_Pixel()
{
typedef mln_value(E) value;
typedef mln_rvalue(E) rvalue;
......
......@@ -28,8 +28,8 @@
#ifndef MLN_CORE_CONCEPT_GENPOINT_HH
# define MLN_CORE_CONCEPT_GENPOINT_HH
/*! \file mln/core/concept/genpoint.hh
* \brief Definition of the concept of mln::GenPoint.
/*! \file mln/core/concept/generalized_point.hh
* \brief Definition of the concept of mln::Generalized_Point.
*/
# include <mlc/equal.hh>
# include <mlc/same_point.hh>
......@@ -42,21 +42,21 @@
namespace mln
{
// FIXME: \class GenPoint genpoint.hh "mln/core/concept/doc/genpoint.hh"
// FIXME: \class Generalized_Point generalized_point.hh "mln/core/concept/doc/generalized_point.hh"
/*! \brief Base class for implementation classes that are points or that
* have the behavior of points.
*
* "GenPoint" is "Generalized Point" for short.
* "Generalized_Point" is "Generalized Point" for short.
*
* \warning This class does \em not derive from mln::Object; it is
* for use as a parallel hierarchy.
*
* \see mln::doc::GenPoint for a complete documentation of this
* \see mln::doc::Generalized_Point for a complete documentation of this
* class contents.
*/
template <typename E>
struct GenPoint
struct Generalized_Point
{
/*
......@@ -75,7 +75,7 @@ namespace mln
*/
protected:
GenPoint();
Generalized_Point();
};
......@@ -93,10 +93,10 @@ namespace mln
* \return True if both generalized points have the same
* coordinates, otherwise false.
*
* \relates mln::GenPoint
* \relates mln::Generalized_Point
*/
template <typename Pl, typename Pr>
bool operator==(const GenPoint<Pl>& lhs, const GenPoint<Pr>& rhs);
bool operator==(const Generalized_Point<Pl>& lhs, const Generalized_Point<Pr>& rhs);
/*! \brief Ordering "less than" comparison between a couple of generalized
......@@ -117,10 +117,10 @@ namespace mln
* \return True if \p lhs is before \p rhs in the sense of the
* coordinates lexicographic comparison, otherwise false.
*
* \relates mln::GenPoint
* \relates mln::Generalized_Point
*/
template <typename Pl, typename Pr>
bool operator<(const GenPoint<Pl>& lhs, const GenPoint<Pr>& rhs);
bool operator<(const Generalized_Point<Pl>& lhs, const Generalized_Point<Pr>& rhs);
/*! \brief Difference between a couple of generalized point \p lhs and \p
......@@ -142,11 +142,11 @@ namespace mln
* \return A delta-point (temporary object).
*
* \see mln::Dpoint
* \relates mln::GenPoint
* \relates mln::Generalized_Point
*/
template <typename Pl, typename Pr>
mln_dpoint(Pl)
operator-(const GenPoint<Pl>& lhs, const GenPoint<Pr>& rhs);
operator-(const Generalized_Point<Pl>& lhs, const Generalized_Point<Pr>& rhs);
/*! \brief Add a delta-point \p rhs to a generalized point \p lhs.
......@@ -160,14 +160,14 @@ namespace mln
* \return A point (temporary object).
*
* \see mln::Dpoint
* \relates mln::GenPoint
* \relates mln::Generalized_Point
*
* \todo Introduce the notion of "generalized dpoint" and
* add the more general extra operator+(GenPoint, GenDpoint).
* add the more general extra operator+(Generalized_Point, GenDpoint).
*/
template <typename P>
mln_point(P)
operator+(const GenPoint<P>& lhs, const mln_dpoint(P)& rhs);
operator+(const Generalized_Point<P>& lhs, const mln_dpoint(P)& rhs);
/*! \brief Substract a delta-point \p rhs to a generalized point \p lhs.
......@@ -181,11 +181,11 @@ namespace mln
* \return A point (temporary object).
*
* \see mln::Dpoint
* \relates mln::GenPoint
* \relates mln::Generalized_Point
*/
template <typename P>
mln_point(P)
operator-(const GenPoint<P>& lhs, const mln_dpoint(P)& rhs);
operator-(const Generalized_Point<P>& lhs, const mln_dpoint(P)& rhs);
/*! \brief Print a generalized point \p p into the output stream \p
......@@ -196,10 +196,10 @@ namespace mln
*
* \return The modified output stream \p ostr.
*
* \relates mln::GenPoint
* \relates mln::Generalized_Point
*/
template <typename P>
std::ostream& operator<<(std::ostream& ostr, const GenPoint<P>& p);
std::ostream& operator<<(std::ostream& ostr, const Generalized_Point<P>& p);
......@@ -207,7 +207,7 @@ namespace mln
template <typename E>
GenPoint<E>::GenPoint()
Generalized_Point<E>::Generalized_Point()
{
int dim = E::dim;
mln_invariant(dim > 0);
......@@ -223,7 +223,7 @@ namespace mln
template <typename Pl, typename Pr>
bool operator==(const GenPoint<Pl>& lhs, const GenPoint<Pr>& rhs)
bool operator==(const Generalized_Point<Pl>& lhs, const Generalized_Point<Pr>& rhs)
{
// FIXME: mlc::same_grid<Pl, Pr>::check();
const Pl& lhs_ = internal::force_exact<Pl>(lhs);
......@@ -236,7 +236,7 @@ namespace mln
}
template <typename Pl, typename Pr>
bool operator<(const GenPoint<Pl>& lhs, const GenPoint<Pr>& rhs)
bool operator<(const Generalized_Point<Pl>& lhs, const Generalized_Point<Pr>& rhs)
{
// FIXME: mlc::same_grid<Pl, Pr>::check();
const Pl& lhs_ = internal::force_exact<Pl>(lhs);
......@@ -252,7 +252,7 @@ namespace mln