UnitRow< P, S > Class Template Reference
This type is used for the transpose of UnitVec, and as the returned row type of a Rotation. More...
#include <UnitVec.h>
Public Types | |
| typedef Row< 3, P, S > | BaseRow |
| typedef UnitVec< P, S > | TransposeType |
Public Member Functions | |
| UnitRow () | |
| UnitRow (const UnitRow &u) | |
| Copy constructor does not require normalization. | |
| template<int S2> | |
| UnitRow (const UnitRow< P, S2 > &u) | |
| Implicit conversion from UnitRow with different stride; no normalization required. | |
| UnitRow & | operator= (const UnitRow &u) |
| Copy assignment does not require normalization. | |
| template<int S2> | |
| UnitRow & | operator= (const UnitRow< P, S2 > &u) |
| Copy assignment from UnitRow with different stride; no computation needed. | |
| UnitRow (const BaseRow &v) | |
| Explicit conversion from Row to UnitRow, requiring expensive normalization. | |
| template<int S2> | |
| UnitRow (const Row< 3, P, S2 > &v) | |
| Explicit conversion from Row of any stride to UnitRow, requiring expensive normalization. | |
| UnitRow (const RealP &x, const RealP &y, const RealP &z) | |
| Create a unit row from explicitly specified measure numbers (x,y,z); requires expensive normalization. | |
| UnitRow (int axis) | |
| Create a unit axis vector 100 010 001 given 0, 1, or 2. | |
| const BaseRow & | asRow3 () const |
| Return a const reference to the Row3 underlying this UnitRow. | |
| UnitRow< P, 1 > | negate () const |
| Returns a new unit vector pointing in the opposite direction from this one; does not modify this UnitVec object. | |
| UnitRow< P, 1 > | operator- () const |
| Returns a new unit vector pointing in the opposite direction from this one. | |
| const TransposeType & | operator~ () const |
| Return a const reference to this UnitRow reinterpreted as a UnitVec; no computation requires since this is just a type cast. | |
| TransposeType & | operator~ () |
| Return a writable reference to this UnitRow reinterpreted as a UnitVec; no computation requires since this is just a type cast. | |
| const RealP & | operator[] (int i) const |
| Return one element of this unit row as a const reference; there is no corresponding writable index function since changing a single element of a unit vector would violate the contract that it has unit length at all times. | |
| const RealP & | operator() (int i) const |
| Return one element of this unit row as a const reference; there is no corresponding writable index function since changing a single element of a unit vector would violate the contract that it has unit length at all times. | |
| UnitRow< P, 1 > | abs () const |
| Return a new UnitRow whose measure numbers are the absolute values of the ones here. | |
| UnitRow< P, 1 > | perp () const |
| Return a new UnitRow perpendicular to this one but otherwise arbitrary. | |
| UnitRow (const BaseRow &v, bool) | |
| template<int S2> | |
| UnitRow (const Row< 3, P, S2 > &v, bool) | |
Detailed Description
template<class P, int S>
class SimTK::UnitRow< P, S >
This type is used for the transpose of UnitVec, and as the returned row type of a Rotation.
Don't construct these directly.
Member Typedef Documentation
| typedef UnitVec<P,S> TransposeType |
Constructor & Destructor Documentation
| UnitRow | ( | ) | [inline] |
Implicit conversion from UnitRow with different stride; no normalization required.
| UnitRow | ( | const RealP & | x, | |
| const RealP & | y, | |||
| const RealP & | z | |||
| ) | [inline] |
Create a unit row from explicitly specified measure numbers (x,y,z); requires expensive normalization.
References Row< 3, P, S >::norm().
| UnitRow | ( | int | axis | ) | [inline, explicit] |
Create a unit axis vector 100 010 001 given 0, 1, or 2.
References Row< 3, P, S >::operator[]().
Member Function Documentation
| UnitRow<P,1> abs | ( | ) | const [inline] |
Return a new UnitRow whose measure numbers are the absolute values of the ones here.
This will still have unit length but will be a reflection of this unit vector into the first octant (+x,+y,+z). Note that we are returning the packed form of UnitRow regardless of our stride here.
Reimplemented from Row< 3, P, S >.
References Row< N, ELT, STRIDE >::abs(), and UnitRow< P, S >::asRow3().
Referenced by UnitRow< P, S >::perp().
| const BaseRow& asRow3 | ( | ) | const [inline] |
Return a const reference to the Row3 underlying this UnitRow.
Referenced by UnitRow< P, S >::abs(), UnitRow< P, S >::negate(), and SimTK::operator*().
| UnitRow<P,1> negate | ( | ) | const [inline] |
Returns a new unit vector pointing in the opposite direction from this one; does not modify this UnitVec object.
Cost is 3 flops.
Reimplemented from Row< 3, P, S >.
References UnitRow< P, S >::asRow3().
Referenced by UnitRow< P, S >::operator-().
| const RealP& operator() | ( | int | i | ) | const [inline] |
Return one element of this unit row as a const reference; there is no corresponding writable index function since changing a single element of a unit vector would violate the contract that it has unit length at all times.
Reimplemented from Row< 3, P, S >.
References Row< 3, P, S >::operator()().
| UnitRow<P,1> operator- | ( | ) | const [inline] |
Returns a new unit vector pointing in the opposite direction from this one.
Cost is 3 flops.
Reimplemented from Row< 3, P, S >.
References UnitRow< P, S >::negate().
Copy assignment from UnitRow with different stride; no computation needed.
References Row< 3, P, S >::operator=().
Copy assignment does not require normalization.
References Row< 3, P, S >::operator=().
| const RealP& operator[] | ( | int | i | ) | const [inline] |
Return one element of this unit row as a const reference; there is no corresponding writable index function since changing a single element of a unit vector would violate the contract that it has unit length at all times.
Reimplemented from Row< 3, P, S >.
References Row< 3, P, S >::operator[]().
| TransposeType& operator~ | ( | ) | [inline] |
Return a writable reference to this UnitRow reinterpreted as a UnitVec; no computation requires since this is just a type cast.
Reimplemented from Row< 3, P, S >.
| const TransposeType& operator~ | ( | ) | const [inline] |
Return a const reference to this UnitRow reinterpreted as a UnitVec; no computation requires since this is just a type cast.
Reimplemented from Row< 3, P, S >.
| UnitRow< P, 1 > perp | ( | ) | const [inline] |
Return a new UnitRow perpendicular to this one but otherwise arbitrary.
Some care is taken to ensure good numerical conditioning for the result regardless of what goes in. Cost is about 50 flops.
References UnitRow< P, S >::abs().
The documentation for this class was generated from the following file:
