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  /** 
21   * This interface represents a cost function to be minimized.
22   * @version $Revision: 620312 $ $Date: 2008-02-10 12:28:59 -0700 (Sun, 10 Feb 2008) $
23   * @since 1.2
24   */
25  public interface CostFunction {
26  
27  
28    /** 
29     * Compute the cost associated to the given parameters array.
30     * @param x parameters array
31     * @return cost associated to the parameters array
32     * @exception CostException if no cost can be computed for the parameters
33     * @see PointCostPair
34     */
35    public double cost(double[] x) throws CostException;
36  
37  }