Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Guillaume Dalle <[email protected]>
  • Loading branch information
amontoison and gdalle authored Jun 12, 2024
1 parent 10d0892 commit 4b64646
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions src/colpack_binary.jl
Original file line number Diff line number Diff line change
@@ -1,17 +1,18 @@
"""
colpack(file::String, method::String, order::String; verbose::Bool=false)
Perform graph coloring.
Perform graph coloring with the [ColPack executable](https://github.com/CSCsw/ColPack?tab=readme-ov-file#usage).
- `file`: Indicates the graph file path.
- `method`: Indicates the method.
- `order`: Indicates the ordering.
- `verbose`: Indicates verbose flag will be turned on and there will display more rich information.
Examples:
colpack("./bcsstk01.mtx", "DISTANCE_ONE", "RANDOM", verbose=true)
colpack("./bcsstk01.mtx", "ROW_PARTIAL_DISTANCE_TWO", "NATURAL", verbose=true)
colpack("./bcsstk01.mtx", "COLUMN_PARTIAL_DISTANCE_TWO", "NATURAL", verbose=true)
# Examples
colpack("./bcsstk01.mtx", "DISTANCE_ONE", "RANDOM", verbose=true)
colpack("./bcsstk01.mtx", "ROW_PARTIAL_DISTANCE_TWO", "NATURAL", verbose=true)
colpack("./bcsstk01.mtx", "COLUMN_PARTIAL_DISTANCE_TWO", "NATURAL", verbose=true)
"""
function colpack(file::String, method::String, order::String; verbose::Bool=false)
if verbose
Expand Down

0 comments on commit 4b64646

Please sign in to comment.