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    *      https://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  
18  /*
19   * This is not the original file distributed by the Apache Software Foundation
20   * It has been modified by the Hipparchus project
21   */
22  package org.hipparchus.migration.linear;
23  
24  
25  /**
26   * Exception to be thrown when a positive definite matrix is expected.
27   *
28   * @deprecated as of 1.0, this exception is replaced by {@link org.hipparchus.exception.MathIllegalArgumentException}
29   */
30  @Deprecated
31  public class NonPositiveDefiniteMatrixException
32      extends org.hipparchus.migration.exception.NumberIsTooSmallException {
33      /** Serializable version Id. */
34      private static final long serialVersionUID = 1641613838113738061L;
35      /** Index (diagonal element). */
36      private final int index;
37      /** Threshold. */
38      private final double threshold;
39  
40      /**
41       * Construct an exception.
42       *
43       * @param wrong Value that fails the positivity check.
44       * @param index Row (and column) index.
45       * @param threshold Absolute positivity threshold.
46       */
47      public NonPositiveDefiniteMatrixException(double wrong,
48                                                int index,
49                                                double threshold) {
50          super(wrong, threshold, false);
51          this.index = index;
52          this.threshold = threshold;
53  
54      }
55  
56      /** Get row index.
57       * @return the row index
58       */
59      public int getRow() {
60          return index;
61      }
62  
63      /** Get column index.
64       * @return the column index
65       */
66      public int getColumn() {
67          return index;
68      }
69  
70      /** Get absolute positivity threshold.
71       * @return the absolute positivity threshold
72       */
73      public double getThreshold() {
74          return threshold;
75      }
76  
77  }