nmrBernsteinPolynomial.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:   2001-10-17

  (C) Copyright 2001-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 ---
*/


#ifndef _nmrBernsteinPolynomial_h
#define _nmrBernsteinPolynomial_h

#include <cisstNumerical/nmrDynAllocPolynomialContainer.h>

#include <assert.h>

#include <cisstNumerical/nmrExport.h>

class CISST_EXPORT nmrBernsteinPolynomial : public nmrDynAllocPolynomialContainer
{
public:
    typedef nmrDynAllocPolynomialContainer BaseType;
    
    typedef std::pair<nmrPolynomialBase::CoefficientType, 
        nmrPolynomialTermPowerIndex::MultinomialCoefficientType> BernsteinTermInfo;

#ifdef CISST_COMPILER_IS_MSVC
#pragma warning(push)
#pragma warning(disable:4996)
#endif  // ifdef CISST_COMPILER_IS_MSVC

    nmrBernsteinPolynomial(VariableIndexType numVariables, PowerType degree)
        : BaseType(numVariables, degree, degree)
#if INCLUDE_DEPRECATED_POLYNOMIAL_CODE
        , PowerBasis(numVariables, degree, numVariables - 1)
#endif  // INCLUDE_DEPRECATED_POLYNOMIAL_CODE
    {
#if INCLUDE_DEPRECATED_POLYNOMIAL_CODE
        VariablePowers = &PowerBasis;
#endif  // INCLUDE_DEPRECATED_POLYNOMIAL_CODE
    }

#if INCLUDE_DEPRECATED_POLYNOMIAL_CODE

    virtual void CISST_DEPRECATED SetVariables(const VariableType values[])
    {
        PowerBasis.SetVariables(values);
    }

    virtual void CISST_DEPRECATED SetVariable(VariableIndexType varIndex, VariableType value)
    {
        PowerBasis.SetVariable(varIndex, value);
    }


    virtual bool CISST_DEPRECATED CanSetVariable(VariableIndexType varIndex) const
    {
        return ( (0 <= varIndex) && 
            (varIndex < GetNumVariables()) && 
            (varIndex != GetImplicitVarIndex()) );
    }

    VariableType CISST_DEPRECATED GetImplicitVariable() const
    { 
        return PowerBasis.GetImplicitVariable();
    }

    VariableIndexType CISST_DEPRECATED GetImplicitVarIndex() const
    { 
        return PowerBasis.GetImplicitVarIndex();
    }

    void CISST_DEPRECATED SetImplicitVarIndex(VariableIndexType newIndex)
    { 
        PowerBasis.SetImplicitVarIndex(newIndex);
    }
#ifdef CISST_COMPILER_IS_MSVC
#pragma warning(pop)
#endif  // ifdef CISST_COMPILER_IS_MSVC
#endif  // INCLUDE_DEPRECATED_POLYNOMIAL_CODE

    virtual InsertStatus SetCoefficient(const nmrPolynomialTermPowerIndex & where, 
                                        CoefficientType coefficient);

    virtual InsertStatus SetCoefficient(TermIteratorType & where, CoefficientType coefficient);
    
    virtual CoefficientType GetCoefficient(const nmrPolynomialTermPowerIndex & where) const;

    virtual CoefficientType GetCoefficient(const TermConstIteratorType & where) const
    { return GetTermCoefficient(where); }
    virtual CoefficientType GetCoefficient(const TermIteratorType & where) const
    { return GetTermCoefficient(where); }

    virtual void RemoveTerm(TermIteratorType & where);

    virtual void Clear();

    virtual ValueType EvaluateBasis(const nmrPolynomialTermPowerIndex & where,
        const nmrMultiVariablePowerBasis & variables) const;
    virtual ValueType EvaluateBasis(const TermConstIteratorType & where,
        const nmrMultiVariablePowerBasis & variables) const;
    virtual ValueType EvaluateBasis(const TermIteratorType & where,
        const nmrMultiVariablePowerBasis & variables) const;

    virtual void SerializeTermInfo(std::ostream & output, const TermConstIteratorType & termIterator) const;

    virtual void DeserializeTermInfo(std::istream & input, TermIteratorType & termIterator);

    virtual void AddConstant(CoefficientType shiftAmount);

    virtual void AddConstantToCoefficients(CoefficientType coefficients[],
        CoefficientType shiftAmount) const;

    const nmrPolynomialTermPowerIndex::MultinomialCoefficientType &
        GetMultinomialCoefficient(const TermIteratorType & where) const
    {
        return ((BernsteinTermInfo *)(where->second))->second;
    }

    const nmrPolynomialTermPowerIndex::MultinomialCoefficientType & 
        GetMultinomialCoefficient(const TermConstIteratorType & where) const
    {
        return ((BernsteinTermInfo *)(where->second))->second;
    }


protected:
    nmrPolynomialTermPowerIndex::MultinomialCoefficientType &
        RefMultinomialCoefficient(const TermIteratorType & where)
    {
        return ((BernsteinTermInfo *)(where->second))->second;
    }

    const CoefficientType & GetTermCoefficient(const TermConstIteratorType & where) const
    {
        return ((BernsteinTermInfo *)(where->second))->first;
    }

    const CoefficientType & GetTermCoefficient(const TermIteratorType & where) const
    {
        return ((BernsteinTermInfo *)(where->second))->first;
    }

    CoefficientType & RefTermCoefficient(const TermIteratorType & where)
    {
        return ((BernsteinTermInfo *)(where->second))->first;
    }

#if INCLUDE_DEPRECATED_POLYNOMIAL_CODE
    CISST_DEPRECATED nmrMultiVariablePowerBasis::BarycentricBasis PowerBasis;
#endif  // INCLUDE_DEPRECATED_POLYNOMIAL_CODE

};


#endif // _nmrBernsteinPolynomial_h