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.MultivariateVectorFunction; 021 022/** 023 * This interface is mainly intended to enforce the internal coherence of 024 * Commons-Math. 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.DifferentiableMultivariateVectorOptimizer}</li> 028 * </ul> 029 * 030 * @param <FUNC> Type of the objective function to be optimized. 031 * 032 * @deprecated As of 3.1 (to be removed in 4.0). 033 * @since 3.0 034 */ 035@Deprecated 036public interface BaseMultivariateVectorOptimizer<FUNC extends MultivariateVectorFunction> 037 extends BaseOptimizer<PointVectorValuePair> { 038 /** 039 * Optimize an objective function. 040 * Optimization is considered to be a weighted least-squares minimization. 041 * The cost function to be minimized is 042 * <code>∑weight<sub>i</sub>(objective<sub>i</sub> - target<sub>i</sub>)<sup>2</sup></code> 043 * 044 * @param f Objective function. 045 * @param target Target value for the objective functions at optimum. 046 * @param weight Weights for the least squares cost computation. 047 * @param startPoint Start point for optimization. 048 * @return the point/value pair giving the optimal value for objective 049 * function. 050 * @param maxEval Maximum number of function evaluations. 051 * @throws org.apache.commons.math3.exception.DimensionMismatchException 052 * if the start point dimension is 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 * any argument is {@code null}. 057 * @deprecated As of 3.1. In 4.0, this will be replaced by the declaration 058 * corresponding to this {@link org.apache.commons.math3.optimization.direct.BaseAbstractMultivariateVectorOptimizer#optimize(int,MultivariateVectorFunction,OptimizationData[]) method}. 059 */ 060 @Deprecated 061 PointVectorValuePair optimize(int maxEval, FUNC f, double[] target, 062 double[] weight, double[] startPoint); 063}