src/main/cpp/numerics4cpp/series/series.h

Go to the documentation of this file.

/*
 * Copyright (c) 2005, DoodleProject
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 
 * Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 * 
 * 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.
 * 
 * Neither the name of DoodleProject nor the names of its contributors
 * may be used to endorse or promote products derived from this
 * software without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
 * CONTRIBUTORS "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 THE COPYRIGHT OWNER OR 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.
 */

#ifndef _NUMERICS4CPP_SERIES_SERIES_H_
#define _NUMERICS4CPP_SERIES_SERIES_H_

#include <cmath>
#include "../iterativemethod.h"
#include "../exception/exception.h"

NUM_NAMESPACE_BEGIN

template<class Term>
class series : public iterative_method {

public:
        series(Term& t, unsigned int first = 0, unsigned int iterations = 100, double relative_error = 1.0e-15) : iterative_method(iterations, relative_error), _first_index(first), _term(t) {
        }
        
    ~series() {
    }

        double evaluate(double x) {
                unsigned int n = _first_index;
        unsigned iterations = 0;
                double sum = 0.0;
                double t;
        
                do {
                    t = _term(n, x);
                    sum += t;
            ++n;
            ++iterations;
        } while (iterations <= maximum_iterations() && std::fabs(sum / (sum - t) - 1.0) > maximum_relative_error());
        
                if (n > maximum_iterations()) {
                    throw convergence_exception("Series evaluation failed to converge.");
                }
        
                return sum;
        }
        
private:
    unsigned int _first_index;

    Term& _term;
};

typedef double series_term(unsigned int, double);

NUM_NAMESPACE_END

#endif

---