mirror of https://github.com/jlizier/jidt
Adding package-info.java files for Javadocs for the various packages
This commit is contained in:
parent
4f8137b449
commit
e7b8958fda
|
|
@ -0,0 +1,12 @@
|
|||
/**
|
||||
* This package contains estimators for the
|
||||
* information dynamics measures which assume the data
|
||||
* is Gaussian with linear relationships.
|
||||
*
|
||||
* <p>These estimators apply to continuous data
|
||||
* (i.e. double[] or double[][] data).</p>
|
||||
*
|
||||
* @author Joseph Lizier (<a href="joseph.lizier at gmail.com">email</a>,
|
||||
* <a href="http://lizier.me/joseph/">www</a>)
|
||||
*/
|
||||
package infodynamics.measures.continuous.gaussian;
|
||||
|
|
@ -0,0 +1,12 @@
|
|||
/**
|
||||
* This package contains estimators for the
|
||||
* information dynamics measures which
|
||||
* use box-kernel estimation.
|
||||
*
|
||||
* <p>These estimators apply to continuous data
|
||||
* (i.e. double[] or double[][] data).</p>
|
||||
*
|
||||
* @author Joseph Lizier (<a href="joseph.lizier at gmail.com">email</a>,
|
||||
* <a href="http://lizier.me/joseph/">www</a>)
|
||||
*/
|
||||
package infodynamics.measures.continuous.kernel;
|
||||
|
|
@ -0,0 +1,12 @@
|
|||
/**
|
||||
* This package contains estimators for the
|
||||
* information dynamics measures which
|
||||
* use the Kozachenko-Leonenko method.
|
||||
*
|
||||
* <p>These estimators apply to continuous data
|
||||
* (i.e. double[] or double[][] data).</p>
|
||||
*
|
||||
* @author Joseph Lizier (<a href="joseph.lizier at gmail.com">email</a>,
|
||||
* <a href="http://lizier.me/joseph/">www</a>)
|
||||
*/
|
||||
package infodynamics.measures.continuous.kozachenko;
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
/**
|
||||
* This package contains estimators for the
|
||||
* information dynamics measures which
|
||||
* use the Kraskov-Stoegbauer-Grassberger (KSG)
|
||||
* method.
|
||||
*
|
||||
* <p>These estimators apply to continuous data
|
||||
* (i.e. double[] or double[][] data).</p>
|
||||
*
|
||||
* @author Joseph Lizier (<a href="joseph.lizier at gmail.com">email</a>,
|
||||
* <a href="http://lizier.me/joseph/">www</a>)
|
||||
*/
|
||||
package infodynamics.measures.continuous.kraskov;
|
||||
|
|
@ -0,0 +1,12 @@
|
|||
/**
|
||||
* This package contains Java Interfaces for each of the
|
||||
* information dynamics measures as applied to continuous data
|
||||
* (i.e. double[] or double[][] data).
|
||||
*
|
||||
* <p>Subpackages provides various estimator types which implement
|
||||
* these interfaces.</p>
|
||||
*
|
||||
* @author Joseph Lizier (<a href="joseph.lizier at gmail.com">email</a>,
|
||||
* <a href="http://lizier.me/joseph/">www</a>)
|
||||
*/
|
||||
package infodynamics.measures.continuous;
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
/**
|
||||
* This package contains estimators for the
|
||||
* information dynamics measures which
|
||||
* use permutation entropy or symbolic
|
||||
* methods.
|
||||
*
|
||||
* <p>These estimators apply to continuous data
|
||||
* (i.e. double[] or double[][] data).</p>
|
||||
*
|
||||
* @author Joseph Lizier (<a href="joseph.lizier at gmail.com">email</a>,
|
||||
* <a href="http://lizier.me/joseph/">www</a>)
|
||||
*/
|
||||
package infodynamics.measures.continuous.symbolic;
|
||||
|
|
@ -0,0 +1,9 @@
|
|||
/**
|
||||
* This package contains Java classes for each of the
|
||||
* information dynamics measures as applied to discrete data
|
||||
* (i.e. int[] or int[][] data).
|
||||
*
|
||||
* @author Joseph Lizier (<a href="joseph.lizier at gmail.com">email</a>,
|
||||
* <a href="http://lizier.me/joseph/">www</a>)
|
||||
*/
|
||||
package infodynamics.measures.discrete;
|
||||
|
|
@ -0,0 +1,16 @@
|
|||
/**
|
||||
* This package contains Java Interfaces for each of the
|
||||
* information dynamics measures as applied to
|
||||
* mixed continuous-discrete data
|
||||
* (i.e. double[] or double[][] data mixed with int[]
|
||||
* or int[][] data).
|
||||
*
|
||||
* <p>Subpackages provides various estimator types which implement
|
||||
* these interfaces.</p>
|
||||
*
|
||||
* <p>These are EXPERIMENTAL, not well documented or tested.</p>
|
||||
*
|
||||
* @author Joseph Lizier (<a href="joseph.lizier at gmail.com">email</a>,
|
||||
* <a href="http://lizier.me/joseph/">www</a>)
|
||||
*/
|
||||
package infodynamics.measures.mixed;
|
||||
|
|
@ -0,0 +1,11 @@
|
|||
/**
|
||||
* This package contains classes for effective
|
||||
* connectivity analysis at a regional level.
|
||||
*
|
||||
* <p>See the demo for interregional connectivity for more
|
||||
* information.</p>
|
||||
*
|
||||
* @author Joseph Lizier (<a href="joseph.lizier at gmail.com">email</a>,
|
||||
* <a href="http://lizier.me/joseph/">www</a>)
|
||||
*/
|
||||
package infodynamics.networkinference.interregional;
|
||||
|
|
@ -0,0 +1,8 @@
|
|||
/**
|
||||
* This package contains utility classes to
|
||||
* support the calculators in other packages
|
||||
*
|
||||
* @author Joseph Lizier (<a href="joseph.lizier at gmail.com">email</a>,
|
||||
* <a href="http://lizier.me/joseph/">www</a>)
|
||||
*/
|
||||
package infodynamics.utils;
|
||||
Loading…
Reference in New Issue