NumCpp  2.12.1
A Templatized Header Only C++ Implementation of the Python NumPy Library
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 More...
 
Cartesian cross (const Cartesian &vec1, const Cartesian &vec2) noexcept
 Vector cross product. More...
 
double norm (const Cartesian &vec) noexcept
 Vector norm. More...
 
Cartesian normalize (const Cartesian &vec) noexcept
 normalize the input vector More...
 
double operator* (const Cartesian &lhs, const Cartesian &rhs) noexcept
 Dot product of two cartesian points. More...
 
Cartesian operator* (const Cartesian &vec, double scalar) noexcept
 Vector scalar multiplication. More...
 
Cartesian operator* (double scalar, const Cartesian &vec) noexcept
 Vector scalar multiplication. More...
 
Cartesian operator+ (const Cartesian &lhs, const Cartesian &rhs) noexcept
 Addition of two cartesian points. More...
 
Cartesian operator- (const Cartesian &lhs, const Cartesian &rhs) noexcept
 Subtraction of two cartesian points. More...
 
Cartesian operator/ (const Cartesian &vec, double denominator) noexcept
 Scalar Division a cartesian point. More...
 
std::ostream & operator<< (std::ostream &os, const Cartesian &vec)
 Stream operator. More...
 
std::ostream & operator<< (std::ostream &os, const Euler &Euler)
 Stream operator. More...
 
std::ostream & operator<< (std::ostream &os, const Orientation &orientation)
 Stream operator. More...
 

Function Documentation

◆ angle()

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

angle between the two vectors

Parameters
vec1cartesian vector
vec2cartesian vector
Returns
unit vector in x direction

◆ cross()

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

Vector cross product.

Parameters
vec1cartesian vector
vec2cartesian vector
Returns
: the vector cross product

◆ norm()

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

Vector norm.

Parameters
vecthe cartesian vector
Returns
: the vector norm

◆ normalize()

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

normalize the input vector

Parameters
vecthe cartesian vector
Returns
: normalized vector

◆ operator*() [1/3]

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

Dot product of two cartesian points.

Parameters
lhsthe left hand side object
rhsthe right hand side object

◆ operator*() [2/3]

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

Vector scalar multiplication.

Parameters
vecthe cartesian vector
scalarthe the scalar value

◆ operator*() [3/3]

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

Vector scalar multiplication.

Parameters
scalarthe the scalar value
vecthe cartesian vector

◆ operator+()

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

Addition of two cartesian points.

Parameters
lhsthe left hand side object
rhsthe right hand side object

◆ operator-()

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

Subtraction of two cartesian points.

Parameters
lhsthe left hand side object
rhsthe right hand side object

◆ operator/()

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

Scalar Division a cartesian point.

Parameters
vecthe cartesian vector
denominatorthe the scalar value

◆ operator<<() [1/3]

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

Stream operator.

Parameters
osthe output stream
vecthe cartesian vector

◆ operator<<() [2/3]

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

Stream operator.

Parameters
osthe output stream
Eulerthe euler angles

◆ operator<<() [3/3]

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

Stream operator.

Parameters
osthe output stream
orientationthe roll/pitch/yaw angles