svn commit: r1415166 - /lucene/dev/trunk/lucene/classification/src/java/org/apache/lucene/classification/utils/DatasetSplitter.java

[to...@apache.org]

Author: tommaso
Date: Thu Nov 29 13:59:31 2012
New Revision: 1415166

URL: http://svn.apache.org/viewvc?rev=1415166&view=rev
Log:
[LUCENE-4345] - added missing javadoc for DatasetSplitter constructor

Modified:
    lucene/dev/trunk/lucene/classification/src/java/org/apache/lucene/classification/utils/DatasetSplitter.java

Modified: lucene/dev/trunk/lucene/classification/src/java/org/apache/lucene/classification/utils/DatasetSplitter.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/classification/src/java/org/apache/lucene/classification/utils/DatasetSplitter.java?rev=1415166&r1=1415165&r2=1415166&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/classification/src/java/org/apache/lucene/classification/utils/DatasetSplitter.java (original)
+++ lucene/dev/trunk/lucene/classification/src/java/org/apache/lucene/classification/utils/DatasetSplitter.java Thu Nov 29 13:59:31 2012
@@ -43,6 +43,11 @@ public class DatasetSplitter {
   private double crossValidationRatio;
   private double testRatio;
 
+  /**
+   * Create a {@link DatasetSplitter} by giving test and cross validation IDXs sizes
+   * @param testRatio the ratio of the original index to be used for the test IDX as a <code>double</code> between 0.0 and 1.0
+   * @param crossValidationRatio the ratio of the original index to be used for the c.v. IDX as a <code>double</code> between 0.0 and 1.0
+   */
   public DatasetSplitter(double testRatio, double crossValidationRatio) {
     this.crossValidationRatio = crossValidationRatio;
     this.testRatio = testRatio;