org.apache.commons.math3.linear
Class NonPositiveDefiniteMatrixException

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by java.lang.RuntimeException
              extended by java.lang.IllegalArgumentException
                  extended by org.apache.commons.math3.exception.MathIllegalArgumentException
                      extended by org.apache.commons.math3.exception.MathIllegalNumberException
                          extended by org.apache.commons.math3.exception.NumberIsTooSmallException
                              extended by org.apache.commons.math3.linear.NonPositiveDefiniteMatrixException
All Implemented Interfaces:
java.io.Serializable, ExceptionContextProvider

public class NonPositiveDefiniteMatrixException
extends NumberIsTooSmallException

Exception to be thrown when a positive definite matrix is expected.

Since:
3.0
Version:
$Id: NonPositiveDefiniteMatrixException.java 1416643 2012-12-03 19:37:14Z tn $
See Also:
Serialized Form

Field Summary
private  int index
          Index (diagonal element).
private static long serialVersionUID
          Serializable version Id.
private  double threshold
          Threshold.
 
Constructor Summary
NonPositiveDefiniteMatrixException(double wrong, int index, double threshold)
          Construct an exception.
 
Method Summary
 int getColumn()
           
 int getRow()
           
 double getThreshold()
           
 
Methods inherited from class org.apache.commons.math3.exception.NumberIsTooSmallException
getBoundIsAllowed, getMin
 
Methods inherited from class org.apache.commons.math3.exception.MathIllegalNumberException
getArgument
 
Methods inherited from class org.apache.commons.math3.exception.MathIllegalArgumentException
getContext, getLocalizedMessage, getMessage
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

serialVersionUID

private static final long serialVersionUID
Serializable version Id.

See Also:
Constant Field Values

index

private final int index
Index (diagonal element).


threshold

private final double threshold
Threshold.

Constructor Detail

NonPositiveDefiniteMatrixException

public NonPositiveDefiniteMatrixException(double wrong,
                                          int index,
                                          double threshold)
Construct an exception.

Parameters:
wrong - Value that fails the positivity check.
index - Row (and column) index.
threshold - Absolute positivity threshold.
Method Detail

getRow

public int getRow()
Returns:
the row index.

getColumn

public int getColumn()
Returns:
the column index.

getThreshold

public double getThreshold()
Returns:
the absolute positivity threshold.


Copyright (c) 2003-2013 Apache Software Foundation