slip::Point1d< CoordType > Class Template Reference

This is a point1d class, a specialized version of Point<CoordType,DIM> with DIM = 1. More...

#include <Point1d.hpp>

Inheritance diagram for slip::Point1d< CoordType >:

Public Types
typedef Point1d< CoordType >	self
typedef Point< CoordType, 1 >	base
typedef CoordType	value_type
typedef value_type *	pointer
typedef const value_type *	const_pointer
typedef value_type &	reference
typedef const value_type &	const_reference
typedef DPoint< CoordType, DIM >	dpoint_type
typedef std::random_access_iterator_tag	iterator_category

Public Member Functions
std::string	name () const
	Returns the name of the class. More...
self	operator- () const
	negate all the coordinates of a Point More...
std::size_t	dim () const
	Returns the dimension of the Point. More...
std::size_t	size () const
	Returns the dimension of the Point. More...
std::size_t	max_size () const
	Returns the maximal size of the Point. More...
bool	empty () const
	Returns true if dimension of the Point is 0. More...
const block< value_type, DIM > &	coord () const
	Return the coordinates of the Point. More...
block< value_type, DIM > &	coord ()
	Return the coordinates of the Point. More...
void	swap (self &other)
	Swaps two Point. More...
Constructors & Destructors
	Point1d ()
	Constructs a Point1d. More...
	Point1d (const CoordType &x1)
	Constructs a Point1d. More...
Element access operators
void	x1 (const CoordType &x)
	Accessor of the first coordinate of Point1d. More...
CoordType &	x1 ()
	Accessor/Mutator of the first coordinate of Point1d. More...
const CoordType &	x1 () const
	Accessor/Mutator of the first coordinate of Point1d. More...
Element access operators
reference	operator[] (const std::size_t i)
	Returns the i'th coordinate of the Point. More...
const_reference	operator[] (const std::size_t i) const
	Returns the i'th row of the Point. More...
Comparison operators
bool	operator== (const self &other) const
	compare two Point. More...
bool	operator!= (const self &other) const
	compare two Point. More...
Arithmetic operators
self	operator- (const dpoint_type &dp) const
	translate a point considering the deplacement a dp More...
dpoint_type	operator- (const self &other) const
	compute the difference between two points More...
self &	operator+= (const dpoint_type &dp)
	Assign a Point to this point plus a deplacement. More...
self	operator+ (const dpoint_type &dp) const
	translate a point considering the deplacement a dp More...
self &	operator-= (const dpoint_type &dp)
	Assign a Point to this point minus a deplacement. More...

Static Public Attributes
static const std::size_t	SIZE

Protected Attributes
block< value_type, DIM >	coord_
	The coordinates of the point are stored in this block. More...

Friends
class	boost::serialization::access

Detailed Description

template<typename CoordType>
class slip::Point1d< CoordType >

This is a point1d class, a specialized version of Point<CoordType,DIM> with DIM = 1.

Author

Benoit Tremblais <tremblais_AT_sic.univ-poitiers.fr>

Version

0.0.2

Date

2014/03/15

Since

1.0.0

Parameters

CoordType

Type of the coordinates of the Point1d

Definition at line 101 of file Point1d.hpp.

Member Typedef Documentation

template<typename CoordType>

typedef Point<CoordType,1> slip::Point1d< CoordType >::base

Definition at line 105 of file Point1d.hpp.

typedef const value_type* slip::Point< CoordType, DIM >::const_pointer

inherited

Definition at line 114 of file Point.hpp.

typedef const value_type& slip::Point< CoordType, DIM >::const_reference

inherited

Definition at line 116 of file Point.hpp.

typedef DPoint<CoordType,DIM> slip::Point< CoordType, DIM >::dpoint_type

inherited

Definition at line 119 of file Point.hpp.

typedef std::random_access_iterator_tag slip::Point< CoordType, DIM >::iterator_category

inherited

Definition at line 123 of file Point.hpp.

typedef value_type* slip::Point< CoordType, DIM >::pointer

inherited

Definition at line 113 of file Point.hpp.

typedef value_type& slip::Point< CoordType, DIM >::reference

inherited

Definition at line 115 of file Point.hpp.

template<typename CoordType>

typedef Point1d<CoordType> slip::Point1d< CoordType >::self

Definition at line 104 of file Point1d.hpp.

typedef CoordType slip::Point< CoordType, DIM >::value_type

inherited

Definition at line 112 of file Point.hpp.

Constructor & Destructor Documentation

template<typename CoordType >

slip::Point1d< CoordType >::Point1d ( )

inline

Constructs a Point1d.

Definition at line 195 of file Point1d.hpp.

template<typename CoordType >

slip::Point1d< CoordType >::Point1d ( const CoordType &  x1 )

