$search

KDL::Vector2 Class Reference

2D version of Vector More...

#include <frames.hpp>

List of all members.

Public Member Functions

double Norm () const
double Normalize (double eps=epsilon)
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.
Vector2operator+= (const Vector2 &arg)
Vector2operator-= (const Vector2 &arg)
Vector2operator= (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)
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 ()

Private Attributes

double data [2]

Friends

bool Equal (const Vector2 &a, const Vector2 &b, double eps=epsilon)
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 950 of file frames.hpp.


Constructor & Destructor Documentation

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

Does not initialise to Zero().

Definition at line 955 of file frames.hpp.

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

Definition at line 727 of file frames.cpp.

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

Definition at line 721 of file frames.cpp.


Member Function Documentation

double KDL::Vector2::Norm (  )  const
Returns:
the norm of the vector

Definition at line 87 of file frames.cpp.

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 98 of file frames.cpp.

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

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

Definition at line 789 of file frames.cpp.

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

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

Definition at line 784 of file frames.cpp.

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

Definition at line 766 of file frames.cpp.

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

Definition at line 773 of file frames.cpp.

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

Definition at line 733 of file frames.cpp.

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

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

Definition at line 974 of file frames.hpp.

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

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

Definition at line 968 of file frames.hpp.

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

Definition at line 802 of file frames.cpp.

IMETHOD 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 834 of file frames.cpp.

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

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

Definition at line 815 of file frames.cpp.

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

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

Definition at line 821 of file frames.cpp.

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

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

Definition at line 827 of file frames.cpp.

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

Definition at line 798 of file frames.cpp.

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

Definition at line 795 of file frames.cpp.

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

Definition at line 799 of file frames.cpp.

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

Definition at line 796 of file frames.cpp.

IMETHOD Vector2 KDL::Vector2::Zero (  )  [inline, static]
Returns:
a zero 2D vector.

Definition at line 780 of file frames.cpp.


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

Definition at line 1048 of file frames.cpp.

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

The literal inequality operator!=().

Definition at line 1334 of file frames.cpp.

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

Definition at line 756 of file frames.cpp.

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

Definition at line 751 of file frames.cpp.

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

Definition at line 741 of file frames.cpp.

Vector2 operator- ( const Vector2 arg  )  [friend]

Definition at line 809 of file frames.cpp.

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

Definition at line 746 of file frames.cpp.

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

Definition at line 761 of file frames.cpp.

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

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

Definition at line 1325 of file frames.cpp.

friend class Rotation2 [friend]

Definition at line 1035 of file frames.hpp.

void SetToZero ( Vector2 v  )  [friend]

Definition at line 1074 of file frames.cpp.


Member Data Documentation

double KDL::Vector2::data[2] [private]

Definition at line 952 of file frames.hpp.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines


orocos_kdl
Author(s): Ruben Smits, Erwin Aertbelien, Orocos Developers
autogenerated on Fri Mar 1 16:20:17 2013