Skip to content

Commit 4da8497

Browse files
add documentation for transpose
1 parent c32c591 commit 4da8497

File tree

1 file changed

+38
-0
lines changed

1 file changed

+38
-0
lines changed

src/Operations/Transpose.jl

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,41 @@
1+
"""
2+
GrB_transpose(C, Mask, accum, A, desc)
3+
4+
Compute a new matrix that is the transpose of the source matrix.
5+
6+
# Examples
7+
8+
julia> using SuiteSparseGraphBLAS
9+
10+
julia> GrB_init(GrB_NONBLOCKING)
11+
GrB_SUCCESS::GrB_Info = 0
12+
13+
julia> M = GrB_Matrix{Int64}()
14+
GrB_Matrix{Int64}
15+
16+
julia> GrB_Matrix_new(M, GrB_INT64, 4, 4)
17+
GrB_SUCCESS::GrB_Info = 0
18+
19+
julia> I = [0, 0]; J = [1, 2]; X = [10, 20]; n = 2;
20+
21+
julia> GrB_Matrix_build(M, I, J, X, n, GrB_FIRST_INT64)
22+
GrB_SUCCESS::GrB_Info = 0
23+
24+
julia> GrB_Matrix_extractTuples(M)
25+
([0, 0], [1, 2], [10, 20])
26+
27+
julia> M_TRAN = GrB_Matrix{Int64}()
28+
GrB_Matrix{Int64}
29+
30+
julia> GrB_Matrix_new(M_TRAN, GrB_INT64, 4, 4)
31+
GrB_SUCCESS::GrB_Info = 0
32+
33+
julia> GrB_transpose(M_TRAN, GrB_NULL, GrB_NULL, M, GrB_NULL)
34+
GrB_SUCCESS::GrB_Info = 0
35+
36+
julia> GrB_Matrix_extractTuples(M_TRAN)
37+
([1, 2], [0, 0], [10, 20])
38+
"""
139
function GrB_transpose( # C<Mask> = accum (C, A')
240
C::GrB_Matrix, # input/output matrix for results
341
Mask::T, # optional mask for C, unused if NULL

0 commit comments

Comments
 (0)