Skip to content

Commit 2b37064

Browse files
authored
Added comments for public functions for vector support (#2697)
1 parent e6096d8 commit 2b37064

File tree

1 file changed

+17
-3
lines changed

1 file changed

+17
-3
lines changed

src/main/java/microsoft/sql/Vector.java

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,9 @@ public enum VectorDimensionType {
3232
public Vector(int dimensionCount, VectorDimensionType vectorType, Object[] data) {
3333
validateVectorParameters(dimensionCount, vectorType, data);
3434

35-
this.dimensionCount = dimensionCount; // checks non zero
35+
this.dimensionCount = dimensionCount;
3636
this.vectorType = vectorType;
37-
this.data = data; // float and null
37+
this.data = data;
3838
}
3939

4040
/**
@@ -48,15 +48,29 @@ public Vector(int precision, int scale, Object[] data) {
4848
this(precision, getVectorDimensionTypeFromScaleValue(scale), data);
4949
}
5050

51-
// Getter methods for vector properties
51+
/**
52+
* Returns the data of the vector.
53+
*
54+
* @return The object array representing the vector data.
55+
*/
5256
public Object[] getData() {
5357
return data;
5458
}
5559

60+
/**
61+
* Returns the number of dimensions in the vector.
62+
*
63+
* @return The dimension count of the vector.
64+
*/
5665
public int getDimensionCount() {
5766
return dimensionCount;
5867
}
5968

69+
/**
70+
* Returns the type of the vector.
71+
*
72+
* @return The vector dimension type.
73+
*/
6074
public VectorDimensionType getVectorDimensionType() {
6175
return vectorType;
6276
}

0 commit comments

Comments
 (0)