KDL::Vector2 Class Reference

#include <frames.hpp>

Public Member Functions
double	Norm () const
double	Normalize (double eps=epsilon)
	Normalizes this vector and returns it norm makes v a unitvector and returns the norm of v.
double &	operator() (int index)
	Access to elements, range checked when NDEBUG is not set, from 0..1.
double	operator() (int index) const
	Access to elements, range checked when NDEBUG is not set, from 0..1.
Vector2 &	operator+= (const Vector2 &arg)
Vector2 &	operator-= (const Vector2 &arg)
Vector2 &	operator= (const Vector2 &arg)
double &	operator[] (int index)
	Equivalent to double& operator()(int index).
double	operator[] (int index) const
	Equivalent to double operator()(int index) const.
void	ReverseSign ()
void	Set3DPlane (const Frame &F_someframe_XY, const Vector &v_someframe)
	projects v_someframe in the XY plane of F_someframe_XY, and sets *this to these values expressed wrt someframe.
void	Set3DXY (const Vector &v)
	projects v in its XY plane, and sets *this to these values
void	Set3DYZ (const Vector &v)
	projects v in its YZ plane, and sets *this to these values
void	Set3DZX (const Vector &v)
	projects v in its ZX plane, and sets *this to these values
	Vector2 (const Vector2 &arg)
	Vector2 (double x, double y)
	Vector2 ()
	Does not initialise to Zero().
