add examples in doucmentation for basic vector methods

Author: abhinavmehndiratta

src/Object_Methods/Vector_Methods.jl

@@ -2,6 +2,20 @@
     GrB_Vector_new(v, type, n)
 
 Create a new vector with specified domain and size.
+
+# Examples
+```jldoctest
+julia> using SuiteSparseGraphBLAS
+
+julia> GrB_init(GrB_NONBLOCKING)
+GrB_SUCCESS::GrB_Info = 0
+
+julia> V = GrB_Vector()
+GrB_Vector
+
+julia> GrB_Vector_new(V, GrB_FP64, 4)
+GrB_SUCCESS::GrB_Info = 0
+```
 """
 function GrB_Vector_new(v::GrB_Vector, type::GrB_Type, n::T) where T <: GrB_Index
     v_ptr = pointer_from_objref(v)
@@ -20,6 +34,45 @@ end
     GrB_Vector_dup(w, u)
 
 Create a new vector with the same domain, size, and contents as another vector.
+
+# Examples
+```jldoctest
+julia> using SuiteSparseGraphBLAS
+
+julia> GrB_init(GrB_NONBLOCKING)
+GrB_SUCCESS::GrB_Info = 0
+
+julia> V = GrB_Vector()
+GrB_Vector
+
+julia> GrB_Vector_new(V, GrB_INT64, 5)
+GrB_SUCCESS::GrB_Info = 0
+
+julia> I = [1, 2, 4]; X = [2, 32, 4]; n = 3;
+
+julia> GrB_Vector_build(V, I, X, n, GrB_FIRST_INT64)
+GrB_SUCCESS::GrB_Info = 0
+
+julia> B = GrB_Vector()
+GrB_Vector
+
+julia> GrB_Vector_dup(B, V)
+GrB_SUCCESS::GrB_Info = 0
+
+julia> @GxB_Vector_fprint(B, GxB_SHORT)
+
+GraphBLAS vector: B
+nrows: 5 ncols: 1 max # entries: 3
+format: standard CSC vlen: 5 nvec_nonempty: 1 nvec: 1 plen: 1 vdim: 1
+hyper_ratio 0.0625
+GraphBLAS type:  int64_t size: 8
+number of entries: 3
+column: 0 : 3 entries [0:2]
+    row 1: int64 2
+    row 2: int64 32
+    row 4: int64 4
+
+```
 """
 function GrB_Vector_dup(w::GrB_Vector, u::GrB_Vector)
     w_ptr = pointer_from_objref(w)
@@ -36,8 +89,36 @@ end
 
 """
     GrB_Vector_clear(v)
-    
+
 Remove all the elements (tuples) from a vector.
+
+# Examples
+```jldoctest
+julia> using SuiteSparseGraphBLAS
+
+julia> GrB_init(GrB_NONBLOCKING)
+GrB_SUCCESS::GrB_Info = 0
+
+julia> V = GrB_Vector()
+GrB_Vector
+
+julia> GrB_Vector_new(V, GrB_INT64, 5)
+GrB_SUCCESS::GrB_Info = 0
+
+julia> I = [1, 2, 4]; X = [2, 32, 4]; n = 3;
+
+julia> GrB_Vector_build(V, I, X, n, GrB_FIRST_INT64)
+GrB_SUCCESS::GrB_Info = 0
+
+julia> GrB_Vector_extractTuples(V)
+([1, 2, 4], [2, 32, 4])
+
+julia> GrB_Vector_clear(V)
+GrB_SUCCESS::GrB_Info = 0
+
+julia> GrB_Vector_extractTuples(V)
+(Int64[], Int64[])
+```
 """
 function GrB_Vector_clear(v::GrB_Vector)
     return GrB_Info(
@@ -53,7 +134,30 @@ end
 """
     GrB_Vector_size(v)
 
-Return the size of a vector if successful else return value of type GrB Info.
+Return the size of a vector if successful.
+Else return value of type GrB Info.
+
+# Examples
+```jldoctest
+julia> using SuiteSparseGraphBLAS
+
+julia> GrB_init(GrB_NONBLOCKING)
+GrB_SUCCESS::GrB_Info = 0
+
+julia> V = GrB_Vector()
+GrB_Vector
+
+julia> GrB_Vector_new(V, GrB_FP64, 4)
+GrB_SUCCESS::GrB_Info = 0
+
+julia> I = [0, 2, 3]; X = [2.1, 3.2, 4.4]; n = 3;
+
+julia> GrB_Vector_build(V, I, X, n, GrB_FIRST_FP64)
+GrB_SUCCESS::GrB_Info = 0
+
+julia> GrB_Vector_size(V)
+4
+```
 """
 function GrB_Vector_size(v::GrB_Vector)
     n = Ref(UInt64(0))
@@ -74,6 +178,28 @@ end
 
 Return the number of stored elements in a vector if successful.
 Else return value of type GrB Info.
+
+# Examples
+```jldoctest
+julia> using SuiteSparseGraphBLAS
+
+julia> GrB_init(GrB_NONBLOCKING)
+GrB_SUCCESS::GrB_Info = 0
+
+julia> V = GrB_Vector()
+GrB_Vector
+
+julia> GrB_Vector_new(V, GrB_FP64, 4)
+GrB_SUCCESS::GrB_Info = 0
+
+julia> I = [0, 2, 3]; X = [2.1, 3.2, 4.4]; n = 3;
+
+julia> GrB_Vector_build(V, I, X, n, GrB_FIRST_FP64)
+GrB_SUCCESS::GrB_Info = 0
+
+julia> GrB_Vector_nvals(V)
+3
+```
 """
 function GrB_Vector_nvals(v::GrB_Vector)
     nvals = Ref(UInt64(0))
@@ -93,6 +219,34 @@ end
     GrB_Vector_build(w, I, X, nvals, dup)
 
 Store elements from tuples into a vector.
+
+# Examples
+```jldoctest
+julia> V = GrB_Vector()
+GrB_Vector
+
+julia> GrB_Vector_new(V, GrB_FP64, 4)
+GrB_SUCCESS::GrB_Info = 0
+
+julia> I = [0, 2, 3]; X = [2.1, 3.2, 4.4]; n = 3;
+
+julia> GrB_Vector_build(V, I, X, n, GrB_FIRST_FP64)
+GrB_SUCCESS::GrB_Info = 0
+
+julia> @GxB_Vector_fprint(V, GxB_SHORT)
+
+GraphBLAS vector: V
+nrows: 4 ncols: 1 max # entries: 3
+format: standard CSC vlen: 4 nvec_nonempty: 1 nvec: 1 plen: 1 vdim: 1
+hyper_ratio 0.0625
+GraphBLAS type:  double size: 8
+number of entries: 3
+column: 0 : 3 entries [0:2]
+    row 0: double 2.1
+    row 2: double 3.2
+    row 3: double 4.4
+
+```
 """
 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)
