Package org.apache.commons.math4.exception

Class MultiDimensionMismatchException

java.lang.Object
java.lang.Throwable
java.lang.Exception
java.lang.RuntimeException
org.apache.commons.math4.exception.MathRuntimeException
org.apache.commons.math4.exception.MathIllegalArgumentException
org.apache.commons.math4.exception.MultiDimensionMismatchException
All Implemented Interfaces:
java.io.Serializable, ExceptionContextProvider
Direct Known Subclasses:
MatrixDimensionMismatchException
public class MultiDimensionMismatchException
extends MathIllegalArgumentException
Exception to be thrown when two sets of dimensions differ.
Since:
3.0
See Also:
Serialized Form

  • Constructor Summary

    Constructors 
    Constructor Description
    MultiDimensionMismatchException​(java.lang.Integer[] wrong, java.lang.Integer[] expected)
    Construct an exception from the mismatched dimensions.
    MultiDimensionMismatchException​(Localizable specific, java.lang.Integer[] wrong, java.lang.Integer[] expected)
    Construct an exception from the mismatched dimensions.

  • Method Summary

    Modifier and Type Method Description
    int getExpectedDimension​(int index)  
    java.lang.Integer[] getExpectedDimensions()  
    int getWrongDimension​(int index)  
    java.lang.Integer[] getWrongDimensions()  

    Methods inherited from class org.apache.commons.math4.exception.MathRuntimeException

    getContext, getLocalizedMessage, getMessage

    Methods inherited from class java.lang.Throwable

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

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • MultiDimensionMismatchException

      public MultiDimensionMismatchException​(java.lang.Integer[] wrong, java.lang.Integer[] expected)
      Construct an exception from the mismatched dimensions.
      Parameters:
      wrong - Wrong dimensions.
      expected - Expected dimensions.

    • MultiDimensionMismatchException

      public MultiDimensionMismatchException​(Localizable specific, java.lang.Integer[] wrong, java.lang.Integer[] expected)
      Construct an exception from the mismatched dimensions.
      Parameters:
      specific - Message pattern providing the specific context of the error.
      wrong - Wrong dimensions.
      expected - Expected dimensions.

  • Method Details

    • getWrongDimensions

      public java.lang.Integer[] getWrongDimensions()
      Returns:
      an array containing the wrong dimensions.

    • getExpectedDimensions

      public java.lang.Integer[] getExpectedDimensions()
      Returns:
      an array containing the expected dimensions.

    • getWrongDimension

      public int getWrongDimension​(int index)
      Parameters:
      index - Dimension index.
      Returns:
      the wrong dimension stored at index.

    • getExpectedDimension

      public int getExpectedDimension​(int index)
      Parameters:
      index - Dimension index.
      Returns:
      the expected dimension stored at index.