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
018package org.apache.commons.math3.optimization;
019
020import 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 * @deprecated As of 3.1 (to be removed in 4.0).
034 * @since 3.0
035 */
036@Deprecated
037public interface BaseMultivariateSimpleBoundsOptimizer<FUNC extends MultivariateFunction>
038    extends BaseMultivariateOptimizer<FUNC> {
039    /**
040     * Optimize an objective function.
041     *
042     * @param f Objective function.
043     * @param goalType Type of optimization goal: either
044     * {@link GoalType#MAXIMIZE} or {@link GoalType#MINIMIZE}.
045     * @param startPoint Start point for optimization.
046     * @param maxEval Maximum number of function evaluations.
047     * @param lowerBound Lower bound for each of the parameters.
048     * @param upperBound Upper bound for each of the parameters.
049     * @return the point/value pair giving the optimal value for objective
050     * function.
051     * @throws org.apache.commons.math3.exception.DimensionMismatchException
052     * if the array sizes are wrong.
053     * @throws org.apache.commons.math3.exception.TooManyEvaluationsException
054     * if the maximal number of evaluations is exceeded.
055     * @throws org.apache.commons.math3.exception.NullArgumentException if
056     * {@code f}, {@code goalType} or {@code startPoint} is {@code null}.
057     * @throws org.apache.commons.math3.exception.NumberIsTooSmallException if any
058     * of the initial values is less than its lower bound.
059     * @throws org.apache.commons.math3.exception.NumberIsTooLargeException if any
060     * of the initial values is greater than its upper bound.
061     */
062    PointValuePair optimize(int maxEval, FUNC f, GoalType goalType,
063                                double[] startPoint,
064                                double[] lowerBound, double[] upperBound);
065}