mirror of https://github.com/jlizier/jidt
48 lines
2.1 KiB
Java
Executable File
48 lines
2.1 KiB
Java
Executable File
package infodynamics.measures.continuous;
|
|
|
|
/**
|
|
* <p>This specifies the interface for implementations of
|
|
* the transfer entropy (see Schreiber, PRL, 2000)
|
|
* and local transfer entropy (see Lizier et al, PRE, 2008).
|
|
* This is the <i>apparent</i> transfer entropy; i.e.
|
|
* we compute the transfer that appears to come from a single
|
|
* source variable, without examining any other potential sources
|
|
* (see Lizier et al, PRE, 2008).</p>
|
|
*
|
|
* <p>Specifically, this specifies the interface for computing
|
|
* the transfer entropy for <i>continuous</i>-valued,
|
|
* <i>multivariate</i> sources and destinations.</p>
|
|
*
|
|
*
|
|
* @see "Schreiber, Physical Review Letters 85 (2) pp.461-464, 2000;
|
|
* <a href='http://dx.doi.org/10.1103/PhysRevLett.85.461'>download</a>
|
|
* (for definition of transfer entropy)"
|
|
* @see "Lizier, Prokopenko and Zomaya, Physical Review E 77, 026110, 2008;
|
|
* <a href='http://dx.doi.org/10.1103/PhysRevE.77.026110'>download</a>
|
|
* (for definition of <i>local</i> transfer entropy and qualification
|
|
* of naming it as <i>apparent</i> transfer entropy)"
|
|
* @see "J.T. Lizier, J. Heinzle, A. Horstmann, J.-D. Haynes, M. Prokopenko,
|
|
* Journal of Computational Neuroscience, vol. 30, pp. 85-107, 2011
|
|
* <a href='http://dx.doi.org/10.1007/s10827-010-0271-2'>download</a>
|
|
* (for definition of <i>multivariate</i> transfer entropy"
|
|
*
|
|
* @author Joseph Lizier, <a href="joseph.lizier at gmail.com">email</a>,
|
|
* <a href="http://lizier.me/joseph/">www</a>
|
|
*
|
|
*/
|
|
public interface TransferEntropyCalculatorMultiVariate extends ChannelCalculatorMultiVariate {
|
|
|
|
/**
|
|
* Initialise the calculator for re-use with new observations.
|
|
* History length k, source and destination dimensions are
|
|
* specified here; all other parameters remain unchanged.
|
|
*
|
|
* @param k history length to be considered
|
|
* @param sourceDimensions number of joint variables in the source
|
|
* @param destDimensions number of joint variables in the destination
|
|
* @throws Exception
|
|
*/
|
|
public void initialise(int k, int sourceDimensions, int destDimensions) throws Exception;
|
|
|
|
}
|