$extrastylesheet
Olena  User documentation 2.1
An Image Processing Platform
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
mln::Point< P > Struct Template Reference

#include <mln/core/concept/point.hh>

Public Member Functions

const P & to_point () const

Protected Member Functions

 Point ()

Public Types

typedef Point_Site< void > category
typedef P exact_t
typedef P point

Related Functions

(Note that these are not member functions.)

template<typename P , typename D >
P & operator+= (Point< P > &p, const Dpoint< D > &dp)
template<typename P , typename D >
P & operator-= (Point< P > &p, const Dpoint< D > &dp)
template<typename P , typename D >
P & operator/ (Point< P > &p, const value::Scalar< D > &dp)

Detailed Description

template<typename P>
struct mln::Point< P >

Base class for implementation of point classes.

A point is an element of a space.

For instance, mln::point2d is the type of elements defined on the discrete square grid of the 2D plane.

Definition at line 68 of file concept/point.hh.

Constructor & Destructor Documentation

template<typename P>
mln::Point< P >::Point ( )
protected

Member Function Documentation

template<typename P>
const P& mln::Point< P >::to_point ( ) const

It is a Point so it returns itself.

Friends And Related Function Documentation

template<typename P , typename D >
P & operator+= ( Point< P > &  p,
const Dpoint< D > &  dp 
)
related

Shift a point by a delta-point dp.

Parameters
[in,out]pThe targeted point.
[in]dpA delta-point.
Returns
A reference to the point p once translated by dp.
Precondition
The type of dp has to be compatible with the type of p.
template<typename P , typename D >
P & operator-= ( Point< P > &  p,
const Dpoint< D > &  dp 
)
related

Shift a point by the negate of a delta-point dp.

Parameters
[in,out]pThe targeted point.
[in]dpA delta-point.
Returns
A reference to the point p once translated by - dp.
Precondition
The type of dp has to be compatible with the type of p.
template<typename P , typename D >
P & operator/ ( Point< P > &  p,
const value::Scalar< D > &  dp 
)
related

Divise a point by a scalar s.

Parameters
[in,out]pThe targeted point.
[in]dpA scalar.
Returns
A reference to the point p once divised by s.

Member Typedef Documentation

typedef Point_Site<void> mln::Point_Site< P >::category
inherited

Definition at line 113 of file point_site.hh.

typedef P mln::Object< P >::exact_t
inherited

Definition at line 105 of file object.hh.

template<typename P>
typedef P mln::Point< P >::point

The associated point type is itself.

Definition at line 72 of file concept/point.hh.