/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.commons.math3.optimization;
import org.apache.commons.math3.analysis.MultivariateFunction;
/**
* This interface is mainly intended to enforce the internal coherence of Commons-FastMath. Users of
* the API are advised to base their code on the following interfaces:
*
*
* - {@link org.apache.commons.math3.optimization.MultivariateOptimizer}
*
- {@link org.apache.commons.math3.optimization.MultivariateDifferentiableOptimizer}
*
*
* @param Type of the objective function to be optimized.
* @deprecated As of 3.1 (to be removed in 4.0).
* @since 3.0
*/
@Deprecated
public interface BaseMultivariateOptimizer
extends BaseOptimizer {
/**
* Optimize an objective function.
*
* @param f Objective function.
* @param goalType Type of optimization goal: either {@link GoalType#MAXIMIZE} or {@link
* GoalType#MINIMIZE}.
* @param startPoint Start point for optimization.
* @param maxEval Maximum number of function evaluations.
* @return the point/value pair giving the optimal value for objective function.
* @throws org.apache.commons.math3.exception.DimensionMismatchException if the start point
* dimension is wrong.
* @throws org.apache.commons.math3.exception.TooManyEvaluationsException if the maximal number
* of evaluations is exceeded.
* @throws org.apache.commons.math3.exception.NullArgumentException if any argument is {@code
* null}.
* @deprecated As of 3.1. In 4.0, it will be replaced by the declaration corresponding to this
* {@link
* org.apache.commons.math3.optimization.direct.BaseAbstractMultivariateOptimizer#optimize(int,MultivariateFunction,GoalType,OptimizationData[])
* method}.
*/
@Deprecated
PointValuePair optimize(int maxEval, FUNC f, GoalType goalType, double[] startPoint);
}