Merge pull request #697 from RyanGrange/issue642

Root Finding: Throw exception for invalid accuracy values.

src/Numerics/RootFinding/Bisection.cs

@@ -41,7 +41,7 @@ namespace MathNet.Numerics.RootFinding
         /// <param name="f">The function to find roots from.</param>
         /// <param name="guessLowerBound">Guess for the low value of the range where the root is supposed to be. Will be expanded if needed.</param>
         /// <param name="guessUpperBound">Guess for the  high value of the range where the root is supposed to be. Will be expanded if needed.</param>
-        /// <param name="accuracy">Desired accuracy. The root will be refined until the accuracy or the maximum number of iterations is reached. Default 1e-8.</param>
+        /// <param name="accuracy">Desired accuracy. The root will be refined until the accuracy or the maximum number of iterations is reached. Default 1e-8. Must be greater than 0.</param>
         /// <param name="maxIterations">Maximum number of iterations. Default 100.</param>
         /// <param name="expandFactor">Factor at which to expand the bounds, if needed. Default 1.6.</param>
         /// <param name="maxExpandIteratons">Maximum number of expand iterations. Default 100.</param>
@@ -49,6 +49,11 @@ namespace MathNet.Numerics.RootFinding
         /// <exception cref="NonConvergenceException"></exception>
         public static double FindRootExpand(Func<double, double> f, double guessLowerBound, double guessUpperBound, double accuracy = 1e-8, int maxIterations = 100, double expandFactor = 1.6, int maxExpandIteratons = 100)
         {
+            if (accuracy <= 0)
+            {
+                throw new ArgumentOutOfRangeException(nameof(accuracy), "Must be greater than zero.");
+            }
+
             ZeroCrossingBracketing.ExpandReduce(f, ref guessLowerBound, ref guessUpperBound, expandFactor, maxExpandIteratons, maxExpandIteratons*10);
             return FindRoot(f, guessLowerBound, guessUpperBound, accuracy, maxIterations);
         }
@@ -57,12 +62,17 @@ namespace MathNet.Numerics.RootFinding
         /// <param name="f">The function to find roots from.</param>
         /// <param name="lowerBound">The low value of the range where the root is supposed to be.</param>
         /// <param name="upperBound">The high value of the range where the root is supposed to be.</param>
