org.apache.commons.math3.exception

## Class MultiDimensionMismatchException

- java.lang.Object
- - java.lang.Throwable
  - - java.lang.Exception
    - - java.lang.RuntimeException
      - - java.lang.IllegalArgumentException
        - - org.apache.commons.math3.exception.MathIllegalArgumentException
          - - org.apache.commons.math3.exception.MultiDimensionMismatchException

All Implemented Interfaces:
  Serializable, ExceptionContextProvider

Direct Known Subclasses:
  MatrixDimensionMismatchException

    public class MultiDimensionMismatchException
    extends MathIllegalArgumentException

Exception to be thrown when two sets of dimensions differ.

Since:
  3.0
Version:
  $Id: MultiDimensionMismatchException.java 1364378 2012-07-22 17:42:38Z tn $
See Also:
  Serialized Form

### Field Summary

Fields
`private Integer[]` `expected` Correct dimensions.
`private static long` `serialVersionUID` Serializable version Id.
`private Integer[]` `wrong` Wrong dimensions.

### Constructor Summary

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

### Method Summary

Methods
`int` `getExpectedDimension(int index)`
`Integer[]` `getExpectedDimensions()`
`int` `getWrongDimension(int index)`
`Integer[]` `getWrongDimensions()`

### 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

#### wrong

    private final Integer[] wrong

Wrong dimensions.

#### expected

    private final Integer[] expected

Correct dimensions.

### Constructor Detail

#### MultiDimensionMismatchException

    public MultiDimensionMismatchException(Integer[] wrong,
                                   Integer[] expected)

Construct an exception from the mismatched dimensions.

Parameters:
  `wrong` - Wrong dimensions.
  `expected` - Expected dimensions.

#### MultiDimensionMismatchException

    public MultiDimensionMismatchException(Localizable specific,
                                   Integer[] wrong,
                                   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 Detail

#### getWrongDimensions

    public Integer[] getWrongDimensions()

Returns:
  an array containing the wrong dimensions.

#### getExpectedDimensions

    public 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`.