void	x (double)
double	x () const
void	y (double)
double	y () const
Static Public Member Functions
static Vector2	Zero ()
Friends
bool	Equal (const Vector2 &a, const Vector2 &b, double eps=epsilon)
	do not use operator == because the definition of Equal(.,.
bool	operator!= (const Vector2 &a, const Vector2 &b)
	The literal inequality operator!=().
Vector2	operator* (const Vector2 &lhs, const Vector2 &rhs)
Vector2	operator* (double lhs, const Vector2 &rhs)
Vector2	operator* (const Vector2 &lhs, double rhs)
Vector2	operator+ (const Vector2 &lhs, const Vector2 &rhs)
Vector2	operator- (const Vector2 &arg)
Vector2	operator- (const Vector2 &lhs, const Vector2 &rhs)
Vector2	operator/ (const Vector2 &lhs, double rhs)
bool	operator== (const Vector2 &a, const Vector2 &b)
	The literal equality operator==(), also identical.
class	Rotation2
void	SetToZero (Vector2 &v)

Detailed Description

2D version of Vector

Definition at line 907 of file frames.hpp.

Constructor & Destructor Documentation

KDL::Vector2::Vector2 ( ) [inline]

Does not initialise to Zero().

Definition at line 912 of file frames.hpp.

Referenced by Normalize(), and Zero().

KDL::Vector2::Vector2	(	double	x,
		double	y
	)			`[inline]`

Definition at line 721 of file frames.inl.

KDL::Vector2::Vector2 ( const Vector2 & arg ) [inline]

Definition at line 715 of file frames.inl.

Member Function Documentation

double KDL::Vector2::Norm ( ) const

Returns:: the norm of the vector

Definition at line 84 of file frames.cpp.

References KDL::sqr(), and KDL::sqrt().

Referenced by Normalize().

double KDL::Vector2::Normalize ( double eps = epsilon )

Normalizes this vector and returns it norm makes v a unitvector and returns the norm of v.

if v is smaller than eps, Vector(1,0,0) is returned with norm 0. if this is not good, check the return value of this method.

Definition at line 95 of file frames.cpp.

References Norm(), and Vector2().

double & KDL::Vector2::operator() ( int index ) [inline]

Access to elements, range checked when NDEBUG is not set, from 0..1.

Definition at line 783 of file frames.inl.

References FRAMES_CHECKI.

double KDL::Vector2::operator() ( int index ) const [inline]

Access to elements, range checked when NDEBUG is not set, from 0..1.

Definition at line 778 of file frames.inl.

References FRAMES_CHECKI.

Referenced by operator[]().

Vector2 & KDL::Vector2::operator+= ( const Vector2 & arg ) [inline]

Definition at line 760 of file frames.inl.

Vector2 & KDL::Vector2::operator-= ( const Vector2 & arg ) [inline]

Definition at line 767 of file frames.inl.

Vector2 & KDL::Vector2::operator= ( const Vector2 & arg ) [inline]

Definition at line 727 of file frames.inl.

double& KDL::Vector2::operator[] ( int index ) [inline]

Equivalent to double& operator()(int index).

Definition at line 931 of file frames.hpp.

References operator()().

double KDL::Vector2::operator[] ( int index ) const [inline]

Equivalent to double operator()(int index) const.

Definition at line 925 of file frames.hpp.

References operator()().

void KDL::Vector2::ReverseSign ( ) [inline]

Definition at line 796 of file frames.inl.

Referenced by KDL::Frame2::SetInverse().

void KDL::Vector2::Set3DPlane	(	const Frame &	F_someframe_XY,
		const Vector &	v_someframe
	)			`[inline]`

projects v_someframe in the XY plane of F_someframe_XY, and sets *this to these values expressed wrt someframe.

Definition at line 828 of file frames.inl.

References KDL::Frame::Inverse().

void KDL::Vector2::Set3DXY ( const Vector & v ) [inline]

projects v in its XY plane, and sets *this to these values

Definition at line 809 of file frames.inl.

void KDL::Vector2::Set3DYZ ( const Vector & v ) [inline]

projects v in its YZ plane, and sets *this to these values

Definition at line 815 of file frames.inl.

void KDL::Vector2::Set3DZX ( const Vector & v ) [inline]

projects v in its ZX plane, and sets *this to these values

Definition at line 821 of file frames.inl.

void KDL::Vector2::x ( double _x ) [inline]

Definition at line 792 of file frames.inl.

double KDL::Vector2::x ( ) const [inline]

Definition at line 789 of file frames.inl.

void KDL::Vector2::y ( double _y ) [inline]

Definition at line 793 of file frames.inl.

double KDL::Vector2::y ( ) const [inline]

Definition at line 790 of file frames.inl.

Vector2 KDL::Vector2::Zero ( ) [inline, static]

Returns:: a zero 2D vector.

Definition at line 774 of file frames.inl.

References Vector2().

Referenced by KDL::Frame2::Frame2(), KDL::Frame2::SetIdentity(), and KDL::SetToZero().

Friends And Related Function Documentation

bool Equal	(	const Vector2 &	a,
		const Vector2 &	b,
		double	eps = `epsilon`
	)			`[friend]`

do not use operator == because the definition of Equal(.,.

) is slightly different. It compares whether the 2 arguments are equal in an eps-interval

bool operator!=	(	const Vector2 &	a,
		const Vector2 &	b
	)			`[friend]`

The literal inequality operator!=().

Vector2 operator*	(	const Vector2 &	lhs,
		const Vector2 &	rhs
	)			`[friend]`

Vector2 operator*	(	double	lhs,
		const Vector2 &	rhs
	)			`[friend]`

Vector2 operator*	(	const Vector2 &	lhs,
		double	rhs
	)			`[friend]`

Vector2 operator+	(	const Vector2 &	lhs,
		const Vector2 &	rhs
	)			`[friend]`

Vector2 operator- ( const Vector2 & arg ) [friend]

Vector2 operator-	(	const Vector2 &	lhs,
		const Vector2 &	rhs
	)			`[friend]`

Vector2 operator/	(	const Vector2 &	lhs,
		double	rhs
	)			`[friend]`

bool operator==	(	const Vector2 &	a,
		const Vector2 &	b
	)			`[friend]`

The literal equality operator==(), also identical.

friend class Rotation2 [friend]

Definition at line 992 of file frames.hpp.

void SetToZero ( Vector2 & v ) [friend]

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

KDL::Vector2 Class Reference

Public Member Functions

Static Public Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation