Java doc2 (#1018)

* Added asSet() to Column API, with documentation * Some tests for asSet() * documentation and cleanup for numeric columns * Completes JavaDoc for NumericColumn * Completed JavaDoc for NumberColumn * Completes JavaDoc for Stats class * Complete JavaDoc for DoubleColumnType * Complete JavaDoc for NumberInterpolator * Update JavaDoc for ColumnType * Complete JavaDoc for AbstractColumnType * Complete JavaDoc for DoubleColumnType * Complete JavaDoc for FloatColumnType and IntColumnType * additional javadoc for Int and Long columns
jtablesaw · Oct 23, 2021 · cd67ab7 · cd67ab7
1 parent ec2db08
commit cd67ab7
Show file tree

Hide file tree

Showing 21 changed files with 288 additions and 38 deletions.
diff --git a/core/src/main/java/tech/tablesaw/api/ColumnType.java b/core/src/main/java/tech/tablesaw/api/ColumnType.java
@@ -81,8 +81,10 @@ static ColumnType valueOf(String name) {
   /** Returns a printer-friendly version of this ColumnType's name */
   String getPrinterFriendlyName();
 
+  /** TODO: Research this method to provide a good comment */
   AbstractColumnParser<?> customParser(ReadOptions options);
 
+  /** TODO: Research this method to provide a good comment */
   default boolean compare(int rowNumber, Column<?> temp, Column<?> original) {
     Object o1 = original.get(rowNumber);
     Object o2 = temp.get(temp.size() - 1);

diff --git a/core/src/main/java/tech/tablesaw/api/DoubleColumn.java b/core/src/main/java/tech/tablesaw/api/DoubleColumn.java
@@ -5,7 +5,9 @@
 import java.math.BigDecimal;
 import java.nio.ByteBuffer;
 import java.util.Collection;
+import java.util.HashSet;
 import java.util.Iterator;
+import java.util.Set;
 import java.util.function.DoubleConsumer;
 import java.util.function.DoublePredicate;
 import java.util.function.DoubleSupplier;
@@ -382,6 +384,12 @@ public byte[] asBytes(int rowNumber) {
         .array();
   }
 
+  /** {@inheritDoc} */
+  @Override
+  public Set<Double> asSet() {
+    return new HashSet<>(unique().asList());
+  }
+
   @Override
   public int countUnique() {
     DoubleSet uniqueElements = new DoubleOpenHashSet();

diff --git a/core/src/main/java/tech/tablesaw/api/FloatColumn.java b/core/src/main/java/tech/tablesaw/api/FloatColumn.java
@@ -3,7 +3,9 @@
 import com.google.common.base.Preconditions;
 import it.unimi.dsi.fastutil.floats.*;
 import java.nio.ByteBuffer;
+import java.util.HashSet;
 import java.util.Iterator;
+import java.util.Set;
 import java.util.stream.Stream;
 import tech.tablesaw.columns.AbstractColumnParser;
 import tech.tablesaw.columns.Column;
@@ -63,11 +65,13 @@ public FloatColumn createCol(String name, int initialSize) {
     return create(name, initialSize);
   }
 
+  /** {@inheritDoc} */
   @Override
   public FloatColumn createCol(String name) {
     return create(name);
   }
 
+  /** {@inheritDoc} */
   @Override
   public Float get(int index) {
     float result = getFloat(index);
@@ -78,6 +82,7 @@ public static boolean valueIsMissing(float value) {
     return FloatColumnType.valueIsMissing(value);
   }
 
+  /** {@inheritDoc} */
   @Override
   public FloatColumn subset(int[] rows) {
     final FloatColumn c = this.emptyCopy();
@@ -105,16 +110,19 @@ public Selection isIn(final float... numbers) {
     return results;
   }
 
+  /** {@inheritDoc} */
   @Override
   public int size() {
     return data.size();
   }
 
+  /** {@inheritDoc} */
   @Override
   public void clear() {
     data.clear();
   }
 
+  /** {@inheritDoc} */
   @Override
   public FloatColumn unique() {
     final FloatSet values = new FloatOpenHashSet();
@@ -128,6 +136,7 @@ public FloatColumn unique() {
     return column;
   }
 
+  /** {@inheritDoc} */
   @Override
   public FloatColumn top(int n) {
     FloatArrayList top = new FloatArrayList();
@@ -139,6 +148,7 @@ public FloatColumn top(int n) {
     return new FloatColumn(name() + "[Top " + n + "]", top);
   }
 
+  /** {@inheritDoc} */
   @Override
   public FloatColumn bottom(final int n) {
     FloatArrayList bottom = new FloatArrayList();
@@ -150,6 +160,7 @@ public FloatColumn bottom(final int n) {
     return new FloatColumn(name() + "[Bottoms " + n + "]", bottom);
   }
 
+  /** {@inheritDoc} */
   @Override
   public FloatColumn lag(int n) {
     final int srcPos = n >= 0 ? 0 : 0 - n;
@@ -167,6 +178,7 @@ public FloatColumn lag(int n) {
     return new FloatColumn(name() + " lag(" + n + ")", new FloatArrayList(dest));
   }
 
+  /** {@inheritDoc} */
   @Override
   public FloatColumn removeMissing() {
     FloatColumn result = copy();
@@ -186,6 +198,7 @@ public FloatColumn append(float i) {
     return this;
   }
 
+  /** {@inheritDoc} */
   @Override
   public FloatColumn append(Float val) {
     if (val == null) {
@@ -196,11 +209,13 @@ public FloatColumn append(Float val) {
     return this;
   }
 
+  /** {@inheritDoc} */
   @Override
   public FloatColumn copy() {
     return new FloatColumn(name(), data.clone());
   }
 
+  /** {@inheritDoc} */
   @Override
   public Iterator<Float> iterator() {
     return data.iterator();
@@ -210,6 +225,7 @@ public float[] asFloatArray() {
     return data.toFloatArray();
   }
 
+  /** {@inheritDoc} */
   @Override
   public Float[] asObjectArray() {
     final Float[] output = new Float[size()];
@@ -223,11 +239,13 @@ public Float[] asObjectArray() {
     return output;
   }
 
+  /** {@inheritDoc} */
   @Override
   public int compare(Float o1, Float o2) {
     return Float.compare(o1, o2);
   }
 
+  /** {@inheritDoc} */
   @Override
   public FloatColumn set(int i, Float val) {
     return val == null ? setMissing(i) : set(i, (float) val);
@@ -238,11 +256,13 @@ public FloatColumn set(int i, float val) {
     return this;
   }
 
+  /** {@inheritDoc} */
   @Override
   public Column<Float> set(int row, String stringValue, AbstractColumnParser<?> parser) {
     return set(row, parser.parseFloat(stringValue));
   }
 
+  /** {@inheritDoc} */
   @Override
   public FloatColumn append(final Column<Float> column) {
     Preconditions.checkArgument(column.type() == this.type());
@@ -254,25 +274,29 @@ public FloatColumn append(final Column<Float> column) {
     return this;
   }
 
+  /** {@inheritDoc} */
   @Override
   public FloatColumn append(Column<Float> column, int row) {
     Preconditions.checkArgument(column.type() == this.type());
     return append(((FloatColumn) column).getFloat(row));
   }
 
+  /** {@inheritDoc} */
   @Override
   public FloatColumn set(int row, Column<Float> column, int sourceRow) {
     Preconditions.checkArgument(column.type() == this.type());
     return set(row, ((FloatColumn) column).getFloat(sourceRow));
   }
 
+  /** {@inheritDoc} */
   @Override
   public byte[] asBytes(int rowNumber) {
     return ByteBuffer.allocate(FloatColumnType.instance().byteSize())
         .putFloat(getFloat(rowNumber))
         .array();
   }
 
+  /** {@inheritDoc} */
   @Override
   public int countUnique() {
     FloatSet uniqueElements = new FloatOpenHashSet();
@@ -282,6 +306,7 @@ public int countUnique() {
     return uniqueElements.size();
   }
 
+  /** {@inheritDoc} */
   @Override
   public double getDouble(int row) {
     float value = data.getFloat(row);
@@ -305,31 +330,37 @@ public boolean isMissingValue(float value) {
     return FloatColumnType.valueIsMissing(value);
   }
 
+  /** {@inheritDoc} */
   @Override
   public boolean isMissing(int rowNumber) {
     return isMissingValue(getFloat(rowNumber));
   }
 
+  /** {@inheritDoc} */
   @Override
   public FloatColumn setMissing(int i) {
     return set(i, FloatColumnType.missingValueIndicator());
   }
 
+  /** {@inheritDoc} */
   @Override
   public void sortAscending() {
     data.sort(FloatComparators.NATURAL_COMPARATOR);
   }
 
+  /** {@inheritDoc} */
   @Override
   public void sortDescending() {
     data.sort(FloatComparators.OPPOSITE_COMPARATOR);
   }
 
+  /** {@inheritDoc} */
   @Override
   public FloatColumn appendMissing() {
     return append(FloatColumnType.missingValueIndicator());
   }
 
+  /** {@inheritDoc} */
   @Override
   public FloatColumn appendObj(Object obj) {
     if (obj == null) {
@@ -341,6 +372,7 @@ public FloatColumn appendObj(Object obj) {
     throw new IllegalArgumentException("Could not append " + obj.getClass());
   }
 
+  /** {@inheritDoc} */
   @Override
   public FloatColumn appendCell(final String value) {
     try {
@@ -351,6 +383,7 @@ public FloatColumn appendCell(final String value) {
     }
   }
 
+  /** {@inheritDoc} */
   @Override
   public FloatColumn appendCell(final String value, AbstractColumnParser<?> parser) {
     try {
@@ -361,6 +394,7 @@ public FloatColumn appendCell(final String value, AbstractColumnParser<?> parser
     }
   }
 
+  /** {@inheritDoc} */
   @Override
   public String getUnformattedString(final int row) {
     final float value = getFloat(row);
@@ -479,4 +513,10 @@ public DoubleColumn asDoubleColumn() {
     }
     return result;
   }
+
+  /** {@inheritDoc} */
+  @Override
+  public Set<Float> asSet() {
+    return new HashSet<>(unique().asList());
+  }
 }
diff --git a/core/src/main/java/tech/tablesaw/api/InstantColumn.java b/core/src/main/java/tech/tablesaw/api/InstantColumn.java
@@ -639,6 +639,8 @@ public LongIterator longIterator() {
     return data.iterator();
   }
 
+  /** {@inheritDoc} */
+  @Override
   public Set<Instant> asSet() {
     Set<Instant> times = new HashSet<>();
     InstantColumn unique = unique();