This type is used for the transpose of UnitVec, and as the returned row type of a Rotation. More...

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. More...

template<int S2>
	UnitRow (const UnitRow< P, S2 > &u)
	Implicit conversion from UnitRow with different stride; no normalization required. More...

UnitRow &	operator= (const UnitRow &u)
	Copy assignment does not require normalization. More...

template<int S2>
UnitRow &	operator= (const UnitRow< P, S2 > &u)
	Copy assignment from UnitRow with different stride; no computation needed. More...

	UnitRow (const BaseRow &v)
	Explicit conversion from Row to UnitRow, requiring expensive normalization. More...

template<int S2>
	UnitRow (const Row< 3, P, S2 > &v)
	Explicit conversion from Row of any stride to UnitRow, requiring expensive normalization. More...

	UnitRow (const P &x, const P &y, const P &z)
	Create a unit row from explicitly specified measure numbers (x,y,z); requires expensive normalization. More...

	UnitRow (int axis)
	Create a unit axis vector 100 010 001 given 0, 1, or 2. More...

const BaseRow &	asRow3 () const
	Return a const reference to the Row3 underlying this UnitRow. More...

UnitRow< P, 1 >	negate () const
	Returns a new unit vector pointing in the opposite direction from this one; does not modify this UnitVec object. More...

UnitRow< P, 1 >	operator- () const
	Returns a new unit vector pointing in the opposite direction from this one. More...

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. More...

TransposeType &	operator~ ()
	Return a writable reference to this UnitRow reinterpreted as a UnitVec; no computation requires since this is just a type cast. More...

const P &	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. More...

const P &	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. More...

UnitRow< P, 1 >	abs () const
	Return a new UnitRow whose measure numbers are the absolute values of the ones here. More...

UnitRow< P, 1 >	perp () const
	Return a new UnitRow perpendicular to this one but otherwise arbitrary. More...

	UnitRow (const BaseRow &v, bool)
	(Advanced) This constructor is only for our friends whom we trust to give us an already-normalized vector which we simply accept as normalized without checking. More...

template<int S2>
	UnitRow (const Row< 3, P, S2 > &v, bool)
	(Advanced) This constructor is only for our friends whom we trust to give us an already-normalized vector which we simply accept as normalized without checking (this version accepts an input vector of any stride). More...

Static Public Member Functions
static const UnitRow &	getAs (const P *p)
	(Advanced) Reinterpret a given memory location as a UnitRow like this one, without checking – don't use this if you aren't absolutely certain that the memory location actually does contain a unit vector, with the correct stride! This overrides the base Row class method of the same name. More...

Related Functions
(Note that these are not member functions.)
template<class P , int S1, int S2>
bool	operator== (const UnitRow< P, S1 > &u1, const UnitRow< P, S2 > &u2)
	Compare two UnitRow3 objects for exact, bitwise equality (not very useful). More...

template<class P , int S1, int S2>
bool	operator!= (const UnitRow< P, S1 > &u1, const UnitRow< P, S2 > &u2)
	Compare two UnitRow3 objects and return true unless they are exactly bitwise equal (not very useful). More...

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

◆ BaseRow

template<class P , int S>

typedef Row<3,P,S> SimTK::UnitRow< P, S >::BaseRow

◆ TransposeType

template<class P , int S>

typedef UnitVec<P,S> SimTK::UnitRow< P, S >::TransposeType

Constructor & Destructor Documentation

◆ UnitRow() [1/9]

template<class P , int S>

SimTK::UnitRow< P, S >::UnitRow ( )

inline

◆ UnitRow() [2/9]

template<class P , int S>

SimTK::UnitRow< P, S >::UnitRow ( const UnitRow< P, S > & u )

inline

Copy constructor does not require normalization.

◆ UnitRow() [3/9]

template<class P , int S>

template<int S2>

SimTK::UnitRow< P, S >::UnitRow ( const UnitRow< P, S2 > & u )

inline

Implicit conversion from UnitRow with different stride; no normalization required.

◆ UnitRow() [4/9]

template<class P , int S>

SimTK::UnitRow< P, S >::UnitRow ( const BaseRow & v )

inlineexplicit

Explicit conversion from Row to UnitRow, requiring expensive normalization.

◆ UnitRow() [5/9]

template<class P , int S>

template<int S2>

SimTK::UnitRow< P, S >::UnitRow ( const Row< 3, P, S2 > & v )

inlineexplicit

Explicit conversion from Row of any stride to UnitRow, requiring expensive normalization.

◆ UnitRow() [6/9]

template<class P , int S>

SimTK::UnitRow< P, S >::UnitRow	(	const P &	x,
		const P &	y,
		const P &	z
	)

