Updated doc comments [skip ci]

Author: ankane

src/main/java/com/pgvector/PGbit.java

@@ -12,7 +12,7 @@
 import org.postgresql.util.PGobject;
 
 /**
- * PGbit class
+ * A bit string.
  */
 public class PGbit extends PGobject implements PGBinaryObject, Serializable, Cloneable {
     private int length;
@@ -26,7 +26,7 @@ public PGbit() {
     }
 
     /**
-     * Creates a bit string from a boolean array
+     * Creates a bit string from a boolean array.
      *
      * @param v boolean array
      */
@@ -40,7 +40,7 @@ public PGbit(boolean[] v) {
     }
 
     /**
-     * Creates a bit string from a byte array
+     * Creates a bit string from a byte array.
      *
      * @param v byte array
      */
@@ -51,7 +51,7 @@ public PGbit(byte[] v) {
     }
 
     /**
-     * Creates a bit string from a text representation
+     * Creates a bit string from a text representation.
      *
      * @param s text representation of a bit string
      * @throws SQLException exception
@@ -62,7 +62,7 @@ public PGbit(String s) throws SQLException {
     }
 
     /**
-     * Sets the value from a text representation of a bit string
+     * Sets the value from a text representation of a bit string.
      */
     public void setValue(String s) throws SQLException {
         if (s == null) {
@@ -77,7 +77,7 @@ public void setValue(String s) throws SQLException {
     }
 
     /**
-     * Returns the text representation of a bit string
+     * Returns the text representation of a bit string.
      */
     public String getValue() {
         if (data == null) {
@@ -92,14 +92,14 @@ public String getValue() {
     }
 
     /**
-     * Returns the number of bytes for the binary representation
+     * Returns the number of bytes for the binary representation.
      */
     public int lengthInBytes() {
         return data == null ? 0 : 4 + data.length;
     }
 
     /**
-     * Sets the value from a binary representation of a bit string
+     * Sets the value from a binary representation of a bit string.
      */
     public void setByteValue(byte[] value, int offset) throws SQLException {
         length = ByteConverter.int4(value, offset);
@@ -110,7 +110,7 @@ public void setByteValue(byte[] value, int offset) throws SQLException {
     }
 
     /**
-     * Writes the binary representation of a bit string
+     * Writes the binary representation of a bit string.
      */
     public void toBytes(byte[] bytes, int offset) {
         if (data == null) {
@@ -124,7 +124,7 @@ public void toBytes(byte[] bytes, int offset) {
     }
 
     /**
-     * Returns the length
+     * Returns the length.
      *
      * @return an array
      */
@@ -133,7 +133,7 @@ public int length() {
     }
 
     /**
-     * Returns a byte array
+     * Returns a byte array.
      *
      * @return an array
      */
@@ -142,7 +142,7 @@ public byte[] toByteArray() {
     }
 
     /**
-     * Returns an array
+     * Returns an array.
      *
      * @return an array
      */
@@ -155,7 +155,7 @@ public boolean[] toArray() {
     }
 
     /**
-     * Registers the bit type
+     * Registers the bit type.
      *
      * @param conn connection
      * @throws SQLException exception

src/main/java/com/pgvector/PGhalfvec.java

@@ -10,12 +10,12 @@
 import org.postgresql.util.PGobject;
 
 /**
- * PGhalfvec class
+ * A half vector.
  */
 public class PGhalfvec extends PGobject implements Serializable, Cloneable {
     /*
      * Use float and text format for now since Float.float16ToFloat/floatToFloat16
-     * are not available until Java 20
+     * are not available until Java 20.
      */
     private float[] vec;
 
@@ -27,7 +27,7 @@ public PGhalfvec() {
     }
 
     /**
-     * Creates a half vector from an array
+     * Creates a half vector from an array.
      *
      * @param v float array
      */
@@ -37,7 +37,7 @@ public PGhalfvec(float[] v) {
     }
 
     /**
-     * Creates a half vector from a list
+     * Creates a half vector from a list.
      *
      * @param <T> number
      * @param v list of numbers
@@ -56,7 +56,7 @@ public <T extends Number> PGhalfvec(List<T> v) {
     }
 
     /**
-     * Creates a half vector from a text representation
+     * Creates a half vector from a text representation.
      *
      * @param s text representation of a half vector
      * @throws SQLException exception
@@ -67,7 +67,7 @@ public PGhalfvec(String s) throws SQLException {
     }
 
     /**
-     * Sets the value from a text representation of a half vector
+     * Sets the value from a text representation of a half vector.
      */
     public void setValue(String s) throws SQLException {
         if (s == null) {
@@ -82,7 +82,7 @@ public void setValue(String s) throws SQLException {
     }
 
     /**
-     * Returns the text representation of a half vector
+     * Returns the text representation of a half vector.
      */
     public String getValue() {
         if (vec == null) {
@@ -93,7 +93,7 @@ public String getValue() {
     }
 
     /**
-     * Returns an array
+     * Returns an array.
      *
      * @return an array
      */

src/main/java/com/pgvector/PGsparsevec.java

@@ -14,7 +14,7 @@
 import org.postgresql.util.PGobject;
 
 /**
- * PGsparsevec class
+ * A sparse vector.
  */
 public class PGsparsevec extends PGobject implements PGBinaryObject, Serializable, Cloneable {
     private int dimensions;
@@ -29,7 +29,7 @@ public PGsparsevec() {
     }
 
     /**
-     * Creates a sparse vector from an array
+     * Creates a sparse vector from an array.
      *
      * @param v float array
      */
@@ -58,7 +58,7 @@ public PGsparsevec(float[] v) {
     }
 
     /**
-     * Creates a sparse vector from a list
+     * Creates a sparse vector from a list.
      *
      * @param <T> number
      * @param v list of numbers
@@ -95,9 +95,9 @@ public <T extends Number> PGsparsevec(List<T> v) {
     }
 
     /**
-     * Creates a sparse vector from a map of non-zero elements
+     * Creates a sparse vector from a map of non-zero elements.
      * <p>
-     * Indices start at 0
+     * Indices start at 0.
      *
      * @param <T> number
      * @param map map of non-zero elements
@@ -128,7 +128,7 @@ public <T extends Number> PGsparsevec(Map<Integer, T> map, int dimensions) {
     }
 
     /**
-     * Creates a sparse vector from a text representation
+     * Creates a sparse vector from a text representation.
      *
      * @param s text representation of a sparse vector
      * @throws SQLException exception
@@ -139,7 +139,7 @@ public PGsparsevec(String s) throws SQLException {
     }
 
     /**
-     * Sets the value from a text representation of a sparse vector
+     * Sets the value from a text representation of a sparse vector.
      */
     public void setValue(String s) throws SQLException {
         if (s == null) {
@@ -162,7 +162,7 @@ public void setValue(String s) throws SQLException {
     }
 
     /**
-     * Returns the text representation of a sparse vector
+     * Returns the text representation of a sparse vector.
      */
     public String getValue() {
         if (indices == null) {
@@ -188,14 +188,14 @@ public String getValue() {
     }
 
     /**
-     * Returns the number of bytes for the binary representation
+     * Returns the number of bytes for the binary representation.
      */
     public int lengthInBytes() {
         return indices == null ? 0 : 12 + indices.length * 4 + values.length * 4;
     }
 
     /**
-     * Sets the value from a binary representation of a sparse vector
+     * Sets the value from a binary representation of a sparse vector.
      */
     public void setByteValue(byte[] value, int offset) throws SQLException {
         dimensions = ByteConverter.int4(value, offset);
@@ -218,7 +218,7 @@ public void setByteValue(byte[] value, int offset) throws SQLException {
     }
 
     /**
-     * Writes the binary representation of a sparse vector
+     * Writes the binary representation of a sparse vector.
      */
     public void toBytes(byte[] bytes, int offset) {
         if (indices == null) {
@@ -239,7 +239,7 @@ public void toBytes(byte[] bytes, int offset) {
     }
 
     /**
-     * Returns an array
+     * Returns an array.
      *
      * @return an array
      */
@@ -256,7 +256,7 @@ public float[] toArray() {
     }
 
     /**
-     * Returns the number of dimensions
+     * Returns the number of dimensions.
      *
      * @return the number of dimensions
      */
@@ -265,7 +265,7 @@ public int getDimensions() {
     }
 
     /**
-     * Returns the non-zero indices
+     * Returns the non-zero indices.
      *
      * @return the non-zero indices
      */
@@ -274,7 +274,7 @@ public int[] getIndices() {
     }
 
     /**
-     * Returns the non-zero values
+     * Returns the non-zero values.
      *
      * @return the non-zero values
      */