Skip to content

Commit fa5de43

Browse files
update matrix_coloring docs
1 parent 8242436 commit fa5de43

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,9 @@ gmres!(res,J,v)
9393

9494
### Matrix Coloring
9595

96+
This library extends the common `ArrayInterface.matrix_colors` function to allow
97+
for coloring sparse matrices using graphical techniques.
98+
9699
Matrix coloring allows you to reduce the number of times finite differencing
97100
requires an `f` call to `maximum(colors)+1`, or reduces automatic differentiation
98101
to using `maximum(colors)` partials. Since normally these values are `length(x)`,
@@ -101,7 +104,8 @@ this can be significant savings.
101104
The API for computing the color vector is:
102105

103106
```julia
104-
matrix_colors(A::AbstractMatrix,alg::ColoringAlgorithm = GreedyD1Color(); partition_by_rows::Bool = false)
107+
matrix_colors(A::AbstractMatrix,alg::ColoringAlgorithm = GreedyD1Color();
108+
partition_by_rows::Bool = false)
105109
```
106110

107111
The first argument is the abstract matrix which represents the sparsity pattern

0 commit comments

Comments
 (0)