summaryrefslogtreecommitdiff
path: root/src/main/java/org/apache/commons/math3/linear/NonSelfAdjointOperatorException.java
blob: f98a6238c58479e09be351722a772d3116f95c39 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
/*
 * 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.MathIllegalArgumentException;
import org.apache.commons.math3.exception.util.LocalizedFormats;

/**
 * Exception to be thrown when a self-adjoint {@link RealLinearOperator} is expected. Since the
 * coefficients of the matrix are not accessible, the most general definition is used to check that
 * A is not self-adjoint, i.e. there exist x and y such as {@code | x' A y - y' A x | >= eps}, where
 * {@code eps} is a user-specified tolerance, and {@code x'} denotes the transpose of {@code x}. In
 * the terminology of this exception, {@code A} is the "offending" linear operator, {@code x} and
 * {@code y} are the first and second "offending" vectors, respectively.
 *
 * @since 3.0
 */
public class NonSelfAdjointOperatorException extends MathIllegalArgumentException {
    /** Serializable version Id. */
    private static final long serialVersionUID = 1784999305030258247L;

    /** Creates a new instance of this class. */
    public NonSelfAdjointOperatorException() {
        super(LocalizedFormats.NON_SELF_ADJOINT_OPERATOR);
    }
}