amino  1.0-beta2
Lightweight Robot Utility Library
amino::Cmplx Struct Reference

A complex number. More...

#include <planar.hpp>

Inheritance diagram for amino::Cmplx:
amino::BaseCmplx

Public Member Functions

 Cmplx ()
 Construct zero-valued complex number.
 
 Cmplx (double real, double imag)
 Construct from real and imaginary components.
 
 Cmplx (type c)
 Construct from a C++ complex number.
 
 Cmplx (aa_tf_cmplx c)
 Construct from a C complex number.
 
 Cmplx (const aa_tf_rotmatp &R)
 Construct from a rotation matrix.
 
 Cmplx (const aa_tf_rotmatp *R)
 Construct from a rotation matrix.
 
 Cmplx (const AngleP &a)
 Construct from a rotation angle.
 
 Cmplx (const AngleP *a)
 Construct from a rotation angle.
 
double angle () const
 Return the angle of the complex number.
 
double uln () const
 Return the logarithm of the complex number.
 
Cmplx conj () const
 Return the complex conjugate.
 
- Public Member Functions inherited from amino::BaseCmplx
 BaseCmplx ()
 Construct a zero-valued complex number.
 
 BaseCmplx (double real, double imag)
 Construct from real and imaginary values.
 
 BaseCmplx (type c)
 Construct from a C++ complex number.
 
 BaseCmplx (const aa_tf_cmplx &v)
 Construct from a C complex number.
 
aa_tf_cmplx c_cmplx () const
 Convert to a C complex number.
 
 operator aa_tf_cmplx () const
 Implicit conversion to a C complex number.
 

Static Public Member Functions

static Cmplx from_angle (double theta)
 Create complex number from a rotation angle.
 
static Cmplx from_rotmatp (const double *R)
 Create complex number from a rotation matrix.
 
static Cmplx from (const aa_tf_rotmatp *R)
 Create complex number from a rotation matrix.
 
static Cmplx from (const aa_tf_rotmatp &R)
 Create complex number from a rotation matrix.
 
static Cmplx from (const AngleP &a)
 Create complex number from a rotation angle.
 
static Cmplx from (const AngleP *a)
 Create complex number from a rotation angle.
 
static aa_tf_cmplx ident ()
 Return the identity element.
 
- Static Public Member Functions inherited from amino::BaseCmplx
static aa_tf_cmplx c_cmplx (type c)
 Convert to a C complex number.
 
static double c_real (const aa_tf_cmplx &v)
 Extract real part of a C complex number.
 
static double c_imag (const aa_tf_cmplx &v)
 Extract imaginary part of a C complex number.
 
static type from (const aa_tf_cmplx &v)
 Convert C complex number to C++ complex number.
 

Additional Inherited Members

- Public Types inherited from amino::BaseCmplx
typedef ::std::complex< double > type
 Convenience typedef for C++ complex numbers.
 
- Protected Member Functions inherited from amino::BaseCmplx
double & real_ref ()
 Assignable reference to the real part.
 
double & imag_ref ()
 Assignable reference to the imaginary part.
 

Detailed Description

A complex number.

Definition at line 167 of file planar.hpp.


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