mln::point< G, C > Struct Template Reference
Generic point class. More...
#include <point.hh>
Inheritance diagram for mln::point< G, C >:
Public Types | |
| enum | { dim = G::dim } |
| typedef C | coord |
| Coordinate associated type. | |
| typedef dpoint< G, C > | delta |
| Delta associated type. | |
| typedef dpoint< G, C > | dpsite |
| DPsite associated type. | |
| typedef G | grid |
| Grid associated type. | |
| typedef algebra::h_vec< G::dim, float > | h_vec |
| Algebra hexagonal vector (hvec) associated type. | |
| typedef algebra::vec< G::dim, float > | vec |
| Algebra vector (vec) associated type. | |
Public Member Functions | |
| C & | last_coord () |
| Read-write access to the last coordinate. | |
| const C & | last_coord () const |
| Read-only access to the last coordinate. | |
| point< G, C > & | operator+= (const delta &dp) |
Shifting by dp. | |
| point< G, C > & | operator-= (const delta &dp) |
Shifting by the inverse of dp. | |
| C & | operator[] (unsigned i) |
Read-write access to the i-th coordinate value. | |
| const C & | operator[] (unsigned i) const |
Read-only access to the i-th coordinate value. | |
| template<typename F > | |
| point (const Function_v2v< F > &f) | |
Constructor; coordinates are set by function f. | |
| template<typename C2 > | |
| point (const algebra::vec< dim, C2 > &v) | |
| Constructor from an algebra vector. | |
| point () | |
| Constructor without argument. | |
| void | set_all (C c) |
Set all coordinates to the value c. | |
| h_vec | to_h_vec () const |
| Transform to point in homogene coordinate system. | |
| vec | to_vec () const |
| Explicit conversion towards mln::algebra::vec. | |
| point (const literal::origin_t &) | |
| Constructors/assignments with literals. | |
| point (C ind) | |
Static Public Member Functions | |
| static const point< G, C > & | minus_infty () |
| Point with all coordinates set to the mininum value. | |
| static const point< G, C > & | plus_infty () |
| Point with all coordinates set to the maximum value. | |
Static Public Attributes | |
| static const point< G, C > | origin = all_to(0) |
| Origin point (all coordinates are 0). | |
Detailed Description
template<typename G, typename C>
struct mln::point< G, C >
Generic point class.
Parameters are n the dimension of the space and C the coordinate type in this space.
Member Typedef Documentation
template<typename G, typename C>
| typedef C mln::point< G, C >::coord |
Coordinate associated type.
template<typename G, typename C>
| typedef dpoint<G,C> mln::point< G, C >::delta |
Delta associated type.
template<typename G, typename C>
| typedef dpoint<G,C> mln::point< G, C >::dpsite |
DPsite associated type.
template<typename G, typename C>
| typedef G mln::point< G, C >::grid |
Grid associated type.
template<typename G, typename C>
| typedef algebra::h_vec<G::dim, float> mln::point< G, C >::h_vec |
Algebra hexagonal vector (hvec) associated type.
template<typename G, typename C>
| typedef algebra::vec<G::dim, float> mln::point< G, C >::vec |
Algebra vector (vec) associated type.
Member Enumeration Documentation
template<typename G, typename C>
| anonymous enum |
Constructor & Destructor Documentation
template<typename G , typename C >
| mln::point< G, C >::point | ( | ) | [inline] |
Constructor without argument.
template<typename G , typename C >
template<typename C2 >
| mln::point< G, C >::point | ( | const algebra::vec< dim, C2 > & | v | ) | [inline] |
template<typename G , typename C>
| mln::point< G, C >::point | ( | C | ind | ) | [inline, explicit] |
Constructors with different numbers of arguments (coordinates) w.r.t. the dimension.
template<typename G , typename C>
| mln::point< G, C >::point | ( | const literal::origin_t & | ) | [inline] |
Constructors/assignments with literals.
template<typename G , typename C >
template<typename F >
| mln::point< G, C >::point | ( | const Function_v2v< F > & | f | ) | [inline] |
Member Function Documentation
template<typename G , typename C >
| C & mln::point< G, C >::last_coord | ( | ) | [inline] |
template<typename G , typename C >
| const C & mln::point< G, C >::last_coord | ( | ) | const [inline] |
Read-only access to the last coordinate.
References mln::point< G, C >::dim.
Referenced by mln::p_run< P >::end(), mln::p_run< P >::operator[](), and mln::debug::put_word().
template<typename G , typename C >
| const point< G, C > & mln::point< G, C >::minus_infty | ( | ) | [inline, static] |
template<typename G , typename C >
| point< G, C > & mln::point< G, C >::operator+= | ( | const delta & | dp | ) | [inline] |
template<typename G , typename C >
| point< G, C > & mln::point< G, C >::operator-= | ( | const delta & | dp | ) | [inline] |
template<typename G , typename C >
| C & mln::point< G, C >::operator[] | ( | unsigned | i | ) | [inline] |
Read-write access to the i-th coordinate value.
- Parameters:
-
[in] i The coordinate index.
- Precondition:
i<dim
References mln::point< G, C >::dim.
template<typename G , typename C >
| const C & mln::point< G, C >::operator[] | ( | unsigned | i | ) | const [inline] |
Read-only access to the i-th coordinate value.
- Parameters:
-
[in] i The coordinate index.
- Precondition:
i<dim
References mln::point< G, C >::dim.
template<typename G , typename C >
| const point< G, C > & mln::point< G, C >::plus_infty | ( | ) | [inline, static] |
template<typename G , typename C>
| void mln::point< G, C >::set_all | ( | C | c | ) | [inline] |
Set all coordinates to the value c.
template<typename G , typename C >
| point< G, C >::h_vec mln::point< G, C >::to_h_vec | ( | ) | const [inline] |
template<typename G , typename C >
| point< G, C >::vec mln::point< G, C >::to_vec | ( | ) | const [inline] |
Explicit conversion towards mln::algebra::vec.
References mln::point< G, C >::dim.
Referenced by mln::io::magick::load(), mln::io::dicom::load(), and mln::io::magick::save().
Member Data Documentation
template<typename G, typename C>
const point< G, C > mln::point< G, C >::origin = all_to(0) [inline, static] |
Origin point (all coordinates are 0).
