src/main/cpp/numerics4cpp/iterativemethod.h

/*
 * 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_ITERATIVEMETHOD_H_
#define _NUMERICS4CPP_ITERATIVEMETHOD_H_

#include "math.h"
#include "exception/exception.h"

NUM_NAMESPACE_BEGIN

class iterative_method {
        
public:
        iterative_method(unsigned int iterations = 100, double relative_error = 1.0e-10) {
                maximum_iterations(iterations);
                maximum_relative_error(relative_error);
        }
        
        unsigned int maximum_iterations() const {
                return _maximum_iterations;
        }
        
        void maximum_iterations(unsigned int iterations) {
                if (iterations == 0) {
            throw invalid_argument_exception("Maximum iterations must be positive.");
                }
                _maximum_iterations = iterations;
        }
        
        double maximum_relative_error() const {
                return _maximum_relative_error;
        }
        
        void maximum_relative_error(double relative_error) {
        if (relative_error <= 0.0 || is_nan(relative_error)) {
                        throw invalid_argument_exception("Maximum relative error must be positive.");
                }
                _maximum_relative_error = relative_error;
        }       
        
private:
    unsigned int _maximum_iterations;

    double _maximum_relative_error;
};

NUM_NAMESPACE_END

#endif

---