net.sourceforge.cilib.stoppingcondition.Maximum Maven / Gradle / Ivy

Go to download
/**           __  __
 *    _____ _/ /_/ /_    Computational Intelligence Library (CIlib)
 *   / ___/ / / / __ \   (c) CIRG @ UP
 *  / /__/ / / / /_/ /   http://cilib.net
 *  \___/_/_/_/_.___/
 */
package net.sourceforge.cilib.stoppingcondition;

import com.google.common.base.Preconditions;

/**
 * A stopping predicate used to stop an algorithm when a measurement is greater than or equal to a value.
 */
public class Maximum implements CompletionCalculator {
    
    private double percentage;
    
    public Maximum() {
        this.percentage = 0.0;
    }

    @Override
    public double getPercentage(double actualValue, double targetValue) {
        Preconditions.checkArgument(targetValue != 0.0, "targetValue cannot be zero.");
        percentage = Math.max(percentage, actualValue / targetValue);
        return Math.max(Math.min(percentage, 1.0), 0.0);
    }

    @Override
    public boolean apply(double actualValue, double targetValue) {
        return actualValue >= targetValue;
    }
}