Teuchos - Trilinos Tools Package Version of the Day
Teuchos_PolynomialDecl.hpp
00001 // @HEADER
00002 // ***********************************************************************
00003 //
00004 //                    Teuchos: Common Tools Package
00005 //                 Copyright (2004) Sandia Corporation
00006 //
00007 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
00008 // license for use of this work by or on behalf of the U.S. Government.
00009 //
00010 // Redistribution and use in source and binary forms, with or without
00011 // modification, are permitted provided that the following conditions are
00012 // met:
00013 //
00014 // 1. Redistributions of source code must retain the above copyright
00015 // notice, this list of conditions and the following disclaimer.
00016 //
00017 // 2. Redistributions in binary form must reproduce the above copyright
00018 // notice, this list of conditions and the following disclaimer in the
00019 // documentation and/or other materials provided with the distribution.
00020 //
00021 // 3. Neither the name of the Corporation nor the names of the
00022 // contributors may be used to endorse or promote products derived from
00023 // this software without specific prior written permission.
00024 //
00025 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00026 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00027 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00028 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00029 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00030 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00031 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00032 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00033 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00034 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00035 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00036 //
00037 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
00038 //
00039 // ***********************************************************************
00040 // @HEADER
00041 
00042 #ifndef TEUCHOS_POLYNOMIAL_DECL_HPP
00043 #define TEUCHOS_POLYNOMIAL_DECL_HPP
00044 
00045 #include "Teuchos_Describable.hpp"
00046 #include "Teuchos_RCP.hpp"
00047 #include "Teuchos_PolynomialTraits.hpp"
00048 
00049 namespace Teuchos {
00050 
00052 
00068   template <typename CoeffT>
00069   class Polynomial : virtual public Teuchos::Describable {
00070   public:
00071 
00073     typedef CoeffT coeff_type;
00074 
00076     typedef typename Teuchos::PolynomialTraits<coeff_type>::scalar_type scalar_type;
00077 
00079 
00085     Polynomial(unsigned int deg, const CoeffT& cloneCoeff, 
00086          unsigned int reserve = 0);
00087 
00089 
00096     Polynomial(unsigned int deg, unsigned int reserve = 0);
00097 
00099     ~Polynomial();
00100 
00102     unsigned int degree() const { return d; }
00103 
00105     void setDegree(unsigned int deg);
00106 
00108     Teuchos::RCP<CoeffT>
00109     getCoefficient(unsigned int i);
00110 
00112     Teuchos::RCP<const CoeffT>
00113     getCoefficient(unsigned int i) const;
00114 
00116     void setCoefficient(unsigned int i, const CoeffT& v);
00117 
00119 
00125     void setCoefficientPtr(unsigned int i, 
00126          const Teuchos::RCP<CoeffT>& c_ptr);
00127 
00129 
00137     void evaluate(typename Teuchos::Polynomial<CoeffT>::scalar_type&  t, 
00138       CoeffT* x, CoeffT* xdot = NULL) const;
00139 
00140   private:
00141 
00143     Polynomial(const Polynomial&);
00144 
00146     Polynomial& operator=(const Polynomial&);
00147 
00148   protected:
00149 
00151     unsigned int d; 
00152 
00154     unsigned int sz;
00155 
00157 
00160     std::vector< Teuchos::RCP<CoeffT> > coeff;
00161 
00162   }; // class Polynomial
00163 
00164 } // end namespace Teuchos
00165 
00166 #endif  // TEUCHOS_POLYNOMIAL_DECL_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines