org.apache.commons.math

Class MaxIterationsExceededException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.apache.commons.math.MathException

org.apache.commons.math.ConvergenceException

org.apache.commons.math.MaxIterationsExceededException

All Implemented Interfaces:

java.io.Serializable, MathThrowable

public class MaxIterationsExceededException
extends ConvergenceException

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

Since:

1.2

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
MaxIterationsExceededException(int maxIterations) Constructs an exception with a default detail message.
MaxIterationsExceededException(int maxIterations, Localizable pattern, java.lang.Object... arguments) Constructs an exception with specified formatted detail message.
MaxIterationsExceededException(int maxIterations, java.lang.String pattern, java.lang.Object... arguments) Deprecated. as of 2.2 replaced by MaxIterationsExceededException(int, Localizable, Object...)

Method Summary

Modifier and Type	Method and Description
int	getMaxIterations() Get the maximal number of iterations allowed.

Methods inherited from class org.apache.commons.math.MathException

getArguments, getGeneralPattern, getLocalizedMessage, getMessage, getMessage, getPattern, getSpecificPattern, printStackTrace, printStackTrace

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getStackTrace, getSuppressed, initCause, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

MaxIterationsExceededException

public MaxIterationsExceededException(int maxIterations)

Constructs an exception with a default detail message.

Parameters:

maxIterations - maximal number of iterations allowed

MaxIterationsExceededException

@Deprecated
public MaxIterationsExceededException(int maxIterations,
                                                  java.lang.String pattern,
                                                  java.lang.Object... arguments)

Deprecated. as of 2.2 replaced by MaxIterationsExceededException(int, Localizable, Object...)

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

MaxIterationsExceededException

public MaxIterationsExceededException(int maxIterations,
                                      Localizable pattern,
                                      java.lang.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

Since:

2.2

Method Detail

getMaxIterations

public int getMaxIterations()

Get the maximal number of iterations allowed.

Returns:

maximal number of iterations allowed