1/*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements.  See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License.  You may obtain a copy of the License at
8 *
9 *      http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17
18package org.apache.commons.math.linear;
19
20import org.apache.commons.math.MathRuntimeException;
21import org.apache.commons.math.exception.util.DummyLocalizable;
22import org.apache.commons.math.exception.util.Localizable;
23
24/**
25 * Thrown when an operation addresses a matrix coordinate (row, col)
26 * which is outside of the dimensions of a matrix.
27 * @version $Revision: 1073255 $ $Date: 2011-02-22 09:42:06 +0100 (mar. 22 févr. 2011) $
28 */
29public class MatrixIndexException extends MathRuntimeException {
30
31    /** Serializable version identifier */
32    private static final long serialVersionUID = 8120540015829487660L;
33
34    /**
35     * Constructs a new instance with specified formatted detail message.
36     * @param pattern format specifier
37     * @param arguments format arguments
38     * @deprecated as of 2.2 replaced by {@link #MatrixIndexException(Localizable, Object...)}
39     */
40    @Deprecated
41    public MatrixIndexException(final String pattern, final Object ... arguments) {
42      this(new DummyLocalizable(pattern), arguments);
43    }
44
45    /**
46     * Constructs a new instance with specified formatted detail message.
47     * @param pattern format specifier
48     * @param arguments format arguments
49     * @since 2.2
50     */
51    public MatrixIndexException(final Localizable pattern, final Object ... arguments) {
52      super(pattern, arguments);
53    }
54
55}
56