View Javadoc

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.math;
19  
20  /**
21   * Error thrown when a method is called with an out of bounds argument.
22   *
23   * @since 1.2
24   * @version $Revision: 746578 $ $Date: 2009-02-21 15:01:14 -0500 (Sat, 21 Feb 2009) $
25   */
26  public class ArgumentOutsideDomainException extends FunctionEvaluationException {
27  
28      /** Serializable version identifier. */
29      private static final long serialVersionUID = -4965972841162580234L;
30  
31      /**
32       * Constructs an exception with specified formatted detail message.
33       * Message formatting is delegated to {@link java.text.MessageFormat}.
34       * @param argument  the failing function argument 
35       * @param lower lower bound of the domain
36       * @param upper upper bound of the domain
37       */
38      public ArgumentOutsideDomainException(double argument, double lower, double upper) {
39          super(argument,
40                "Argument {0} outside domain [{1} ; {2}]", argument, lower, upper);
41      }
42  
43  }