org.apache.commons.math
Class MaxIterationsExceededException

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by org.apache.commons.math.MathException
              extended by org.apache.commons.math.ConvergenceException
                  extended by org.apache.commons.math.MaxIterationsExceededException
All Implemented Interfaces:
Serializable

public class MaxIterationsExceededException
extends ConvergenceException

Error thrown when a numerical computation exceeds its allowed number of iterations.

Since:
1.2
Version:
$Revision: 746578 $ $Date: 2009-02-21 15:01:14 -0500 (Sat, 21 Feb 2009) $
See Also:
Serialized Form

Constructor Summary
MaxIterationsExceededException(int maxIterations)
          Constructs an exception with specified formatted detail message.
MaxIterationsExceededException(int maxIterations, String pattern, Object... arguments)
          Constructs an exception with specified formatted detail message.
 
Method Summary
 int getMaxIterations()
          Get the maximal number of iterations allowed.
 
Methods inherited from class org.apache.commons.math.MathException
getArguments, getLocalizedMessage, getMessage, getPattern, printStackTrace, printStackTrace
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getMessage, getStackTrace, initCause, printStackTrace, setStackTrace, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

MaxIterationsExceededException

public MaxIterationsExceededException(int maxIterations)
Constructs an exception with specified formatted detail message. Message formatting is delegated to MessageFormat.

Parameters:
maxIterations - maximal number of iterations allowed

MaxIterationsExceededException

public MaxIterationsExceededException(int maxIterations,
                                      String pattern,
                                      Object... arguments)
Constructs an exception with specified formatted detail message. Message formatting is delegated to MessageFormat.

Parameters:
maxIterations - the exceeded maximal number of iterations
pattern - format specifier
arguments - format arguments
Method Detail

getMaxIterations

public int getMaxIterations()
Get the maximal number of iterations allowed.

Returns:
maximal number of iterations allowed


Copyright © 2003-2011 Apache Software Foundation. All Rights Reserved.