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.optimization;
19  
20  import org.apache.commons.math.MathException;
21  
22  /** 
23   * This class represents exceptions thrown by cost functions.
24   *
25   * @version $Revision: 620312 $ $Date: 2008-02-10 12:28:59 -0700 (Sun, 10 Feb 2008) $
26   * @since 1.2
27   */
28  
29  public class CostException
30    extends MathException {
31  
32      /** Serializable version identifier. */
33      private static final long serialVersionUID = 467695563268795689L;
34  
35      /**
36       * Constructs a new <code>MathException</code> with specified
37       * formatted detail message.
38       * Message formatting is delegated to {@link java.text.MessageFormat}.
39       * @param pattern format specifier
40       * @param arguments format arguments
41       */
42      public CostException(String pattern, Object[] arguments) {
43        super(pattern, arguments);
44      }
45  
46      /**
47       * Constructs a new <code>MathException</code> with specified
48       * nested <code>Throwable</code> root cause.
49       *
50       * @param rootCause  the exception or error that caused this exception
51       *                   to be thrown.
52       */
53      public CostException(Throwable rootCause) {
54          super(rootCause);
55      }
56      
57  }