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 */
017package org.apache.commons.math4.linear;
018
019import org.apache.commons.math4.exception.MathIllegalArgumentException;
020import org.apache.commons.math4.exception.util.LocalizedFormats;
021
022/**
023 * An exception to be thrown when the condition number of a
024 * {@link RealLinearOperator} is too high.
025 *
026 * @since 3.0
027 */
028public class IllConditionedOperatorException
029    extends MathIllegalArgumentException {
030    /** Serializable version Id. */
031    private static final long serialVersionUID = -7883263944530490135L;
032
033    /**
034     * Creates a new instance of this class.
035     *
036     * @param cond An estimate of the condition number of the offending linear
037     * operator.
038     */
039    public IllConditionedOperatorException(final double cond) {
040        super(LocalizedFormats.ILL_CONDITIONED_OPERATOR, cond);
041    }
042}