vctBarycentricVector.h

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-    */
/* ex: set filetype=cpp softtabstop=4 shiftwidth=4 tabstop=4 cindent expandtab: */

/*

  Author(s):    Ofri Sadowsky
  Created on:   2003-12-02

  (C) Copyright 2003-2007 Johns Hopkins University (JHU), All Rights
  Reserved.

--- begin cisst license - do not edit ---

This software is provided "as is" under an open source license, with
no warranty.  The complete license can be found in license.txt and
http://www.cisst.org/cisst/license.txt.

--- end cisst license ---
*/

#pragma once
#ifndef _vctBarycentricVector_h
#define _vctBarycentricVector_h

#include <cisstCommon/cmnTypeTraits.h>
#include <cisstVector/vctFixedSizeVector.h>

template <class _elementType, vct::size_type _size>
class vctBarycentricVector : public vctFixedSizeVector<_elementType, _size>
{
public:
    typedef vctFixedSizeVector<_elementType, _size> BaseType;
    typedef vctBarycentricVector<_elementType, _size> ThisType;

    VCT_CONTAINER_TRAITS_TYPEDEFS(_elementType);
    typedef class cmnTypeTraits<value_type> TypeTraits;

    vctBarycentricVector()
        : BaseType()
    {}

    vctBarycentricVector(const ThisType & other)
        : BaseType( static_cast<const BaseType &>(other) )
    {}

    vctBarycentricVector(const BaseType & other)
        : BaseType(other)
    {}

    template <stride_type __stride, class __dataPtrType>
    vctBarycentricVector(const vctFixedSizeVectorBase<_size, __stride, _elementType, __dataPtrType> & other)
        : BaseType(other)
    {}

    vctBarycentricVector(_elementType value)
        : BaseType(value)
    {}

    vctBarycentricVector(_elementType element0, _elementType element1)
        : BaseType(element0, element1)
    {}

    vctBarycentricVector(_elementType element0, _elementType element1, _elementType element2)
        : BaseType(element0, element1, element2)
    {}

    vctBarycentricVector(_elementType element0, _elementType element1, _elementType element2,
                         _elementType element3)
        : BaseType(element0, element1, element2, element3)
    {}

    /* This one cannot call BaseType constructor as we cannot identify the
     unknown arguments */
    vctBarycentricVector(_elementType element0, _elementType element1, _elementType element2,
                         _elementType element3, _elementType element4, ...)
    {
        (*this)[0] = element0;
        (*this)[1] = element1;
        (*this)[2] = element2;
        (*this)[3] = element3;
        (*this)[4] = element4;
        va_list nextArg;
        va_start(nextArg, element4);
        for (index_type i = 5; i < _size; ++i) {
            (*this)[i] = va_arg(nextArg, value_type);
        }
        va_end(nextArg);
    }

    bool IsBarycentric(const _elementType tolerance = TypeTraits::Tolerance() ) const
    {
        const _elementType diff = this->SumOfElements() - 1;
        return ( (-tolerance <= diff) && (diff <= tolerance) );
    }

    bool IsInterior(const _elementType tolerance = TypeTraits::Tolerance()) const
    {
        if (!IsBarycentric())
            return false;
        const bool result = ((*this).GreaterOrEqual(tolerance));
        return result;
    }

    bool IsMember(const _elementType tolerance = TypeTraits::Tolerance()) const
    {
        if (!IsBarycentric())
            return false;
        const bool result = ((*this).GreaterOrEqual(-tolerance));
        return result;
    }

    bool HasZero(const _elementType tolerance = TypeTraits::Tolerance()) const
    {
        return
            vctFixedSizeVectorRecursiveEngines<_size>::template
            SoViSi< typename vctBinaryOperations<bool>::Or,
            typename vctBinaryOperations<bool, value_type, value_type>::Bound>::
            Unfold( (*this), tolerance );
    }

    bool IsBoundary(const _elementType tolerance = TypeTraits::Tolerance()) const
    {
        return (IsMember(tolerance) && HasZero(tolerance));
    }

    bool IsVertex(const _elementType tolerance = TypeTraits::Tolerance()) const
    {
        if (!IsMember(tolerance))
            return false;
        const ThisType diff((*this) - _elementType(1));
        return (diff.HasZero(tolerance));
    }

    ThisType ScaleToBarycentric(const _elementType tolerance = TypeTraits::Tolerance()) const
    {
        _elementType scale = this->SumOfElements();
        if ( (-tolerance <= scale) && (scale <= tolerance) )
            return ThisType(0);
        ThisType result(*this);
        result /= scale;
        return result;
    }

};


#endif // _vctBarycentricVector_h