src/main/cpp/numerics4cpp/root/bisection.h

00001 /*
00002  * Copyright (c) 2005, DoodleProject
00003  * All rights reserved.
00004  * 
00005  * Redistribution and use in source and binary forms, with or without
00006  * modification, are permitted provided that the following conditions
00007  * are met:
00008  * 
00009  * Redistributions of source code must retain the above copyright
00010  * notice, this list of conditions and the following disclaimer.
00011  * 
00012  * Redistributions in binary form must reproduce the above copyright
00013  * notice, this list of conditions and the following disclaimer in
00014  * the documentation and/or other materials provided with the
00015  * distribution.
00016  * 
00017  * Neither the name of DoodleProject nor the names of its contributors
00018  * may be used to endorse or promote products derived from this
00019  * software without specific prior written permission.
00020  * 
00021  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
00022  * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
00023  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
00024  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00025  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS
00026  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00027  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
00028  * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
00029  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
00030  * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
00031  * TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
00032  * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
00033  * SUCH DAMAGE.
00034  */
00035 
00036 #ifndef _NUMERICS4CPP_ROOT_BISECTION_H_
00037 #define _NUMERICS4CPP_ROOT_BISECTION_H_
00038 
00039 #include <cmath>
00040 #include <limits>
00041 #include "../iterativemethod.h"
00042 #include "../math.h"
00043 
00044 NUM_NAMESPACE_BEGIN
00045 
00071 template<class Function>
00072 class bisection_root_finder : public iterative_method {
00073 
00074 public:
00081         bisection_root_finder(Function& f, unsigned int iterations = 100, double relative_error = 1.0e-15) : iterative_method(iterations, relative_error), _function(f) {
00082         }
00083         
00092         double find_root(double min, double max) {
00093         double m;
00094         double fm;
00095         double fmin;
00096 
00097         if (is_nan(min) || is_nan(max)) {
00098             return std::numeric_limits<double>::quiet_NaN();
00099         }
00100         
00101         unsigned int i = 0;
00102         while (i < maximum_iterations()) {
00103             m = min + (max - min) / 2.0;
00104             fmin = _function(min);
00105             fm = _function(m);
00106 
00107             if (fm * fmin > 0.0) {
00108                 // max and m bracket the root.
00109                 min = m;
00110                 fmin = fm;
00111             } else {
00112                 // min and m bracket the root.
00113                 max = m;
00114             }
00115 
00116             if (std::fabs(std::max(std::fabs(fm), m / min - 1.0)) <= maximum_relative_error()) {
00117                 return min + (max - min) / 2.0;
00118             }
00119             ++i;
00120         }
00121 
00122         throw convergence_exception("Maximum number of iterations exceeded.");
00123         }
00124                         
00125 private:
00127         Function& _function;
00128 };
00129 
00130 NUM_NAMESPACE_END
00131 
00132 #endif

Generated on Wed Nov 21 22:22:15 2007 for numerics4c++ by  doxygen 1.5.3