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

  (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 ---
*/


#ifndef _nmrStandardPolynomial_h
#define _nmrStandardPolynomial_h


#include <cisstNumerical/nmrDynAllocPolynomialContainer.h>
#include <cisstNumerical/nmrExport.h>


class CISST_EXPORT nmrStandardPolynomial : public nmrDynAllocPolynomialContainer
{
public:
    typedef nmrDynAllocPolynomialContainer BaseType;

    nmrStandardPolynomial(VariableIndexType numVariables, PowerType minDegree, PowerType maxDegree)
        : BaseType(numVariables, minDegree, maxDegree)
#if INCLUDE_DEPRECATED_POLYNOMIAL_CODE
        , PowerBasis(numVariables, maxDegree)
#endif  // INCLUDE_DEPRECATED_POLYNOMIAL_CODE

    {
#if INCLUDE_DEPRECATED_POLYNOMIAL_CODE
#ifdef CISST_COMPILER_IS_MSVC
#pragma warning(push)
#pragma warning(disable:4996)
#endif  // ifdef CISST_COMPILER_IS_MSVC
        VariablePowers = &PowerBasis;
#ifdef CISST_COMPILER_IS_MSVC
#pragma warning(pop)
#endif  // ifdef CISST_COMPILER_IS_MSVC
#endif  // INCLUDE_DEPRECATED_POLYNOMIAL_CODE
    }

    virtual ~nmrStandardPolynomial()
    {}

#if INCLUDE_DEPRECATED_POLYNOMIAL_CODE
#ifdef CISST_COMPILER_IS_MSVC
#pragma warning(push)
#pragma warning(disable:4996)
#endif  // ifdef CISST_COMPILER_IS_MSVC
    virtual void CISST_DEPRECATED SetVariable(VariableIndexType varIndex, VariableType value);

    virtual void CISST_DEPRECATED SetVariables(const VariableType vars[]);

    virtual bool CISST_DEPRECATED CanSetVariable(VariableIndexType varIndex) const
    {
        return ( (0 <= varIndex) && (varIndex < GetNumVariables()) );
    }
#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)
    { 
        DereferenceIterator(where) = coefficient;
        return INSERT_REPLACE;
    }

    
    virtual CoefficientType GetCoefficient(const nmrPolynomialTermPowerIndex& where) const
    {
        TermConstIteratorType it = FindTerm(where);

        return (it != EndTermIterator())
            ? DereferenceConstIterator(it)
            : 0;
    }

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

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


    
    virtual void RemoveTerm(TermIteratorType & where);

    virtual void Clear();
    
    virtual ValueType EvaluateBasis(const nmrPolynomialTermPowerIndex & where,
        const nmrMultiVariablePowerBasis & variables) const
    {
        assert(where.GetNumVariables() == variables.GetNumVariables());
        assert(where.GetDegree() <= variables.GetMaxDegree());
        return variables.EvaluatePowerProduct(where.GetPowers());
    }

    virtual ValueType EvaluateBasis(const TermConstIteratorType & where,
        const nmrMultiVariablePowerBasis & variables) const
    { 
        return EvaluateBasis( where->first, variables );
    }

    virtual ValueType EvaluateBasis(const TermIteratorType & where,
        const nmrMultiVariablePowerBasis & variables) const
    { 
        return EvaluateBasis( where->first, variables ); 
    }

    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;

protected:

    CoefficientType & DereferenceIterator(const TermIteratorType & it)
    { 
        CoefficientType * pCoeff = (CoefficientType *)(it->second);
        return *pCoeff; 
    }

    CoefficientType DereferenceIterator(const TermIteratorType & it) const
    { return *((CoefficientType *)(it->second)); }

    CoefficientType DereferenceConstIterator(const TermConstIteratorType & it) const
    { return *((CoefficientType *)(it->second)); }

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

};


#endif // _nmrStandardPolynomial_h