Milena (Olena)  User documentation 2.0a Id
 All Classes Namespaces Functions Variables Typedefs Enumerator Groups Pages
mln::Point< P > Struct Template Reference

Base class for implementation of point classes. More...

#include <point.hh>

Inherits mln::Point_Site< P >.

Public Types

typedef P point
 The associated point type is itself.
 

Public Member Functions

const P & to_point () const
 It is a Point so it returns itself.
 

Related Functions

(Note that these are not member functions.)

template<typename P , typename D >
P & operator+= (Point< P > &p, const Dpoint< D > &dp)
 Shift a point by a delta-point dp.
 
template<typename P , typename D >
P & operator-= (Point< P > &p, const Dpoint< D > &dp)
 Shift a point by the negate of a delta-point dp.
 
template<typename P , typename D >
P & operator/ (Point< P > &p, const value::Scalar< D > &dp)
 Divise a point by a scalar s.
 

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 62 of file concept/point.hh.

Member Typedef Documentation

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

The associated point type is itself.

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

Member Function Documentation

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

It is a Point so it returns itself.

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

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.

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

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.

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

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.

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