Skip to content

Commit e83f59c

Browse files
committed
Remove warnings on ColPack orders
1 parent 35d3e89 commit e83f59c

1 file changed

Lines changed: 7 additions & 7 deletions

File tree

src/order.jl

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -109,17 +109,17 @@ end
109109
110110
Instance of [`AbstractOrder`](@ref) which sorts vertices using a dynamically computed degree.
111111
112-
!!! danger
113-
This order is still experimental and needs more tests, correctness is not yet guaranteed.
114-
115112
# Type parameters
116113
117114
- `degtype::Symbol`: can be `:forward` (for the forward degree) or `:back` (for the back degree)
118115
- `direction::Symbol`: can be `:low2high` (if the order is defined from lowest to highest, i.e. `1` to `n`) or `:high2low` (if the order is defined from highest to lowest, i.e. `n` to `1`)
119116
120117
# Settings
121118
122-
- `reproduce_colpack::Bool`: whether to manage the buckets in the same way as the original ColPack implementation. When `reproduce_colpack=true`, we always append and remove vertices from the end of a bucket, which incurs a large performance penalty because every modification requires a circular permutation of the corresponding bucket. This setting is mostly for the purpose of reproducing past research results which rely on implementation details.
119+
- `reproduce_colpack::Bool`: whether to manage the buckets in the exact same way as the original ColPack implementation. When `reproduce_colpack=true`, we always append and remove vertices from the end of a bucket, which incurs a significant performance penalty because every modification requires a circular permutation of the corresponding bucket. This setting is mostly for the purpose of reproducing past research results which rely on implementation details.
120+
121+
!!! danger
122+
The option `reproduce_colpack=true` induces a large slowdown to mirror the original implementation details of ColPack, it should not be used in performance-sensitive applications.
123123
124124
# Concrete variants
125125
@@ -392,7 +392,7 @@ end
392392
Instance of [`AbstractOrder`](@ref) which sorts vertices from lowest to highest using the dynamic back degree.
393393
394394
!!! danger
395-
This order is still experimental and needs more tests, correctness is not yet guaranteed.
395+
The option `reproduce_colpack=true` induces a large slowdown to mirror the original implementation details of ColPack, it should not be used in performance-sensitive applications.
396396
397397
# See also
398398
@@ -406,7 +406,7 @@ const IncidenceDegree = DynamicDegreeBasedOrder{:back,:low2high}
406406
Instance of [`AbstractOrder`](@ref) which sorts vertices from highest to lowest using the dynamic back degree.
407407
408408
!!! danger
409-
This order is still experimental and needs more tests, correctness is not yet guaranteed.
409+
The option `reproduce_colpack=true` induces a large slowdown to mirror the original implementation details of ColPack, it should not be used in performance-sensitive applications.
410410
411411
# See also
412412
@@ -420,7 +420,7 @@ const SmallestLast = DynamicDegreeBasedOrder{:back,:high2low}
420420
Instance of [`AbstractOrder`](@ref) which sorts vertices from lowest to highest using the dynamic forward degree.
421421
422422
!!! danger
423-
This order is still experimental and needs more tests, correctness is not yet guaranteed.
423+
The option `reproduce_colpack=true` induces a large slowdown to mirror the original implementation details of ColPack, it should not be used in performance-sensitive applications.
424424
425425
# See also
426426

0 commit comments

Comments
 (0)