add basic documentation

Author: abhinavmehndiratta

src/Object_Methods/Matrix_Methods.jl

@@ -1,3 +1,8 @@
+"""
+    GrB_Matrix_new(A, type, nrows, ncols)
+
+Create a new matrix with specified domain and dimensions.
+"""
 function GrB_Matrix_new(A::GrB_Matrix, type::GrB_Type, nrows::T, ncols::T) where T <: GrB_Index
     A_ptr = pointer_from_objref(A)
 
@@ -11,6 +16,11 @@ function GrB_Matrix_new(A::GrB_Matrix, type::GrB_Type, nrows::T, ncols::T) where
         )
 end
 
+"""
+    GrB_Matrix_build(C, I, J, X, nvals, dup)
+
+Store elements from tuples into a vector.
+"""
 function GrB_Matrix_build(C::GrB_Matrix, I::Vector{U}, J::Vector{U}, X::Vector{T}, nvals::U, dup::GrB_BinaryOp) where{U <: GrB_Index, T <: valid_types}
     I_ptr = pointer(I)
     J_ptr = pointer(J)
@@ -26,6 +36,12 @@ function GrB_Matrix_build(C::GrB_Matrix, I::Vector{U}, J::Vector{U}, X::Vector{T
         )
 end
 
+"""
+    GrB_Matrix_nrows(A)
+
+Return the number of rows in a matrix if successful.
+Else return value of type GrB Info.
+"""
 function GrB_Matrix_nrows(A::GrB_Matrix)
     nrows = Ref(UInt64(0))
     result = GrB_Info(
@@ -40,6 +56,12 @@ function GrB_Matrix_nrows(A::GrB_Matrix)
     return _GrB_Index(nrows[])
 end
 
+"""
+    GrB_Matrix_ncols(A)
+
+Return the number of columns in a matrix if successful.
+Else return value of type GrB Info.
+"""
 function GrB_Matrix_ncols(A::GrB_Matrix)
     ncols = Ref(UInt64(0))
     result = GrB_Info(
@@ -54,6 +76,12 @@ function GrB_Matrix_ncols(A::GrB_Matrix)
     return _GrB_Index(ncols[])
 end
 
+"""
+    GrB_Matrix_nvals(A)
+
+Return the number of stored elements in a matrix if successful.
+Else return value of type GrB Info.
+"""
 function GrB_Matrix_nvals(A::GrB_Matrix)
     nvals = Ref(UInt64(0))
     result = GrB_Info(
@@ -68,6 +96,11 @@ function GrB_Matrix_nvals(A::GrB_Matrix)
     return _GrB_Index(nvals[])
 end
 
+"""
+    GrB_Matrix_dup(C, A)
+
+Create a new matrix with the same domain, dimensions, and contents as another matrix.
+"""
 function GrB_Matrix_dup(C::GrB_Matrix, A::GrB_Matrix)
     C_ptr = pointer_from_objref(C)
 
@@ -81,6 +114,11 @@ function GrB_Matrix_dup(C::GrB_Matrix, A::GrB_Matrix)
         )
 end
 
+"""
+    GrB_Matrix_clear(A)
+
+Remove all elements from a matrix.
+"""
 function GrB_Matrix_clear(A::GrB_Matrix)
     return GrB_Info(
         ccall(
@@ -92,6 +130,11 @@ function GrB_Matrix_clear(A::GrB_Matrix)
         )
 end
 
+"""
+    GrB_Matrix_setElement(C, X, I, J)
+
+Set one element of a matrix to a given value, C[I][J] = X.
+"""
 function GrB_Matrix_setElement(C::GrB_Matrix, X::T, I::U, J::U) where {U <: GrB_Index, T <: valid_int_types}
     fn_name = "GrB_Matrix_setElement_" * get_suffix(T)
     return GrB_Info(
@@ -128,6 +171,12 @@ function GrB_Matrix_setElement(C::GrB_Matrix, X::Float64, I::U, J::U) where U <:
         )
 end
 
+"""
+    GrB_Matrix_extractElement(A, row_index, col_index)
+
+Return element of a vector at a given index (A[row_index][col_index]) if successful.
+Else return value of type GrB Info.
+"""
 function GrB_Matrix_extractElement(A::GrB_Matrix, row_index::U, col_index::U) where U <: GrB_Index
     res, A_type = GxB_Matrix_type(A)
     res != GrB_SUCCESS && return res
@@ -147,6 +196,11 @@ function GrB_Matrix_extractElement(A::GrB_Matrix, row_index::U, col_index::U) wh
     return element[]
 end
 
+"""
+    GrB_Matrix_extractTuples(A)
+
+Return tuples stored in a matrix.
+"""
 function GrB_Matrix_extractTuples(A::GrB_Matrix)
     res, A_type = GxB_Matrix_type(A)
     res != GrB_SUCCESS && return res

src/Object_Methods/Vector_Methods.jl

@@ -1,3 +1,8 @@
+"""
+    GrB_Vector_new(v, type, n)
+
+Create a new vector with specified domain and size.
+"""
 function GrB_Vector_new(v::GrB_Vector, type::GrB_Type, n::T) where T <: GrB_Index
     v_ptr = pointer_from_objref(v)
 
@@ -11,6 +16,11 @@ function GrB_Vector_new(v::GrB_Vector, type::GrB_Type, n::T) where T <: GrB_Inde
         )
 end
 
+"""
+    GrB_Vector_dup(w, u)
+
+Create a new vector with the same domain, size, and contents as another vector.
+"""
 function GrB_Vector_dup(w::GrB_Vector, u::GrB_Vector)
     w_ptr = pointer_from_objref(w)
 
@@ -24,6 +34,11 @@ function GrB_Vector_dup(w::GrB_Vector, u::GrB_Vector)
         )
 end
 
+"""
+    GrB_Vector_clear(v)
+    
+Remove all the elements (tuples) from a vector.
+"""
 function GrB_Vector_clear(v::GrB_Vector)
     return GrB_Info(
         ccall(
@@ -35,6 +50,11 @@ function GrB_Vector_clear(v::GrB_Vector)
         )
 end
 
+"""
+    GrB_Vector_size(v)
+
+Return the size of a vector if successful else return value of type GrB Info.
+"""
 function GrB_Vector_size(v::GrB_Vector)
     n = Ref(UInt64(0))
     result = GrB_Info(
@@ -49,6 +69,12 @@ function GrB_Vector_size(v::GrB_Vector)
     return _GrB_Index(n[])
 end
 
+"""
+    GrB_Vector_nvals(v)
+
+Return the number of stored elements in a vector if successful.
+Else return value of type GrB Info.
+"""
 function GrB_Vector_nvals(v::GrB_Vector)
     nvals = Ref(UInt64(0))
     result = GrB_Info(
@@ -63,6 +89,11 @@ function GrB_Vector_nvals(v::GrB_Vector)
     return _GrB_Index(nvals[])
 end
 
+"""
+    GrB_Vector_build(w, I, X, nvals, dup)
+
+Store elements from tuples into a vector.
+"""
 function GrB_Vector_build(w::GrB_Vector, I::Vector{U}, X::Vector{T}, nvals::U, dup::GrB_BinaryOp) where{U <: GrB_Index, T <: valid_types}
     I_ptr = pointer(I)
     X_ptr = pointer(X)
@@ -78,6 +109,11 @@ function GrB_Vector_build(w::GrB_Vector, I::Vector{U}, X::Vector{T}, nvals::U, d
         )
 end
 
+"""
+    GrB_Vector_setElement(w, x, i)
+
+Set one element of a vector to a given value, w[i] = x.
+"""
 function GrB_Vector_setElement(w::GrB_Vector, x::T, i::U) where {U <: GrB_Index, T <: valid_int_types}
     fn_name = "GrB_Vector_setElement_" * get_suffix(T)
     return GrB_Info(
@@ -114,6 +150,12 @@ function GrB_Vector_setElement(w::GrB_Vector, x::Float64, i::U) where U <: GrB_I
         )
 end
 
+"""
+    GrB_Vector_extractElement(v, i)
+
+Return element of a vector at a given index (v[i]) if successful.
+Else return value of type GrB Info.
+"""
 function GrB_Vector_extractElement(v::GrB_Vector, i::U) where U <: GrB_Index
     res, v_type = GxB_Vector_type(v)
     res != GrB_SUCCESS && return res
@@ -133,6 +175,11 @@ function GrB_Vector_extractElement(v::GrB_Vector, i::U) where U <: GrB_Index
     return element[]
 end
 
+"""
+    GrB_Vector_extractTuples(v)
+
+Return tuples stored in a vector.
+"""
 function GrB_Vector_extractTuples(v::GrB_Vector)
     res, v_type = GxB_Vector_type(v)
     res != GrB_SUCCESS && return res