repicea.stats.CentralMomentsGettable Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of repicea-mathstats Show documentation

Mathematical and statistical methods

There is a newer version: 1.4.3

/*
 * This file is part of the repicea-statistics library.
 *
 * Copyright (C) 2009-2012 Mathieu Fortin for Rouge-Epicea
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * This library is distributed with 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 Lesser General Public
 * License for more details.
 *
 * Please see the license at http://www.gnu.org/copyleft/lesser.html.
 */
package repicea.stats;

import repicea.math.AbstractMatrix;


/**
 * The CentralMomentsGettable interface ensures the mean and the variance are available.
 * @author Mathieu Fortin - August 2012
 * 
 * @param  an AbstractMatrix-derived class that stands for the mean
 * @param  an AbstractMatrix-derived class that stands for the variance
 */
public interface CentralMomentsGettable {

	/**
	 * This method returns the first central moment, i.e. the mean vector, of the random variable.
	 * @return an AbstractMatrix-derived instance
	 */
	public M getMean();
	
	/**
	 * This method returns the second central moment, i.e. the variance-covariance matrix, of the random variable.
	 * @return an AbstractMatrix-derived instance
	 */
	public V getVariance();


}