inline

Constructs a Point1d.

Parameters

x1	first coordinate of the Point1d

Definition at line 202 of file Point1d.hpp.

Member Function Documentation

const block<value_type,DIM>& slip::Point< CoordType, DIM >::coord ( ) const

inherited

Return the coordinates of the Point.

block<value_type,DIM>& slip::Point< CoordType, DIM >::coord ( )

inherited

Return the coordinates of the Point.

std::size_t slip::Point< CoordType, DIM >::dim ( ) const

inherited

Returns the dimension of the Point.

Returns

the dimension (number of coordinates) of the Point

bool slip::Point< CoordType, DIM >::empty ( ) const

inherited

Returns true if dimension of the Point is 0.

Returns

true if the dimension of the Point is 0, false else

std::size_t slip::Point< CoordType, DIM >::max_size ( ) const

inherited

Returns the maximal size of the Point.

Returns

the dimension (number of coordinates) of the Point

template<typename CoordType >

std::string slip::Point1d< CoordType >::name ( ) const

inline

Returns the name of the class.

Definition at line 222 of file Point1d.hpp.

bool slip::Point< CoordType, DIM >::operator!= ( const self &  other ) const

inherited

compare two Point.

Parameters

other

Point to compare

Returns

true if the two point don't have the same coordinates

self slip::Point< CoordType, DIM >::operator+ ( const dpoint_type &  dp ) const

inherited

translate a point considering the deplacement a dp

Parameters

dp	deplacement

Returns

self& slip::Point< CoordType, DIM >::operator+= ( const dpoint_type &  dp )

inherited

Assign a Point to this point plus a deplacement.

Parameters

dp	deplacement

Returns

self slip::Point< CoordType, DIM >::operator- ( ) const

inherited

negate all the coordinates of a Point

Precondition

CoordType must be a "signed" type

Returns

a Point with negate coordinates

self slip::Point< CoordType, DIM >::operator- ( const dpoint_type &  dp ) const

inherited

translate a point considering the deplacement a dp

Parameters

dp	deplacement

Returns

dpoint_type slip::Point< CoordType, DIM >::operator- ( const self &  other ) const

inherited

compute the difference between two points

Parameters

other

Point

Returns

the deplacement between the two points

self& slip::Point< CoordType, DIM >::operator-= ( const dpoint_type &  dp )

inherited

Assign a Point to this point minus a deplacement.

Parameters

dp	deplacement

Returns

bool slip::Point< CoordType, DIM >::operator== ( const self &  other ) const

inherited

compare two Point.

Parameters

other

Point to compare

Returns

true if the two point have the same coordinates

reference slip::Point< CoordType, DIM >::operator[] ( const std::size_t  i )

inherited

Returns the i'th coordinate of the Point.

Parameters

i	index of the coordinate to return

Returns

value of the i'th row of the Point.

Precondition

0 <= i < dim

const_reference slip::Point< CoordType, DIM >::operator[] ( const std::size_t  i ) const

inherited

Returns the i'th row of the Point.

Parameters

i	index of the coordinate to return

Returns

value of the i'th row of the Point

Precondition

0 <= i < dim

std::size_t slip::Point< CoordType, DIM >::size ( ) const

inherited

Returns the dimension of the Point.

Returns

the dimension (number of coordinates) of the Point

void slip::Point< CoordType, DIM >::swap ( self &  other )

inherited

Swaps two Point.

Parameters

other

Point to swap with

template<typename CoordType >

void slip::Point1d< CoordType >::x1 ( const CoordType &  x )

inline

Accessor of the first coordinate of Point1d.

Parameters

x	the first coordinate of the Point1d

Definition at line 217 of file Point1d.hpp.

template<typename CoordType >

CoordType & slip::Point1d< CoordType >::x1 ( )

inline

Accessor/Mutator of the first coordinate of Point1d.

Returns

reference to the first coordinate of the Point1d

Definition at line 209 of file Point1d.hpp.

template<typename CoordType >

const CoordType & slip::Point1d< CoordType >::x1 ( ) const

inline

Accessor/Mutator of the first coordinate of Point1d.

Returns

reference to the first coordinate of the Point1d

Definition at line 213 of file Point1d.hpp.

Friends And Related Function Documentation

template<typename CoordType>

friend class boost::serialization::access

friend

Definition at line 154 of file Point1d.hpp.

Member Data Documentation

block<value_type,DIM> slip::Point< CoordType, DIM >::coord_

protectedinherited

The coordinates of the point are stored in this block.

Definition at line 347 of file Point.hpp.

const std::size_t slip::Point< CoordType, DIM >::SIZE

staticinherited

Definition at line 125 of file Point.hpp.

---

The documentation for this class was generated from the following file:

• src/Container/Point1d.hpp