cz.cuni.mff.d3s.spl.data.DataSnapshot Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of spl-evaluation-java Show documentation

Stochastice Performance Logic is a formalism for capturing performance assumptions. It is, for example, possible to capture assumption that newer version of a function bar is faster than the previous version or that library foobar is faster than library barfoo when rendering antialiased text. The purpose of this framework is to allow evaluation of SPL formulas inside Java applications.

There is a newer version: 1.0.4

Show newest version

/*
 * Copyright 2015 Charles University in Prague
 * Copyright 2015 Vojtech Horky
 * 
 * Licensed 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 cz.cuni.mff.d3s.spl.data;

/** A snapshot of the performance data.
 */
public interface DataSnapshot {
	/** Tells number of runs contained in this snapshot.
	 *
	 * @return Number of runs in the snapshot. 
	 */
	int getRunCount();
	
	/** Provides access to a specific run inside the snapshot.
	 * 
	 * @param index Run (zero based) index we want to retrieve.
	 * @return Run at given index.
	 * @throws IndexOutOfBoundsException When the index is either negative or
	 * greater or equal to run count.
	 */
	BenchmarkRun getRun(int index);
	
	/** Provides iteration over all runs inside the snapshot.
	 * 
	 * @return All runs in the order they were added.
	 */
	Iterable getRuns();
	
	/** Get access to historical data.
	 * 
	 * 
	 * This is needed for special interpretations that learn from historical
	 * data to better predict future trends.
	 * 
	 * 
	 * If there are not historical data, the method shall return null.
	 * If getting historical data is not supported, the method shall throw
	 * UnsupportedOperationException.
	 * 
	 * @return Data describing previous epoch (such as previous version).
	 * @throws UnsupportedOperationException This operation is not implemented.
	 */
	DataSnapshot getPreviousEpoch();
}