diff options
Diffstat (limited to 'src/main/java/org/apache/commons/math3/analysis/solvers/AbstractUnivariateDifferentiableSolver.java')
-rw-r--r-- | src/main/java/org/apache/commons/math3/analysis/solvers/AbstractUnivariateDifferentiableSolver.java | 82 |
1 files changed, 82 insertions, 0 deletions
diff --git a/src/main/java/org/apache/commons/math3/analysis/solvers/AbstractUnivariateDifferentiableSolver.java b/src/main/java/org/apache/commons/math3/analysis/solvers/AbstractUnivariateDifferentiableSolver.java new file mode 100644 index 0000000..9745e9b --- /dev/null +++ b/src/main/java/org/apache/commons/math3/analysis/solvers/AbstractUnivariateDifferentiableSolver.java @@ -0,0 +1,82 @@ +/* + * 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.analysis.solvers; + +import org.apache.commons.math3.analysis.differentiation.DerivativeStructure; +import org.apache.commons.math3.analysis.differentiation.UnivariateDifferentiableFunction; +import org.apache.commons.math3.exception.TooManyEvaluationsException; + +/** + * Provide a default implementation for several functions useful to generic + * solvers. + * + * @since 3.1 + */ +public abstract class AbstractUnivariateDifferentiableSolver + extends BaseAbstractUnivariateSolver<UnivariateDifferentiableFunction> + implements UnivariateDifferentiableSolver { + + /** Function to solve. */ + private UnivariateDifferentiableFunction function; + + /** + * Construct a solver with given absolute accuracy. + * + * @param absoluteAccuracy Maximum absolute error. + */ + protected AbstractUnivariateDifferentiableSolver(final double absoluteAccuracy) { + super(absoluteAccuracy); + } + + /** + * Construct a solver with given accuracies. + * + * @param relativeAccuracy Maximum relative error. + * @param absoluteAccuracy Maximum absolute error. + * @param functionValueAccuracy Maximum function value error. + */ + protected AbstractUnivariateDifferentiableSolver(final double relativeAccuracy, + final double absoluteAccuracy, + final double functionValueAccuracy) { + super(relativeAccuracy, absoluteAccuracy, functionValueAccuracy); + } + + /** + * Compute the objective function value. + * + * @param point Point at which the objective function must be evaluated. + * @return the objective function value and derivative at specified point. + * @throws TooManyEvaluationsException + * if the maximal number of evaluations is exceeded. + */ + protected DerivativeStructure computeObjectiveValueAndDerivative(double point) + throws TooManyEvaluationsException { + incrementEvaluationCount(); + return function.value(new DerivativeStructure(1, 1, 0, point)); + } + + /** + * {@inheritDoc} + */ + @Override + protected void setup(int maxEval, UnivariateDifferentiableFunction f, + double min, double max, double startValue) { + super.setup(maxEval, f, min, max, startValue); + function = f; + } +} |