es.urjc.etsii.grafo.experiment.reference.ReferenceResult Maven / Gradle / Ivy

Go to download
package es.urjc.etsii.grafo.experiment.reference;

import java.util.Optional;

import static es.urjc.etsii.grafo.util.TimeUtil.secsToNanos;

/**
 * Reference result for an instance
 */
public class ReferenceResult {
    private double score = Double.NaN;
    private double timeInSeconds = Double.NaN;
    private double timeToBestInSeconds = Double.NaN;
    private boolean isOptimalValue = false;

    /**
     * get score for this instance, or NaN if not defined
     *
     * @return score, NaN if not defined
     */
    public double getScoreOrNan() {
        return score;
    }

    /**
     * Get score if present, never NaN.
     *
     * @return optional score
     */
    public Optional getScore(){
        return Double.isNaN(this.score) ? Optional.empty() : Optional.of(this.score);
    }

    /**
     * get time in seconds needed to generate this reference value
     *
     * @return time in seconds
     */
    public double getTimeInSeconds() {
        return timeInSeconds;
    }

    /**
     * get time in seconds needed to generate this reference value
     *
     * @return time to best in seconds
     */
    public double getTimeToBestInSeconds() {
        return timeToBestInSeconds;
    }


    /**
     * Set score
     *
     * @param score score
     * @return ReferenceResult
     */
    public ReferenceResult setScore(double score) {
        this.score = score;
        return this;
    }

    /**
     * Set score parsing double from the given string
     *
     * @param score as a string
     * @return ReferenceResult
     */
    public ReferenceResult setScore(String score) {
        this.setScore(Double.parseDouble(score));
        return this;
    }

    /**
     * Setter for the field timeInSeconds.
     *
     * @param timeInSeconds a double.
     * @return ReferenceResult
     */
    public ReferenceResult setTimeInSeconds(double timeInSeconds) {
        this.timeInSeconds = timeInSeconds;
        return this;
    }

    /**
     * Setter for the field timeInSeconds.
     *
     * @param timeInSeconds a {@link java.lang.String} object.
     * @return ReferenceResult
     */
    public ReferenceResult setTimeInSeconds(String timeInSeconds) {
        return this.setTimeInSeconds(Double.parseDouble(timeInSeconds));
    }

    /**
     * Setter for the field timeToBestInSeconds.
     *
     * @param timeToBestInSeconds a double.
     * @return ReferenceResult
     */
    public ReferenceResult setTimeToBestInSeconds(double timeToBestInSeconds) {
        this.timeToBestInSeconds = timeToBestInSeconds;
        return this;
    }

    /**
     * Setter for the field timeToBestInSeconds.
     *
     * @param timeToBestInSeconds a {@link java.lang.String} object.
     * @return ReferenceResult
     */
    public ReferenceResult setTimeToBestInSeconds(String timeToBestInSeconds) {
        return this.setTimeToBestInSeconds(Double.parseDouble(timeToBestInSeconds));
    }

    /**
     * Get execution time in nanoseconds
     * @return execution time in nanoseconds
     */
    public long getTimeInNanos(){
        return secsToNanos(this.timeInSeconds);
    }

    /**
     * Get time to best in nanoseconds
     * @return time to best in nanoseconds
     */
    public long getTimeToBestInNanos(){
        return secsToNanos(this.timeToBestInSeconds);
    }

    /**
     * Is the current reference value returned by {@link ReferenceResult#getScore()} optimal?
     * @return True if the value returned by getScore is known to be optimal, false otherwise
     */
    public boolean isOptimalValue() {
        return isOptimalValue;
    }

    /**
     * Specify if the value provided in {@link ReferenceResult#setScore(double)} ()} is optimal.
     * If not specified, defaults to false.
     * @param isOptimal True if the value returned by getScore is known to be optimal, false otherwise
     */
    public void setOptimalValue(boolean isOptimal) {
        isOptimalValue = isOptimal;
    }
}