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
018package org.apache.commons.math4.linear;
019
020import org.apache.commons.math4.exception.MathIllegalArgumentException;
021import org.apache.commons.math4.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 * @since 3.0
033 */
034public class NonPositiveDefiniteOperatorException
035    extends MathIllegalArgumentException {
036    /** Serializable version Id. */
037    private static final long serialVersionUID = 917034489420549847L;
038
039    /** Creates a new instance of this class. */
040    public NonPositiveDefiniteOperatorException() {
041        super(LocalizedFormats.NON_POSITIVE_DEFINITE_OPERATOR);
042    }
043}