From 9552091fca258055bc9fad0810e6e720bacb6de5 Mon Sep 17 00:00:00 2001
From: jlizier <joseph.lizier@gmail.com>
Date: Tue, 15 May 2018 17:28:39 +1000
Subject: [PATCH] Adding Javadoc on header for neighbour counts method in KSG
 MI estimator 1

---
 .../MutualInfoCalculatorMultiVariateKraskov1.java   | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/java/source/infodynamics/measures/continuous/kraskov/MutualInfoCalculatorMultiVariateKraskov1.java b/java/source/infodynamics/measures/continuous/kraskov/MutualInfoCalculatorMultiVariateKraskov1.java
index 73e2fa0..8994013 100644
--- a/java/source/infodynamics/measures/continuous/kraskov/MutualInfoCalculatorMultiVariateKraskov1.java
+++ b/java/source/infodynamics/measures/continuous/kraskov/MutualInfoCalculatorMultiVariateKraskov1.java
@@ -122,6 +122,19 @@ public class MutualInfoCalculatorMultiVariateKraskov1
 		}
 	}
 
+	/**
+	 * Mirrors {@link #partialComputePredictionErrorFromObservations(int, int, int, boolean)}
+	 * in implementing the guts of each Kraskov algorithm;
+	 * however this is not intended to be used in a computation per se but for debugging
+	 * purposes where the caller specifically wants to examine the neighbour counts
+	 * for each data point (which is what is returned)
+	 * 
+	 * @param startTimePoint
+	 * @param numTimePoints
+	 * @return an array of arrays of neighbour counts for each sample (first index), where
+	 *  the array of neighbour counts is for variable 1 or x (index 0) then variable 2 or y (index 1)
+	 * @throws Exception
+	 */
 	public int[][] partialNeighbourCountFromObservations(
 			int startTimePoint, int numTimePoints) throws Exception {