Warn that single-color decompression is for direct coloring only (#87)

gdalle · web-flow · commit 21b2cadcfe2c · 2024-08-14T18:05:47.000+02:00
diff --git a/src/decompression.jl b/src/decompression.jl
@@ -191,7 +191,7 @@ function decompress! end
         result::AbstractColoringResult, [uplo=:F]
     )
 
-Decompress the vector `b` corresponding to color `c` in-place into `A`, given a coloring `result` of the sparsity pattern of `A`.
+Decompress the vector `b` corresponding to color `c` in-place into `A`, given a `:direct` coloring `result` of the sparsity pattern of `A` (it will not work with a `:substitution` coloring).
 
 - If `result` comes from a `:nonsymmetric` structure with `:column` partition, this will update the columns of `A` that share color `c` (whose sum makes up `b`).
 - If `result` comes from a `:nonsymmetric` structure with `:row` partition, this will update the rows of `A` that share color `c` (whose sum makes up `b`).

Original file line number	Diff line number	Diff line change
`@@ -191,7 +191,7 @@ function decompress! end`
`191`	`191`	`result::AbstractColoringResult, [uplo=:F]`
`192`	`192`	`)`
`193`	`193`
`194`		-Decompress the vector `b` corresponding to color `c` in-place into `A`, given a coloring `result` of the sparsity pattern of `A`.
	`194`	+Decompress the vector `b` corresponding to color `c` in-place into `A`, given a `:direct` coloring `result` of the sparsity pattern of `A` (it will not work with a `:substitution` coloring).
`195`	`195`
`196`	`196`	- If `result` comes from a `:nonsymmetric` structure with `:column` partition, this will update the columns of `A` that share color `c` (whose sum makes up `b`).
`197`	`197`	- If `result` comes from a `:nonsymmetric` structure with `:row` partition, this will update the rows of `A` that share color `c` (whose sum makes up `b`).