Skip to content

Commit 3cb61fa

Browse files
add operations to documentation
1 parent d0c77ec commit 3cb61fa

File tree

2 files changed

+78
-1
lines changed

2 files changed

+78
-1
lines changed

docs/make.jl

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,8 @@ makedocs(
1212
"Operators & algebraic structures" => "algebra_methods.md",
1313
"Descriptors" => "desc_methods.md",
1414
"Freeing objects" => "free_methods.md",
15-
"Sequence termination" => "seq_ter.md"
15+
"Sequence termination" => "seq_ter.md",
16+
"Operations" => "operations.md"
1617
]
1718
)
1819

docs/src/operations.md

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
## GraphBLAS operations
2+
3+
## Multiplication
4+
5+
```@docs
6+
GrB_mxm
7+
GrB_vxm
8+
GrB_mxv
9+
```
10+
11+
## Element-wise multiplication
12+
13+
```@docs
14+
GrB_eWiseMult
15+
GrB_eWiseMult_Vector_Semiring
16+
GrB_eWiseMult_Vector_Monoid
17+
GrB_eWiseMult_Vector_BinaryOp
18+
GrB_eWiseMult_Matrix_Semiring
19+
GrB_eWiseMult_Matrix_Monoid
20+
GrB_eWiseMult_Matrix_BinaryOp
21+
```
22+
23+
## Element-wise addition
24+
25+
```@docs
26+
GrB_eWiseAdd
27+
GrB_eWiseAdd_Vector_Semiring
28+
GrB_eWiseAdd_Vector_Monoid
29+
GrB_eWiseAdd_Vector_BinaryOp
30+
GrB_eWiseAdd_Matrix_Semiring
31+
GrB_eWiseAdd_Matrix_Monoid
32+
GrB_eWiseAdd_Matrix_BinaryOp
33+
```
34+
35+
## Extract
36+
37+
```@docs
38+
GrB_extract
39+
GrB_Vector_extract
40+
GrB_Matrix_extract
41+
GrB_Col_extract
42+
```
43+
44+
## Assign
45+
46+
```@docs
47+
GrB_assign
48+
GrB_Vector_assign
49+
GrB_Matrix_assign
50+
GrB_Col_assign
51+
GrB_Row_assign
52+
```
53+
54+
## Apply
55+
56+
```@docs
57+
GrB_apply
58+
GrB_Vector_apply
59+
GrB_Matrix_apply
60+
```
61+
62+
## Reduce
63+
64+
```@docs
65+
GrB_reduce
66+
GrB_Matrix_reduce_Monoid
67+
GrB_Matrix_reduce_BinaryOp
68+
GrB_Vector_reduce
69+
GrB_Matrix_reduce
70+
```
71+
72+
## Transpose
73+
74+
```@docs
75+
GrB_transpose
76+
```

0 commit comments

Comments
 (0)