net.sf.sparql.benchmarking.stats.OperationStats Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of core Show documentation
An API for benchmarking the performance of queries against arbitrary SPARQL endpoint
The newest version!
/*
Copyright 2011-2014 Cray Inc. All Rights Reserved

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:

* Redistributions of source code must retain the above copyright
  notice, this list of conditions and the following disclaimer.

* Redistributions in binary form must reproduce the above copyright
  notice, this list of conditions and the following disclaimer in the
  documentation and/or other materials provided with the distribution.

* Neither the name Cray Inc. nor the names of its contributors may be
  used to endorse or promote products derived from this software
  without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
*/

package net.sf.sparql.benchmarking.stats;

import java.util.Iterator;
import java.util.List;
import java.util.Map;

import net.sf.sparql.benchmarking.parallel.ParallelTimer;

/**
 * Interface for classes that store and represent statistics about an operation
 * 
 * @author rvesse
 * 
 */
public interface OperationStats {

    /**
     * Gets an iterator over the operation runs
     * 
     * @return Runs of the operation
     */
    public abstract Iterator getRuns();

    /**
     * Gets the number of runs for the operation
     * 
     * @return Number of runs
     */
    public abstract long getRunCount();

    /**
     * Gets the total runtime for the query over all runs
     * 
     * @return Total Runtime in nanoseconds
     */
    public abstract long getTotalRuntime();

    /**
     * Gets the actual runtime for the operation over all runs (takes into
     * account operations that run in parallel)
     * 
     * @return Actual Runtime in nanoseconds
     */
    public abstract long getActualRuntime();

    /**
     * Gets the total response time for the operations over all runs
     * 
     * For non-streaming operations this will likely be equal to
     * {@link #getTotalRuntime()}
     * 
     * 
     * @return Total response time
     */
    public abstract long getTotalResponseTime();

    /**
     * Gets the average runtime for the operation over all runs (arithmetic
     * mean) based on the total runtime
     * 
     * @return Arithmetic Average Runtime in nanoseconds
     */
    public abstract long getAverageRuntime();

    /**
     * Gets the average response time over all runs (arithmetic mean) based on
     * the total response time
     * 
     * For non-streaming operations this will likely be equal to
     * {@link #getAverageRuntime()}
     * 
     * 
     * @return Average Response Time in nanoseconds
     */
    public abstract long getAverageResponseTime();

    /**
     * Gets the average runtime for the operation over all runs (geometric mean)
     * based on the total runtime
     * 
     * @return Geometric Average Runtime in nanoseconds
     */
    public abstract double getGeometricAverageRuntime();

    /**
     * Gets average runtime for the operation over all runs (arithmetic mean)
     * based on the actual runtime
     * 
     * @return Arithmetic Average runtime in nanoseconds
     */
    public abstract long getActualAverageRuntime();

    /**
     * Gets the minimum runtime for this operation over all runs
     * 
     * @return Minimum Runtime in nanoseconds
     */
    public abstract long getMinimumRuntime();

    /**
     * Gets the maximum runtime for this operation over all runs
     * 
     * @return Maximum Runtime in nanoseconds
     */
    public abstract long getMaximumRuntime();

    /**
     * Gets the variance for the operation runtimes
     * 
     * @return Runtime Variance in nanoseconds squared
     */
    public abstract double getVariance();

    /**
     * Gets the standard deviation for operation runtime
     * 
     * @return Runtime Standard Deviation in nanoseconds
     */
    public abstract double getStandardDeviation();

    /**
     * Gets the total number of times this operation resulted in an error
     * 
     * @return Total number of errors
     */
    public abstract long getTotalErrors();

    /**
     * Gets the information for all errors grouped by category
     * 
     * @return Errors grouped by category
     */
    public abstract Map> getCategorizedErrors();

    /**
     * Gets the total number of results for this operation
     * 
     * @return Total number of results
     */
    public abstract long getTotalResults();

    /**
     * Gets the average number of results
     * 
     * @return Average number of results
     */
    public abstract long getAverageResults();

    /**
     * Calculates how many times this operation could be executed
     * single-threaded per second based upon the average runtime of the
     * operation
     * 
     * @return Operations per Second
     */
    public abstract double getOperationsPerSecond();

    /**
     * Calculates how many times this operation could be executed multi-threaded
     * per second based upon the {@link #getActualAverageRuntime()}
     * 
     * @return Actual Operations per Second
     */
    public abstract double getActualOperationsPerSecond();

    /**
     * Calculates how many times this operation could be executed
     * single-threaded per hour based upon the average runtime of the operation
     * 
     * @return Operations per Hour
     */
    public abstract double getOperationsPerHour();

    /**
     * Calculates how many times this operation could be executed multi-threaded
     * per hour based upon the {@link #getActualAverageRuntime()}
     * 
     * @return Actual Operations per Hour
     */
    public abstract double getActualOperationsPerHour();

    /**
     * Adds information for the given run to the statistics
     * 
     * @param run
     *            Run information
     */
    public abstract void add(OperationRun run);

    /**
     * Clears all run statistics
     */
    public abstract void clear();

    /**
     * Trims the best and worst N runs
     * 
     * @param outliers
     *            Number of outliers to trim
     */
    public abstract void trim(int outliers);

    /**
     * Gets the parallel timer used to track actual runtime
     * 
     * @return Parallel timer
     */
    public abstract ParallelTimer getTimer();
}