ERC CISST - cisst software

vctBarycentricVector< _elementType, _size > Class Template Reference
[Vectors]

#include <vctBarycentricVector.h>

Inheritance diagram for vctBarycentricVector< _elementType, _size >:

[legend]Collaboration diagram for vctBarycentricVector< _elementType, _size >:

[legend]List of all members.

Detailed Description

template<class _elementType, vct::size_type _size>
class vctBarycentricVector< _elementType, _size >

class vctBarycentricVector is derived from vctFixedSizeVector and has the same basic functionality. It contains a few additional functions meant to simplify dealing with vectors of barycentric coordinates. For our general definition, a set of coordinates is barycentric if it sums to 1. When a barycentric vector is used to parametrize a simplex geometrical object, all interior points have all-positive coordinates. All member points (including the boundary) have non-negative coordinates. A boundary point has one or more of its coordinates zero. A vertex has one coordinate equal to 1, and the others zero.

I have decided to derive this class from vctFixedSizeVector, which means that the operations can only be performed on locally owned memory (as opposed to a referenced vector). The reason was that it would be too hard to regenerate this set of operations as a subclass for each vector type. In addition, most of the operations here are const methods, and in the case of computing a new set of coordinates, they return it by value. Therefore, vctBarycentricVector is safer to use than other library objects, but on the other hand the operations may be somewhat slower.

I did not provide the full set of constructors as I have with vctFixedSizeVector, and therefore the use of a vctBarycentricVector should be more explicit in terms of type conversions than vctFixedSizeVector.

Many operations on vctBarycentricVector require a tolerance argument, which is given with a default value. The tolerance argument must be non-negative, or else the result is undefined. The current implementation does not test for it, but assumes it. In most cases, we compare absolute values of numbers to the tolerance.

Definition at line 70 of file vctBarycentricVector.h.

Public Types

typedef vctFixedSizeVector<
_elementType, _size > BaseType
typedef vctBarycentricVector<
_elementType, _size > ThisType
typedef cmnTypeTraits< value_type > TypeTraits

Public Member Functions

vctBarycentricVector ()
vctBarycentricVector (const ThisType &other)
vctBarycentricVector (const BaseType &other)
template<stride_type __stride, class __dataPtrType> vctBarycentricVector (const vctFixedSizeVectorBase< _size, __stride, _elementType, __dataPtrType > &other)
vctBarycentricVector (_elementType value)
vctBarycentricVector (_elementType element0, _elementType element1)
vctBarycentricVector (_elementType element0, _elementType element1, _elementType element2)
vctBarycentricVector (_elementType element0, _elementType element1, _elementType element2, _elementType element3)
vctBarycentricVector (_elementType element0, _elementType element1, _elementType element2, _elementType element3, _elementType element4,...)
bool IsBarycentric (const _elementType tolerance=TypeTraits::Tolerance()) const
bool IsInterior (const _elementType tolerance=TypeTraits::Tolerance()) const
bool IsMember (const _elementType tolerance=TypeTraits::Tolerance()) const
bool HasZero (const _elementType tolerance=TypeTraits::Tolerance()) const
bool IsBoundary (const _elementType tolerance=TypeTraits::Tolerance()) const
bool IsVertex (const _elementType tolerance=TypeTraits::Tolerance()) const
ThisType ScaleToBarycentric (const _elementType tolerance=TypeTraits::Tolerance()) const