org.apache.commons.math3.optim.AbstractConvergenceChecker Maven / Gradle / Ivy
The newest version!
/*
* 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;
/**
* Base class for all convergence checker implementations.
*
* @param Type of (point, value) pair.
*
* @since 3.0
*/
public abstract class AbstractConvergenceChecker
implements ConvergenceChecker {
/**
* Relative tolerance threshold.
*/
private final double relativeThreshold;
/**
* Absolute tolerance threshold.
*/
private final double absoluteThreshold;
/**
* Build an instance with a specified thresholds.
*
* @param relativeThreshold relative tolerance threshold
* @param absoluteThreshold absolute tolerance threshold
*/
public AbstractConvergenceChecker(final double relativeThreshold,
final double absoluteThreshold) {
this.relativeThreshold = relativeThreshold;
this.absoluteThreshold = absoluteThreshold;
}
/**
* @return the relative threshold.
*/
public double getRelativeThreshold() {
return relativeThreshold;
}
/**
* @return the absolute threshold.
*/
public double getAbsoluteThreshold() {
return absoluteThreshold;
}
/**
* {@inheritDoc}
*/
public abstract boolean converged(int iteration,
PAIR previous,
PAIR current);
}