diff --git a/src/ColPack.jl b/src/ColPack.jl index fcf0d57..3f003f5 100644 --- a/src/ColPack.jl +++ b/src/ColPack.jl @@ -28,6 +28,6 @@ include("colpack_bicoloring.jl") # Exports -export ColPackColoring, ColPackPartialColoring, ColPackBiColoring, get_colors +export ColPackColoring, ColPackPartialColoring, get_colors end #module diff --git a/src/colpack_bicoloring.jl b/src/colpack_bicoloring.jl index fe80eff..4426d8a 100644 --- a/src/colpack_bicoloring.jl +++ b/src/colpack_bicoloring.jl @@ -3,13 +3,16 @@ Struct holding the parameters of a bicoloring as well as its results (which can be queried with [`get_colors`](@ref)). +!!! danger + This is still experimental and not protected by semantic versioning, use at your own risk. + # Constructors -ColPackBiColoring( - filename::AbstractString, - method::String, - order::String; - verbose::Bool=false + ColPackBiColoring( + filename::AbstractString, + method::String, + order::String; + verbose::Bool=false ) ColPackBiColoring( @@ -66,7 +69,7 @@ end """ get_colors(coloring::ColPackBiColoring) -Retrieve the colors from a [`ColPackBiColoring`](@ref) as two vectors of integers. +Retrieve the colors from a [`ColPackBiColoring`](@ref) as two vectors of integers, one for the rows and one for the columns respectively. """ function get_colors(coloring::ColPackBiColoring) get_bicoloring(coloring.refColPack[], coloring.coloring1, coloring.coloring2) diff --git a/test/coloring.jl b/test/coloring.jl index 8be62c1..b7bc4be 100644 --- a/test/coloring.jl +++ b/test/coloring.jl @@ -1,4 +1,5 @@ using ColPack +using ColPack: ColPackBiColoring using ColPack: COLORING_METHODS, PARTIAL_COLORING_METHODS, BICOLORING_METHODS using ColPack: COLORING_ORDERS, PARTIAL_COLORING_ORDERS, BICOLORING_ORDERS using LinearAlgebra @@ -47,7 +48,6 @@ function test_colors( This makes it hard to test it properly. =# @test length(colors1) <= size(A, 1) - @test maximum(colors1) <= size(A, 1) @test length(colors2) <= size(A, 2) @test isempty(intersect(Set(colors1), Set(colors2))) end diff --git a/test/exceptions.jl b/test/exceptions.jl index 1c56a76..abe53f9 100644 --- a/test/exceptions.jl +++ b/test/exceptions.jl @@ -1,4 +1,5 @@ using ColPack +using ColPack: ColPackBiColoring using SparseArrays using Test