src/math/ChebyshevPolynomials.hpp

/*
 * Copyright (C) 2000-2004  Object Oriented Parallel Simulation Engine (OOPSE) project
 * 
 * Contact: oopse@oopse.org
 * 
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation; either version 2.1
 * of the License, or (at your option) any later version.
 * All we ask is that proper credit is given for our work, which includes
 * - but is not limited to - adding the above copyright notice to the beginning
 * of your source code files, and to any copyright notice that you may distribute
 * with programs based on this work.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 *
 */

/**
 * @file ChebyshevPolynomials.hpp
 * @author    teng lin
 * @date  11/16/2004
 * @version 1.0
 */ 

#ifndef MATH_CHEBYSHEVPOLYNOMIALS_HPP
#define MATH_CHEBYSHEVPOLYNOMIALS_HPP

#include <vector>

#include "math/Polynomial.hpp"

namespace oopse {

/**
 * @class ChebyshevPolynomials
 * A collection of Chebyshev Polynomials.
 * @todo document
 */
class ChebyshevPolynomials {
    public:
        ChebyshevPolynomials(int maxPower);

        /**
         * Calculates the value of the nth Chebyshev Polynomial evaluated at the given x value.
         * @return The value of the nth Chebyshev Polynomial evaluates at the given x value
         * @param n
         * @param x the value of the independent variable for the nth Chebyshev Polynomial  function
         */
        
        double evaluate(int n, double x) {
            assert (n <= maxPower_ && n >=0); 
            return polyList_[n].evaluate(x);
        }

        /**
         * Returns the first derivative of the nth Chebyshev Polynomial.
         * @return the first derivative of the nth Chebyshev Polynomial
         * @param n
         * @param x the value of the independent variable for the nth Chebyshev Polynomial  function
         */
        double evaluateDerivative(int n, double x) {
            assert (n <= maxPower_ && n >=0); 
            return polyList_[n].evaluateDerivative(x);        
        }

        /**
         * Returns the nth Chebyshev Polynomial 
         * @return the nth Chebyshev Polynomial
         * @param n
         */
        const DoublePolynomial& getChebyshevPolynomial(int n) const {
            assert (n <= maxPower_ && n >=0); 
            return polyList_[n];
        }

    protected:

       std::vector<DoublePolynomial> polyList_;
                
    private:
        
        void GeneratePolynomials(int maxPower);
        virtual void GenerateFirstTwoTerms() = 0;
        
        int maxPower_;
};    

/**
 * @class ChebyshevT
 * @todo document
 */
class ChebyshevT : public ChebyshevPolynomials {
    public:
        ChebyshevT(int maxPower) :ChebyshevPolynomials(maxPower) {}

    private:
        virtual void GenerateFirstTwoTerms();
};

/**
 * @class ChebyshevU
 * @todo document
 */
class ChebyshevU : public ChebyshevPolynomials {
    public:
        ChebyshevU(int maxPower) :ChebyshevPolynomials(maxPower) {}

    private:
        virtual void GenerateFirstTwoTerms();
};


} //end namespace oopse
#endif //MATH_CHEBYSHEVPOLYNOMIALS_HPP
Revision:	1748
Committed:	Wed Nov 17 21:47:42 2004 UTC (19 years, 7 months ago) by tim
File size:	3622 byte(s)
Log Message:	UreyBradleyBend and GhostBend
#	Content
1	/*
2	* Copyright (C) 2000-2004 Object Oriented Parallel Simulation Engine (OOPSE) project
3	*
4	* Contact: oopse@oopse.org
5	*
6	* This program is free software; you can redistribute it and/or
7	* modify it under the terms of the GNU Lesser General Public License
8	* as published by the Free Software Foundation; either version 2.1
9	* of the License, or (at your option) any later version.
10	* All we ask is that proper credit is given for our work, which includes
11	* - but is not limited to - adding the above copyright notice to the beginning
12	* of your source code files, and to any copyright notice that you may distribute
13	* with programs based on this work.
14	*
15	* This program is distributed in the hope that it will be useful,
16	* but WITHOUT ANY WARRANTY; without even the implied warranty of
17	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18	* GNU Lesser General Public License for more details.
19	*
20	* You should have received a copy of the GNU Lesser General Public License
21	* along with this program; if not, write to the Free Software
22	* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
23	*
24	*/
25
26	/**
27	* @file ChebyshevPolynomials.hpp
28	* @author teng lin
29	* @date 11/16/2004
30	* @version 1.0
31	*/
32
33	#ifndef MATH_CHEBYSHEVPOLYNOMIALS_HPP
34	#define MATH_CHEBYSHEVPOLYNOMIALS_HPP
35
36	#include <vector>
37
38	#include "math/Polynomial.hpp"
39
40	namespace oopse {
41
42	/**
43	* @class ChebyshevPolynomials
44	* A collection of Chebyshev Polynomials.
45	* @todo document
46	*/
47	class ChebyshevPolynomials {
48	public:
49	ChebyshevPolynomials(int maxPower);
50
51	/**
52	* Calculates the value of the nth Chebyshev Polynomial evaluated at the given x value.
53	* @return The value of the nth Chebyshev Polynomial evaluates at the given x value
54	* @param n
55	* @param x the value of the independent variable for the nth Chebyshev Polynomial function
56	*/
57
58	double evaluate(int n, double x) {
59	assert (n <= maxPower_ && n >=0);
60	return polyList_[n].evaluate(x);
61	}
62
63	/**
64	* Returns the first derivative of the nth Chebyshev Polynomial.
65	* @return the first derivative of the nth Chebyshev Polynomial
66	* @param n
67	* @param x the value of the independent variable for the nth Chebyshev Polynomial function
68	*/
69	double evaluateDerivative(int n, double x) {
70	assert (n <= maxPower_ && n >=0);
71	return polyList_[n].evaluateDerivative(x);
72	}
73
74	/**
75	* Returns the nth Chebyshev Polynomial
76	* @return the nth Chebyshev Polynomial
77	* @param n
78	*/
79	const DoublePolynomial& getChebyshevPolynomial(int n) const {
80	assert (n <= maxPower_ && n >=0);
81	return polyList_[n];
82	}
83
84	protected:
85
86	std::vector<DoublePolynomial> polyList_;
87
88	private:
89
90	void GeneratePolynomials(int maxPower);
91	virtual void GenerateFirstTwoTerms() = 0;
92
93	int maxPower_;
94	};
95
96	/**
97	* @class ChebyshevT
98	* @todo document
99	*/
100	class ChebyshevT : public ChebyshevPolynomials {
101	public:
102	ChebyshevT(int maxPower) :ChebyshevPolynomials(maxPower) {}
103
104	private:
105	virtual void GenerateFirstTwoTerms();
106	};
107
108	/**
109	* @class ChebyshevU
110	* @todo document
111	*/
112	class ChebyshevU : public ChebyshevPolynomials {
113	public:
114	ChebyshevU(int maxPower) :ChebyshevPolynomials(maxPower) {}
115
116	private:
117	virtual void GenerateFirstTwoTerms();
118	};
119
120
121	} //end namespace oopse
122	#endif //MATH_CHEBYSHEVPOLYNOMIALS_HPP