From e7b8958fdac60b5d84ee0af263b683949f0e16de Mon Sep 17 00:00:00 2001 From: "joseph.lizier" Date: Wed, 13 Aug 2014 15:36:10 +0000 Subject: [PATCH] Adding package-info.java files for Javadocs for the various packages --- .../continuous/gaussian/package-info.java | 12 ++++++++++++ .../measures/continuous/kernel/package-info.java | 12 ++++++++++++ .../continuous/kozachenko/package-info.java | 12 ++++++++++++ .../continuous/kraskov/package-info.java | 13 +++++++++++++ .../measures/continuous/package-info.java | 12 ++++++++++++ .../continuous/symbolic/package-info.java | 13 +++++++++++++ .../measures/discrete/package-info.java | 9 +++++++++ .../measures/mixed/package-info.java | 16 ++++++++++++++++ .../interregional/package-info.java | 11 +++++++++++ java/source/infodynamics/utils/package-info.java | 8 ++++++++ 10 files changed, 118 insertions(+) create mode 100755 java/source/infodynamics/measures/continuous/gaussian/package-info.java create mode 100755 java/source/infodynamics/measures/continuous/kernel/package-info.java create mode 100755 java/source/infodynamics/measures/continuous/kozachenko/package-info.java create mode 100755 java/source/infodynamics/measures/continuous/kraskov/package-info.java create mode 100755 java/source/infodynamics/measures/continuous/package-info.java create mode 100755 java/source/infodynamics/measures/continuous/symbolic/package-info.java create mode 100755 java/source/infodynamics/measures/discrete/package-info.java create mode 100755 java/source/infodynamics/measures/mixed/package-info.java create mode 100755 java/source/infodynamics/networkinference/interregional/package-info.java create mode 100755 java/source/infodynamics/utils/package-info.java diff --git a/java/source/infodynamics/measures/continuous/gaussian/package-info.java b/java/source/infodynamics/measures/continuous/gaussian/package-info.java new file mode 100755 index 0000000..d39f39f --- /dev/null +++ b/java/source/infodynamics/measures/continuous/gaussian/package-info.java @@ -0,0 +1,12 @@ +/** + * This package contains estimators for the + * information dynamics measures which assume the data + * is Gaussian with linear relationships. + * + *

These estimators apply to continuous data + * (i.e. double[] or double[][] data).

+ * + * @author Joseph Lizier (email, + * www) + */ +package infodynamics.measures.continuous.gaussian; diff --git a/java/source/infodynamics/measures/continuous/kernel/package-info.java b/java/source/infodynamics/measures/continuous/kernel/package-info.java new file mode 100755 index 0000000..163ccc7 --- /dev/null +++ b/java/source/infodynamics/measures/continuous/kernel/package-info.java @@ -0,0 +1,12 @@ +/** + * This package contains estimators for the + * information dynamics measures which + * use box-kernel estimation. + * + *

These estimators apply to continuous data + * (i.e. double[] or double[][] data).

+ * + * @author Joseph Lizier (email, + * www) + */ +package infodynamics.measures.continuous.kernel; diff --git a/java/source/infodynamics/measures/continuous/kozachenko/package-info.java b/java/source/infodynamics/measures/continuous/kozachenko/package-info.java new file mode 100755 index 0000000..a0ffa9d --- /dev/null +++ b/java/source/infodynamics/measures/continuous/kozachenko/package-info.java @@ -0,0 +1,12 @@ +/** + * This package contains estimators for the + * information dynamics measures which + * use the Kozachenko-Leonenko method. + * + *

These estimators apply to continuous data + * (i.e. double[] or double[][] data).

+ * + * @author Joseph Lizier (email, + * www) + */ +package infodynamics.measures.continuous.kozachenko; diff --git a/java/source/infodynamics/measures/continuous/kraskov/package-info.java b/java/source/infodynamics/measures/continuous/kraskov/package-info.java new file mode 100755 index 0000000..0e4a8f5 --- /dev/null +++ b/java/source/infodynamics/measures/continuous/kraskov/package-info.java @@ -0,0 +1,13 @@ +/** + * This package contains estimators for the + * information dynamics measures which + * use the Kraskov-Stoegbauer-Grassberger (KSG) + * method. + * + *

These estimators apply to continuous data + * (i.e. double[] or double[][] data).

+ * + * @author Joseph Lizier (email, + * www) + */ +package infodynamics.measures.continuous.kraskov; diff --git a/java/source/infodynamics/measures/continuous/package-info.java b/java/source/infodynamics/measures/continuous/package-info.java new file mode 100755 index 0000000..47175e1 --- /dev/null +++ b/java/source/infodynamics/measures/continuous/package-info.java @@ -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). + * + *

Subpackages provides various estimator types which implement + * these interfaces.

+ * + * @author Joseph Lizier (email, + * www) + */ +package infodynamics.measures.continuous; diff --git a/java/source/infodynamics/measures/continuous/symbolic/package-info.java b/java/source/infodynamics/measures/continuous/symbolic/package-info.java new file mode 100755 index 0000000..fcd5e1e --- /dev/null +++ b/java/source/infodynamics/measures/continuous/symbolic/package-info.java @@ -0,0 +1,13 @@ +/** + * This package contains estimators for the + * information dynamics measures which + * use permutation entropy or symbolic + * methods. + * + *

These estimators apply to continuous data + * (i.e. double[] or double[][] data).

+ * + * @author Joseph Lizier (email, + * www) + */ +package infodynamics.measures.continuous.symbolic; diff --git a/java/source/infodynamics/measures/discrete/package-info.java b/java/source/infodynamics/measures/discrete/package-info.java new file mode 100755 index 0000000..28a8f5c --- /dev/null +++ b/java/source/infodynamics/measures/discrete/package-info.java @@ -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 (email, + * www) + */ +package infodynamics.measures.discrete; diff --git a/java/source/infodynamics/measures/mixed/package-info.java b/java/source/infodynamics/measures/mixed/package-info.java new file mode 100755 index 0000000..b72f665 --- /dev/null +++ b/java/source/infodynamics/measures/mixed/package-info.java @@ -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). + * + *

Subpackages provides various estimator types which implement + * these interfaces.

+ * + *

These are EXPERIMENTAL, not well documented or tested.

+ * + * @author Joseph Lizier (email, + * www) + */ +package infodynamics.measures.mixed; diff --git a/java/source/infodynamics/networkinference/interregional/package-info.java b/java/source/infodynamics/networkinference/interregional/package-info.java new file mode 100755 index 0000000..23ecb30 --- /dev/null +++ b/java/source/infodynamics/networkinference/interregional/package-info.java @@ -0,0 +1,11 @@ +/** + * This package contains classes for effective + * connectivity analysis at a regional level. + * + *

See the demo for interregional connectivity for more + * information.

+ * + * @author Joseph Lizier (email, + * www) + */ +package infodynamics.networkinference.interregional; diff --git a/java/source/infodynamics/utils/package-info.java b/java/source/infodynamics/utils/package-info.java new file mode 100755 index 0000000..ad0cea1 --- /dev/null +++ b/java/source/infodynamics/utils/package-info.java @@ -0,0 +1,8 @@ +/** + * This package contains utility classes to + * support the calculators in other packages + * + * @author Joseph Lizier (email, + * www) + */ +package infodynamics.utils;