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
018 package org.apache.commons.math3.optimization;
019
020 import org.apache.commons.math3.analysis.MultivariateFunction;
021
022 /**
023 * This interface is mainly intended to enforce the internal coherence of
024 * Commons-FastMath. Users of the API are advised to base their code on
025 * the following interfaces:
026 * <ul>
027 * <li>{@link org.apache.commons.math3.optimization.MultivariateOptimizer}</li>
028 * <li>{@link org.apache.commons.math3.optimization.MultivariateDifferentiableOptimizer}</li>
029 * </ul>
030 *
031 * @param <FUNC> Type of the objective function to be optimized.
032 *
033 * @version $Id: BaseMultivariateSimpleBoundsOptimizer.java 1422230 2012-12-15 12:11:13Z erans $
034 * @deprecated As of 3.1 (to be removed in 4.0).
035 * @since 3.0
036 */
037 @Deprecated
038 public interface BaseMultivariateSimpleBoundsOptimizer<FUNC extends MultivariateFunction>
039 extends BaseMultivariateOptimizer<FUNC> {
040 /**
041 * Optimize an objective function.
042 *
043 * @param f Objective function.
044 * @param goalType Type of optimization goal: either
045 * {@link GoalType#MAXIMIZE} or {@link GoalType#MINIMIZE}.
046 * @param startPoint Start point for optimization.
047 * @param maxEval Maximum number of function evaluations.
048 * @param lowerBound Lower bound for each of the parameters.
049 * @param upperBound Upper bound for each of the parameters.
050 * @return the point/value pair giving the optimal value for objective
051 * function.
052 * @throws org.apache.commons.math3.exception.DimensionMismatchException
053 * if the array sizes are wrong.
054 * @throws org.apache.commons.math3.exception.TooManyEvaluationsException
055 * if the maximal number of evaluations is exceeded.
056 * @throws org.apache.commons.math3.exception.NullArgumentException if
057 * {@code f}, {@code goalType} or {@code startPoint} is {@code null}.
058 * @throws org.apache.commons.math3.exception.NumberIsTooSmallException if any
059 * of the initial values is less than its lower bound.
060 * @throws org.apache.commons.math3.exception.NumberIsTooLargeException if any
061 * of the initial values is greater than its upper bound.
062 */
063 PointValuePair optimize(int maxEval, FUNC f, GoalType goalType,
064 double[] startPoint,
065 double[] lowerBound, double[] upperBound);
066 }