View Javadoc
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  package org.apache.commons.math4.legacy.linear;
18  
19  import org.apache.commons.math4.legacy.exception.MathIllegalArgumentException;
20  import org.apache.commons.math4.legacy.exception.util.LocalizedFormats;
21  
22  /**
23   * An exception to be thrown when the condition number of a
24   * {@link RealLinearOperator} is too high.
25   *
26   * @since 3.0
27   */
28  public class IllConditionedOperatorException
29      extends MathIllegalArgumentException {
30      /** Serializable version Id. */
31      private static final long serialVersionUID = -7883263944530490135L;
32  
33      /**
34       * Creates a new instance of this class.
35       *
36       * @param cond An estimate of the condition number of the offending linear
37       * operator.
38       */
39      public IllConditionedOperatorException(final double cond) {
40          super(LocalizedFormats.ILL_CONDITIONED_OPERATOR, cond);
41      }
42  }