-        /// <param name="accuracy">Desired accuracy. The root will be refined until the accuracy or the maximum number of iterations is reached. Default 1e-8.</param>
+        /// <param name="accuracy">Desired accuracy. The root will be refined until the accuracy or the maximum number of iterations is reached. Default 1e-8. Must be greater than 0.</param>
         /// <param name="maxIterations">Maximum number of iterations. Default 100.</param>
         /// <returns>Returns the root with the specified accuracy.</returns>
         /// <exception cref="NonConvergenceException"></exception>
         public static double FindRoot(Func<double, double> f, double lowerBound, double upperBound, double accuracy = 1e-14, int maxIterations = 100)
         {
+            if (accuracy <= 0)
+            {
+                throw new ArgumentOutOfRangeException(nameof(accuracy), "Must be greater than zero.");
+            }
+
             double root;
             if (TryFindRoot(f, lowerBound, upperBound, accuracy, maxIterations, out root))
             {
@@ -76,12 +86,17 @@ namespace MathNet.Numerics.RootFinding
         /// <param name="f">The function to find roots from.</param>
         /// <param name="lowerBound">The low value of the range where the root is supposed to be.</param>
         /// <param name="upperBound">The high value of the range where the root is supposed to be.</param>
-        /// <param name="accuracy">Desired accuracy for both the root and the function value at the root. The root will be refined until the accuracy or the maximum number of iterations is reached.</param>
+        /// <param name="accuracy">Desired accuracy for both the root and the function value at the root. The root will be refined until the accuracy or the maximum number of iterations is reached. Must be greater than 0.</param>
         /// <param name="maxIterations">Maximum number of iterations. Usually 100.</param>
         /// <param name="root">The root that was found, if any. Undefined if the function returns false.</param>
         /// <returns>True if a root with the specified accuracy was found, else false.</returns>
         public static bool TryFindRoot(Func<double, double> f, double lowerBound, double upperBound, double accuracy, int maxIterations, out double root)
         {
+            if (accuracy <= 0)
+            {
+                throw new ArgumentOutOfRangeException(nameof(accuracy), "Must be greater than zero.");
+            }
+
             if (upperBound < lowerBound)
             {
                 var t = upperBound;

src/Numerics/RootFinding/Brent.cs

@@ -42,7 +42,7 @@ namespace MathNet.Numerics.RootFinding
         /// <param name="f">The function to find roots from.</param>
         /// <param name="guessLowerBound">Guess for the low value of the range where the root is supposed to be. Will be expanded if needed.</param>
         /// <param name="guessUpperBound">Guess for the  high value of the range where the root is supposed to be. Will be expanded if needed.</param>
-        /// <param name="accuracy">Desired accuracy. The root will be refined until the accuracy or the maximum number of iterations is reached. Default 1e-8.</param>
+        /// <param name="accuracy">Desired accuracy. The root will be refined until the accuracy or the maximum number of iterations is reached. Default 1e-8. Must be greater than 0.</param>
         /// <param name="maxIterations">Maximum number of iterations. Default 100.</param>
         /// <param name="expandFactor">Factor at which to expand the bounds, if needed. Default 1.6.</param>
         /// <param name="maxExpandIteratons">Maximum number of expand iterations. Default 100.</param>
@@ -58,12 +58,17 @@ namespace MathNet.Numerics.RootFinding
         /// <param name="f">The function to find roots from.</param>
         /// <param name="lowerBound">The low value of the range where the root is supposed to be.</param>
         /// <param name="upperBound">The high value of the range where the root is supposed to be.</param>
-        /// <param name="accuracy">Desired accuracy. The root will be refined until the accuracy or the maximum number of iterations is reached. Default 1e-8.</param>
+        /// <param name="accuracy">Desired accuracy. The root will be refined until the accuracy or the maximum number of iterations is reached. Default 1e-8. Must be greater than 0.</param>
         /// <param name="maxIterations">Maximum number of iterations. Default 100.</param>
         /// <returns>Returns the root with the specified accuracy.</returns>
         /// <exception cref="NonConvergenceException"></exception>
         public static double FindRoot(Func<double, double> f, double lowerBound, double upperBound, double accuracy = 1e-8, int maxIterations = 100)
         {
+            if (accuracy <= 0)
+            {
+                throw new ArgumentOutOfRangeException(nameof(accuracy), "Must be greater than zero.");
+            }
+
             double root;
             if (TryFindRoot(f, lowerBound, upperBound, accuracy, maxIterations, out root))
             {
@@ -77,12 +82,17 @@ namespace MathNet.Numerics.RootFinding
         /// <param name="f">The function to find roots from.</param>
         /// <param name="lowerBound">The low value of the range where the root is supposed to be.</param>
         /// <param name="upperBound">The high value of the range where the root is supposed to be.</param>
-        /// <param name="accuracy">Desired accuracy. The root will be refined until the accuracy or the maximum number of iterations is reached.</param>
+        /// <param name="accuracy">Desired accuracy. The root will be refined until the accuracy or the maximum number of iterations is reached. Must be greater than 0.</param>
         /// <param name="maxIterations">Maximum number of iterations. Usually 100.</param>
         /// <param name="root">The root that was found, if any. Undefined if the function returns false.</param>
         /// <returns>True if a root with the specified accuracy was found, else false.</returns>
         public static bool TryFindRoot(Func<double, double> f, double lowerBound, double upperBound, double accuracy, int maxIterations, out double root)
         {
+            if (accuracy <= 0)
+            {
+                throw new ArgumentOutOfRangeException(nameof(accuracy), "Must be greater than zero.");
+            }
+
             double fmin = f(lowerBound);
             double fmax = f(upperBound);
             double froot = fmax;