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
18 package org.apache.commons.math4.legacy.linear;
19
20 import org.apache.commons.math4.legacy.exception.MathIllegalArgumentException;
21 import org.apache.commons.math4.legacy.exception.util.LocalizedFormats;
22
23 /**
24 * Exception to be thrown when a symmetric, definite positive
25 * {@link RealLinearOperator} is expected.
26 * Since the coefficients of the matrix are not accessible, the most
27 * general definition is used to check that {@code A} is not positive
28 * definite, i.e. there exists {@code x} such that {@code x' A x <= 0}.
29 * In the terminology of this exception, {@code A} is the "offending"
30 * linear operator and {@code x} the "offending" vector.
31 *
32 * @since 3.0
33 */
34 public class NonPositiveDefiniteOperatorException
35 extends MathIllegalArgumentException {
36 /** Serializable version Id. */
37 private static final long serialVersionUID = 917034489420549847L;
38
39 /** Creates a new instance of this class. */
40 public NonPositiveDefiniteOperatorException() {
41 super(LocalizedFormats.NON_POSITIVE_DEFINITE_OPERATOR);
42 }
43 }