src/math/ChebyshevPolynomials.hpp

 /*
 * Copyright (c) 2005 The University of Notre Dame. All Rights Reserved.
 *
 * The University of Notre Dame grants you ("Licensee") a
 * non-exclusive, royalty free, license to use, modify and
 * redistribute this software in source and binary code form, provided
 * that the following conditions are met:
 *
 * 1. Acknowledgement of the program authors must be made in any
 *    publication of scientific results based in part on use of the
 *    program.  An acceptable form of acknowledgement is citation of
 *    the article in which the program was described (Matthew
 *    A. Meineke, Charles F. Vardeman II, Teng Lin, Christopher
 *    J. Fennell and J. Daniel Gezelter, "OOPSE: An Object-Oriented
 *    Parallel Simulation Engine for Molecular Dynamics,"
 *    J. Comput. Chem. 26, pp. 252-271 (2005))
 *
 * 2. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 3. 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.
 *
 * This software is provided "AS IS," without a warranty of any
 * kind. All express or implied conditions, representations and
 * warranties, including any implied warranty of merchantability,
 * fitness for a particular purpose or non-infringement, are hereby
 * excluded.  The University of Notre Dame and its licensors shall not
 * be liable for any damages suffered by licensee as a result of
 * using, modifying or distributing the software or its
 * derivatives. In no event will the University of Notre Dame or its
 * licensors be liable for any lost revenue, profit or data, or for
 * direct, indirect, special, consequential, incidental or punitive
 * damages, however caused and regardless of the theory of liability,
 * arising out of the use of or inability to use software, even if the
 * University of Notre Dame has been advised of the possibility of
 * such damages.
 */
 
/**
 * @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:	246
Committed:	Wed Jan 12 22:41:40 2005 UTC (20 years, 9 months ago) by gezelter
File size:	4552 byte(s)
Log Message:	merging new_design branch into OOPSE-2.0
#	Content
1	/*
2	* Copyright (c) 2005 The University of Notre Dame. All Rights Reserved.
3	*
4	* The University of Notre Dame grants you ("Licensee") a
5	* non-exclusive, royalty free, license to use, modify and
6	* redistribute this software in source and binary code form, provided
7	* that the following conditions are met:
8	*
9	* 1. Acknowledgement of the program authors must be made in any
10	* publication of scientific results based in part on use of the
11	* program. An acceptable form of acknowledgement is citation of
12	* the article in which the program was described (Matthew
13	* A. Meineke, Charles F. Vardeman II, Teng Lin, Christopher
14	* J. Fennell and J. Daniel Gezelter, "OOPSE: An Object-Oriented
15	* Parallel Simulation Engine for Molecular Dynamics,"
16	* J. Comput. Chem. 26, pp. 252-271 (2005))
17	*
18	* 2. Redistributions of source code must retain the above copyright
19	* notice, this list of conditions and the following disclaimer.
20	*
21	* 3. Redistributions in binary form must reproduce the above copyright
22	* notice, this list of conditions and the following disclaimer in the
23	* documentation and/or other materials provided with the
24	* distribution.
25	*
26	* This software is provided "AS IS," without a warranty of any
27	* kind. All express or implied conditions, representations and
28	* warranties, including any implied warranty of merchantability,
29	* fitness for a particular purpose or non-infringement, are hereby
30	* excluded. The University of Notre Dame and its licensors shall not
31	* be liable for any damages suffered by licensee as a result of
32	* using, modifying or distributing the software or its
33	* derivatives. In no event will the University of Notre Dame or its
34	* licensors be liable for any lost revenue, profit or data, or for
35	* direct, indirect, special, consequential, incidental or punitive
36	* damages, however caused and regardless of the theory of liability,
37	* arising out of the use of or inability to use software, even if the
38	* University of Notre Dame has been advised of the possibility of
39	* such damages.
40	*/
41
42	/**
43	* @file ChebyshevPolynomials.hpp
44	* @author teng lin
45	* @date 11/16/2004
46	* @version 1.0
47	*/
48
49	#ifndef MATH_CHEBYSHEVPOLYNOMIALS_HPP
50	#define MATH_CHEBYSHEVPOLYNOMIALS_HPP
51
52	#include <vector>
53
54	#include "math/Polynomial.hpp"
55
56	namespace oopse {
57
58	/**
59	* @class ChebyshevPolynomials
60	* A collection of Chebyshev Polynomials.
61	* @todo document
62	*/
63	class ChebyshevPolynomials {
64	public:
65	ChebyshevPolynomials(int maxPower);
66
67	/**
68	* Calculates the value of the nth Chebyshev Polynomial evaluated at the given x value.
69	* @return The value of the nth Chebyshev Polynomial evaluates at the given x value
70	* @param n
71	* @param x the value of the independent variable for the nth Chebyshev Polynomial function
72	*/
73
74	double evaluate(int n, double x) {
75	assert (n <= maxPower_ && n >=0);
76	return polyList_[n].evaluate(x);
77	}
78
79	/**
80	* Returns the first derivative of the nth Chebyshev Polynomial.
81	* @return the first derivative of the nth Chebyshev Polynomial
82	* @param n
83	* @param x the value of the independent variable for the nth Chebyshev Polynomial function
84	*/
85	double evaluateDerivative(int n, double x) {
86	assert (n <= maxPower_ && n >=0);
87	return polyList_[n].evaluateDerivative(x);
88	}
89
90	/**
91	* Returns the nth Chebyshev Polynomial
92	* @return the nth Chebyshev Polynomial
93	* @param n
94	*/
95	const DoublePolynomial& getChebyshevPolynomial(int n) const {
96	assert (n <= maxPower_ && n >=0);
97	return polyList_[n];
98	}
99
100	protected:
101
102	std::vector<DoublePolynomial> polyList_;
103
104	private:
105
106	void GeneratePolynomials(int maxPower);
107	virtual void GenerateFirstTwoTerms() = 0;
108
109	int maxPower_;
110	};
111
112	/**
113	* @class ChebyshevT
114	* @todo document
115	*/
116	class ChebyshevT : public ChebyshevPolynomials {
117	public:
118	ChebyshevT(int maxPower) :ChebyshevPolynomials(maxPower) {}
119
120	private:
121	virtual void GenerateFirstTwoTerms();
122	};
123
124	/**
125	* @class ChebyshevU
126	* @todo document
127	*/
128	class ChebyshevU : public ChebyshevPolynomials {
129	public:
130	ChebyshevU(int maxPower) :ChebyshevPolynomials(maxPower) {}
131
132	private:
133	virtual void GenerateFirstTwoTerms();
134	};
135
136
137	} //end namespace oopse
138	#endif //MATH_CHEBYSHEVPOLYNOMIALS_HPP