@@ -113,6 +267,34 @@ end
     GrB_Vector_setElement(w, x, i)
 
 Set one element of a vector to a given value, w[i] = x.
+
+# Examples
+```jldoctest
+julia> using SuiteSparseGraphBLAS
+
+julia> GrB_init(GrB_NONBLOCKING)
+GrB_SUCCESS::GrB_Info = 0
+
+julia> V = GrB_Vector()
+GrB_Vector
+
+julia> GrB_Vector_new(V, GrB_INT64, 5)
+GrB_SUCCESS::GrB_Info = 0
+
+julia> I = [1, 2, 4]; X = [2, 32, 4]; n = 3;
+
+julia> GrB_Vector_build(V, I, X, n, GrB_FIRST_INT64)
+GrB_SUCCESS::GrB_Info = 0
+
+julia> GrB_Vector_extractElement(V, 2)
+32
+
+julia> GrB_Vector_setElement(V, 7, 2)
+GrB_SUCCESS::GrB_Info = 0
+
+julia> GrB_Vector_extractElement(V, 2)
+7
+```
 """
 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)
@@ -155,6 +337,31 @@ end
 
 Return element of a vector at a given index (v[i]) if successful.
 Else return value of type GrB Info.
+
+# Examples
+```jldoctest
+julia> using SuiteSparseGraphBLAS
+
+julia> GrB_init(GrB_NONBLOCKING)
+GrB_SUCCESS::GrB_Info = 0
+
+julia> V = GrB_Vector()
+GrB_Vector
+
+julia> GrB_Vector_new(V, GrB_FP64, 4)
+GrB_SUCCESS::GrB_Info = 0
+
+julia> I = [0, 2, 3]; X = [2.1, 3.2, 4.4]; n = 3;
+
+julia> GrB_Vector_build(V, I, X, n, GrB_FIRST_FP64)
+GrB_SUCCESS::GrB_Info = 0
+
+julia> GrB_Vector_extractElement(V, 2)
+3.2
+
+julia> GrB_Vector_extractElement(V, 1)
+GrB_NO_VALUE::GrB_Info = 1
+```
 """
 function GrB_Vector_extractElement(v::GrB_Vector, i::U) where U <: GrB_Index
     res, v_type = GxB_Vector_type(v)
@@ -179,6 +386,28 @@ end
     GrB_Vector_extractTuples(v)
 
 Return tuples stored in a vector.
+
+# Examples
+```jldoctest
+julia> using SuiteSparseGraphBLAS
+
+julia> GrB_init(GrB_NONBLOCKING)
+GrB_SUCCESS::GrB_Info = 0
+
+julia> V = GrB_Vector()
+GrB_Vector
+
+julia> GrB_Vector_new(V, GrB_FP64, 4)
+GrB_SUCCESS::GrB_Info = 0
+
+julia> I = [0, 2, 3]; X = [2.1, 3.2, 4.4]; n = 3;
+
+julia> GrB_Vector_build(V, I, X, n, GrB_FIRST_FP64)
+GrB_SUCCESS::GrB_Info = 0
+
+julia> GrB_Vector_extractTuples(V)
+([0, 2, 3], [2.1, 3.2, 4.4])
+```
 """
 function GrB_Vector_extractTuples(v::GrB_Vector)
     res, v_type = GxB_Vector_type(v)