Distribution.java

/*
 * JASA Java Auction Simulator API
 * Copyright (C) 2013 Steve Phelps
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation; either version 2 of
 * the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU General Public License for more details.
 */

package net.sourceforge.jabm.util;

/**
 * @author Steve Phelps
 * @version $Revision: 16 $
 */

public interface Distribution {

	/**
	 * Add a new datum to the series.
	 */
	public abstract void newData(double i);

	/**
	 * Get the number of items in the series.
	 */
	public abstract int getN();

	/**
	 * Get the mean of the data.
	 */
	public abstract double getMean();

	/**
	 * Get the variance about the mean.
	 */
	public abstract double getVariance();

	/**
	 * Get the standard deviation from the mean.
	 */
	public abstract double getStdDev();

	/**
	 * Get the coefficient of variable about origin.
	 */
//	public abstract double getVarCoef(double origin);

	/**
	 * Get the minimum datum.
	 */
	public abstract double getMin();

	/**
	 * Get the maximum datum.
	 */
	public abstract double getMax();

	/**
	 * Get the total of the data
	 */
	public abstract double getTotal();

	/**
	 * @return The name of the variable.
	 */
	public abstract String getName();

	/**
	 * Output the moments of the distribution to the info log.
	 */
	public abstract void log();
}