Teuchos_PolynomialDecl.hpp

Go to the documentation of this file.

// @HEADER
// ***********************************************************************
//
//                    Teuchos: Common Tools Package
//                 Copyright (2004) Sandia Corporation
//
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Questions? Contact Michael A. Heroux (maherou@sandia.gov)
//
// ***********************************************************************
// @HEADER

#ifndef TEUCHOS_POLYNOMIAL_DECL_HPP
#define TEUCHOS_POLYNOMIAL_DECL_HPP

#include "Teuchos_Describable.hpp"
#include "Teuchos_RCP.hpp"
#include "Teuchos_PolynomialTraits.hpp"

namespace Teuchos {


  template <typename CoeffT>
  class Polynomial : virtual public Teuchos::Describable {
  public:

    typedef CoeffT coeff_type;

    typedef typename Teuchos::PolynomialTraits<coeff_type>::scalar_type scalar_type;


    Polynomial(unsigned int deg, const CoeffT& cloneCoeff,
         unsigned int reserve = 0);


    Polynomial(unsigned int deg, unsigned int reserve = 0);

    ~Polynomial();

    unsigned int degree() const { return d; }

    void setDegree(unsigned int deg);

    Teuchos::RCP<CoeffT>
    getCoefficient(unsigned int i);

    Teuchos::RCP<const CoeffT>
    getCoefficient(unsigned int i) const;

    void setCoefficient(unsigned int i, const CoeffT& v);


    void setCoefficientPtr(unsigned int i,
         const Teuchos::RCP<CoeffT>& c_ptr);


    void evaluate(typename Teuchos::Polynomial<CoeffT>::scalar_type&  t,
      CoeffT* x, CoeffT* xdot = NULL) const;

  private:

    Polynomial(const Polynomial&);

    Polynomial& operator=(const Polynomial&);

  protected:

    unsigned int d;

    unsigned int sz;


    std::vector< Teuchos::RCP<CoeffT> > coeff;

  }; // class Polynomial

} // end namespace Teuchos

#endif  // TEUCHOS_POLYNOMIAL_DECL_HPP