nc::coordinates Namespace Reference

Namespaces
namespace	reference_frames
namespace	transforms

Data Structures
class	Cartesian
	Cartensian coordinates. More...
class	Euler
	Euler. More...
class	Orientation
	Orientation. More...

Functions
double	angle (const Cartesian &vec1, const Cartesian &vec2) noexcept
	angle between the two vectors
Cartesian	cross (const Cartesian &vec1, const Cartesian &vec2) noexcept
	Vector cross product.
double	norm (const Cartesian &vec) noexcept
	Vector norm.
Cartesian	normalize (const Cartesian &vec) noexcept
	normalize the input vector
double	operator* (const Cartesian &lhs, const Cartesian &rhs) noexcept
	Dot product of two cartesian points.
Cartesian	operator* (const Cartesian &vec, double scalar) noexcept
	Vector scalar multiplication.
Cartesian	operator* (double scalar, const Cartesian &vec) noexcept
	Vector scalar multiplication.
Cartesian	operator+ (const Cartesian &lhs, const Cartesian &rhs) noexcept
	Addition of two cartesian points.
Cartesian	operator- (const Cartesian &lhs, const Cartesian &rhs) noexcept
	Subtraction of two cartesian points.
Cartesian	operator/ (const Cartesian &vec, double denominator) noexcept
	Scalar Division a cartesian point.
std::ostream &	operator<< (std::ostream &os, const Cartesian &vec)
	Stream operator.
std::ostream &	operator<< (std::ostream &os, const Euler &Euler)
	Stream operator.
std::ostream &	operator<< (std::ostream &os, const Orientation &orientation)
	Stream operator.

Function Documentation

angle()

double nc::coordinates::angle ( const Cartesian & vec1, const Cartesian & vec2 )

inlinenodiscardnoexcept

angle between the two vectors

Parameters

vec1	cartesian vector
vec2	cartesian vector

Returns

unit vector in x direction

cross()

Cartesian nc::coordinates::cross ( const Cartesian & vec1, const Cartesian & vec2 )

inlinenodiscardnoexcept

Vector cross product.

Parameters

vec1	cartesian vector
vec2	cartesian vector

Returns

: the vector cross product

norm()

double nc::coordinates::norm ( const Cartesian & vec )

inlinenodiscardnoexcept

Vector norm.

Parameters

vec	the cartesian vector

Returns

: the vector norm

normalize()

Cartesian nc::coordinates::normalize ( const Cartesian & vec )

inlinenodiscardnoexcept

normalize the input vector

Parameters

vec	the cartesian vector

Returns

: normalized vector

operator*() [1/3]

double nc::coordinates::operator* ( const Cartesian & lhs, const Cartesian & rhs )

inlinenodiscardnoexcept

Dot product of two cartesian points.

Parameters

lhs	the left hand side object
rhs	the right hand side object

operator*() [2/3]

Cartesian nc::coordinates::operator* ( const Cartesian & vec, double scalar )

inlinenodiscardnoexcept

Vector scalar multiplication.

Parameters

vec	the cartesian vector
scalar	the the scalar value

operator*() [3/3]

Cartesian nc::coordinates::operator* ( double scalar, const Cartesian & vec )

inlinenodiscardnoexcept

Vector scalar multiplication.

Parameters

scalar	the the scalar value
vec	the cartesian vector

operator+()

Cartesian nc::coordinates::operator+ ( const Cartesian & lhs, const Cartesian & rhs )

inlinenodiscardnoexcept

Addition of two cartesian points.

Parameters

lhs	the left hand side object
rhs	the right hand side object

operator-()

Cartesian nc::coordinates::operator- ( const Cartesian & lhs, const Cartesian & rhs )

inlinenodiscardnoexcept

Subtraction of two cartesian points.

Parameters

lhs	the left hand side object
rhs	the right hand side object

operator/()

Cartesian nc::coordinates::operator/ ( const Cartesian & vec, double denominator )

inlinenodiscardnoexcept

Scalar Division a cartesian point.

Parameters

vec	the cartesian vector
denominator	the the scalar value

operator<<() [1/3]

std::ostream & nc::coordinates::operator<< ( std::ostream & os, const Cartesian & vec )

inline

Stream operator.

Parameters

os	the output stream
vec	the cartesian vector

operator<<() [2/3]

std::ostream & nc::coordinates::operator<< ( std::ostream & os, const Euler & Euler )

inline

Stream operator.

Parameters

os	the output stream
Euler	the euler angles

operator<<() [3/3]

std::ostream & nc::coordinates::operator<< ( std::ostream & os, const Orientation & orientation )

inline

Stream operator.

Parameters

os	the output stream
orientation	the roll/pitch/yaw angles