001    /*
002     * Licensed to the Apache Software Foundation (ASF) under one or more
003     * contributor license agreements.  See the NOTICE file distributed with
004     * this work for additional information regarding copyright ownership.
005     * The ASF licenses this file to You under the Apache License, Version 2.0
006     * (the "License"); you may not use this file except in compliance with
007     * the License.  You may obtain a copy of the License at
008     *
009     *      http://www.apache.org/licenses/LICENSE-2.0
010     *
011     * Unless required by applicable law or agreed to in writing, software
012     * distributed under the License is distributed on an "AS IS" BASIS,
013     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014     * See the License for the specific language governing permissions and
015     * limitations under the License.
016     */
017    
018    package org.apache.commons.math3.linear;
019    
020    import org.apache.commons.math3.exception.MathIllegalArgumentException;
021    import org.apache.commons.math3.exception.util.LocalizedFormats;
022    
023    /**
024     * Exception to be thrown when a symmetric, definite positive
025     * {@link RealLinearOperator} is expected.
026     * Since the coefficients of the matrix are not accessible, the most
027     * general definition is used to check that {@code A} is not positive
028     * definite, i.e.  there exists {@code x} such that {@code x' A x <= 0}.
029     * In the terminology of this exception, {@code A} is the "offending"
030     * linear operator and {@code x} the "offending" vector.
031     *
032     * @version $Id: NonPositiveDefiniteOperatorException.java 1416643 2012-12-03 19:37:14Z tn $
033     * @since 3.0
034     */
035    public class NonPositiveDefiniteOperatorException
036        extends MathIllegalArgumentException {
037        /** Serializable version Id. */
038        private static final long serialVersionUID = 917034489420549847L;
039    
040        /** Creates a new instance of this class. */
041        public NonPositiveDefiniteOperatorException() {
042            super(LocalizedFormats.NON_POSITIVE_DEFINITE_OPERATOR);
043        }
044    }