org.apache.commons.math3.optim.AbstractOptimizationProblem Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of commons-math3 Show documentation
Show all versions of commons-math3 Show documentation
The Apache Commons Math project is a library of lightweight, self-contained mathematics and statistics components addressing the most common practical problems not immediately available in the Java programming language or commons-lang.
/*
* 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.optim;
import org.apache.commons.math3.exception.TooManyEvaluationsException;
import org.apache.commons.math3.exception.TooManyIterationsException;
import org.apache.commons.math3.util.Incrementor;
/**
* Base class for implementing optimization problems. It contains the boiler-plate code
* for counting the number of evaluations of the objective function and the number of
* iterations of the algorithm, and storing the convergence checker.
*
* @param Type of the point/value pair returned by the optimization algorithm.
* @since 3.3
*/
public abstract class AbstractOptimizationProblem
implements OptimizationProblem {
/** Callback to use for the evaluation counter. */
private static final MaxEvalCallback MAX_EVAL_CALLBACK = new MaxEvalCallback();
/** Callback to use for the iteration counter. */
private static final MaxIterCallback MAX_ITER_CALLBACK = new MaxIterCallback();
/** max evaluations */
private final int maxEvaluations;
/** max iterations */
private final int maxIterations;
/** Convergence checker. */
private final ConvergenceChecker checker;
/**
* Create an {@link AbstractOptimizationProblem} from the given data.
*
* @param maxEvaluations the number of allowed model function evaluations.
* @param maxIterations the number of allowed iterations.
* @param checker the convergence checker.
*/
protected AbstractOptimizationProblem(final int maxEvaluations,
final int maxIterations,
final ConvergenceChecker checker) {
this.maxEvaluations = maxEvaluations;
this.maxIterations = maxIterations;
this.checker = checker;
}
/** {@inheritDoc} */
public Incrementor getEvaluationCounter() {
return new Incrementor(this.maxEvaluations, MAX_EVAL_CALLBACK);
}
/** {@inheritDoc} */
public Incrementor getIterationCounter() {
return new Incrementor(this.maxIterations, MAX_ITER_CALLBACK);
}
/** {@inheritDoc} */
public ConvergenceChecker getConvergenceChecker() {
return checker;
}
/** Defines the action to perform when reaching the maximum number of evaluations. */
private static class MaxEvalCallback
implements Incrementor.MaxCountExceededCallback {
/**
* {@inheritDoc}
*
* @throws TooManyEvaluationsException
*/
public void trigger(int max) {
throw new TooManyEvaluationsException(max);
}
}
/** Defines the action to perform when reaching the maximum number of evaluations. */
private static class MaxIterCallback
implements Incrementor.MaxCountExceededCallback {
/**
* {@inheritDoc}
*
* @throws TooManyIterationsException
*/
public void trigger(int max) {
throw new TooManyIterationsException(max);
}
}
}