/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.commons.math3.linear;
import org.apache.commons.math3.exception.MultiDimensionMismatchException;
import org.apache.commons.math3.exception.util.LocalizedFormats;
Exception to be thrown when either the number of rows or the number of
columns of a matrix do not match the expected values.
Since: 3.0
/**
* Exception to be thrown when either the number of rows or the number of
* columns of a matrix do not match the expected values.
*
* @since 3.0
*/
public class MatrixDimensionMismatchException extends MultiDimensionMismatchException {
Serializable version Id. /** Serializable version Id. */
private static final long serialVersionUID = -8415396756375798143L;
Construct an exception from the mismatched dimensions.
Params: - wrongRowDim – Wrong row dimension.
- wrongColDim – Wrong column dimension.
- expectedRowDim – Expected row dimension.
- expectedColDim – Expected column dimension.
/**
* Construct an exception from the mismatched dimensions.
*
* @param wrongRowDim Wrong row dimension.
* @param wrongColDim Wrong column dimension.
* @param expectedRowDim Expected row dimension.
* @param expectedColDim Expected column dimension.
*/
public MatrixDimensionMismatchException(int wrongRowDim,
int wrongColDim,
int expectedRowDim,
int expectedColDim) {
super(LocalizedFormats.DIMENSIONS_MISMATCH_2x2,
new Integer[] { wrongRowDim, wrongColDim },
new Integer[] { expectedRowDim, expectedColDim });
}
Returns: the expected row dimension.
/**
* @return the expected row dimension.
*/
public int getWrongRowDimension() {
return getWrongDimension(0);
}
Returns: the expected row dimension.
/**
* @return the expected row dimension.
*/
public int getExpectedRowDimension() {
return getExpectedDimension(0);
}
Returns: the wrong column dimension.
/**
* @return the wrong column dimension.
*/
public int getWrongColumnDimension() {
return getWrongDimension(1);
}
Returns: the expected column dimension.
/**
* @return the expected column dimension.
*/
public int getExpectedColumnDimension() {
return getExpectedDimension(1);
}
}