summaryrefslogtreecommitdiff
path: root/src/main/java/org/apache/commons/math3/linear/MatrixDimensionMismatchException.java
diff options
context:
space:
mode:
Diffstat (limited to 'src/main/java/org/apache/commons/math3/linear/MatrixDimensionMismatchException.java')
-rw-r--r--src/main/java/org/apache/commons/math3/linear/MatrixDimensionMismatchException.java75
1 files changed, 75 insertions, 0 deletions
diff --git a/src/main/java/org/apache/commons/math3/linear/MatrixDimensionMismatchException.java b/src/main/java/org/apache/commons/math3/linear/MatrixDimensionMismatchException.java
new file mode 100644
index 0000000..20b10b1
--- /dev/null
+++ b/src/main/java/org/apache/commons/math3/linear/MatrixDimensionMismatchException.java
@@ -0,0 +1,75 @@
+/*
+ * 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
+ */
+public class MatrixDimensionMismatchException extends MultiDimensionMismatchException {
+ /** Serializable version Id. */
+ private static final long serialVersionUID = -8415396756375798143L;
+
+ /**
+ * 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});
+ }
+
+ /**
+ * @return the expected row dimension.
+ */
+ public int getWrongRowDimension() {
+ return getWrongDimension(0);
+ }
+
+ /**
+ * @return the expected row dimension.
+ */
+ public int getExpectedRowDimension() {
+ return getExpectedDimension(0);
+ }
+
+ /**
+ * @return the wrong column dimension.
+ */
+ public int getWrongColumnDimension() {
+ return getWrongDimension(1);
+ }
+
+ /**
+ * @return the expected column dimension.
+ */
+ public int getExpectedColumnDimension() {
+ return getExpectedDimension(1);
+ }
+}