inline

Create a unit row from explicitly specified measure numbers (x,y,z); requires expensive normalization.

◆ UnitRow() [7/9]

template<class P , int S>

SimTK::UnitRow< P, S >::UnitRow ( int axis )

inlineexplicit

Create a unit axis vector 100 010 001 given 0, 1, or 2.

◆ UnitRow() [8/9]

template<class P , int S>

SimTK::UnitRow< P, S >::UnitRow	(	const BaseRow &	v,
		bool
	)

inline

(Advanced) This constructor is only for our friends whom we trust to give us an already-normalized vector which we simply accept as normalized without checking.

◆ UnitRow() [9/9]

template<class P , int S>

template<int S2>

SimTK::UnitRow< P, S >::UnitRow	(	const Row< 3, P, S2 > &	v,
		bool
	)

inline

(Advanced) This constructor is only for our friends whom we trust to give us an already-normalized vector which we simply accept as normalized without checking (this version accepts an input vector of any stride).

Member Function Documentation

◆ operator=() [1/2]

template<class P , int S>

UnitRow& SimTK::UnitRow< P, S >::operator= ( const UnitRow< P, S > & u )

inline

Copy assignment does not require normalization.

◆ operator=() [2/2]

template<class P , int S>

template<int S2>

UnitRow& SimTK::UnitRow< P, S >::operator= ( const UnitRow< P, S2 > & u )

inline

Copy assignment from UnitRow with different stride; no computation needed.

◆ asRow3()

template<class P , int S>

const BaseRow& SimTK::UnitRow< P, S >::asRow3 ( ) const

inline

Return a const reference to the Row3 underlying this UnitRow.

◆ negate()

template<class P , int S>

UnitRow<P,1> SimTK::UnitRow< P, S >::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.

◆ operator-()

template<class P , int S>

UnitRow<P,1> SimTK::UnitRow< P, S >::operator- ( ) const

inline

Returns a new unit vector pointing in the opposite direction from this one.

Cost is 3 flops.

◆ operator~() [1/2]

template<class P , int S>

const TransposeType& SimTK::UnitRow< P, S >::operator~ ( ) const

inline

Return a const reference to this UnitRow reinterpreted as a UnitVec; no computation requires since this is just a type cast.

◆ operator~() [2/2]

template<class P , int S>

TransposeType& SimTK::UnitRow< P, S >::operator~ ( )

inline

Return a writable reference to this UnitRow reinterpreted as a UnitVec; no computation requires since this is just a type cast.

◆ operator[]()

template<class P , int S>

const P& SimTK::UnitRow< P, S >::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.

◆ operator()()

template<class P , int S>

const P& SimTK::UnitRow< P, S >::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.

◆ abs()

template<class P , int S>

UnitRow<P,1> SimTK::UnitRow< P, S >::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.

◆ perp()

template<class P , int S>

UnitRow< P, 1 > SimTK::UnitRow< P, S >::perp

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.

◆ getAs()

template<class P , int S>

static const UnitRow& SimTK::UnitRow< P, S >::getAs ( const P * p )

inlinestatic

(Advanced) Reinterpret a given memory location as a UnitRow like this one, without checking – don't use this if you aren't absolutely certain that the memory location actually does contain a unit vector, with the correct stride! This overrides the base Row class method of the same name.

Friends And Related Function Documentation

◆ operator==()

template<class P , int S1, int S2>

bool operator==	(	const UnitRow< P, S1 > &	u1,
		const UnitRow< P, S2 > &	u2
	)

◆ operator!=()

template<class P , int S1, int S2>

bool operator!=	(	const UnitRow< P, S1 > &	u1,
		const UnitRow< P, S2 > &	u2
	)

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

UnitVec.h

Public Types

Public Member Functions

Static Public Member Functions

Related Functions

Detailed Description

template<class P, int S> class SimTK::UnitRow< P, S >

Member Typedef Documentation

◆ BaseRow

◆ TransposeType

Constructor & Destructor Documentation

◆ UnitRow() [1/9]

◆ UnitRow() [2/9]

◆ UnitRow() [3/9]

◆ UnitRow() [4/9]

◆ UnitRow() [5/9]

◆ UnitRow() [6/9]

◆ UnitRow() [7/9]

◆ UnitRow() [8/9]

◆ UnitRow() [9/9]

Member Function Documentation

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ asRow3()

◆ negate()

◆ operator-()

◆ operator~() [1/2]

◆ operator~() [2/2]

◆ operator[]()

◆ operator()()

◆ abs()

◆ perp()

◆ getAs()

Friends And Related Function Documentation

◆ operator==()

◆ operator!=()

template<class P, int S>
class SimTK::UnitRow< P, S >