Skip to content

Commit

Permalink
Dont export bicoloring
Browse files Browse the repository at this point in the history
  • Loading branch information
gdalle authored and amontoison committed Jun 11, 2024
1 parent ce83d29 commit 2f247a4
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 8 deletions.
2 changes: 1 addition & 1 deletion src/ColPack.jl
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,6 @@ include("colpack_bicoloring.jl")

# Exports

export ColPackColoring, ColPackPartialColoring, ColPackBiColoring, get_colors
export ColPackColoring, ColPackPartialColoring, get_colors

end #module
15 changes: 9 additions & 6 deletions src/colpack_bicoloring.jl
Original file line number Diff line number Diff line change
Expand Up @@ -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(
Expand Down Expand Up @@ -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)
Expand Down
2 changes: 1 addition & 1 deletion test/coloring.jl
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions test/exceptions.jl
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
using ColPack
using ColPack: ColPackBiColoring
using SparseArrays
using Test

Expand Down

0 comments on commit 2f247a4

Please sign in to comment.