API reference
Public
ColPack.ColPack — ModuleColPack.ColPackColoring — TypeColPackColoringStruct holding the parameters of a coloring as well as its results (which can be queried with get_colors).
Constructors
ColPackColoring(
+API reference · ColPack.jl API reference
Public
ColPack.ColPack — Modulesource ColPack.ColPackColoring — TypeColPackColoring
Struct holding the parameters of a coloring as well as its results (which can be queried with get_colors).
Constructors
ColPackColoring(
filename::AbstractString,
method::String,
order::String;
@@ -23,7 +23,7 @@
3-element Vector{Int32}:
1
2
- 2
Fields
The fields of this struct are not part of the public API, they are only useful to interface with the C++ library ColPack.
sourceColPack.ColPackPartialColoring — TypeColPackPartialColoring
Struct holding the parameters of a partial coloring as well as its results (which can be queried with get_colors).
Constructors
ColPackPartialColoring(
+ 2
Fields
The fields of this struct are not part of the public API, they are only useful to interface with the C++ library ColPack.
sourceColPack.ColPackPartialColoring — TypeColPackPartialColoring
Struct holding the parameters of a partial coloring as well as its results (which can be queried with get_colors).
Constructors
ColPackPartialColoring(
filename::AbstractString,
method::String,
order::String;
@@ -46,7 +46,7 @@
3-element Vector{Int32}:
1
2
- 2
Fields
The fields of this struct are not part of the public API, they are only useful to interface with the C++ library ColPack.
sourceColPack.get_colors — Methodget_colors(coloring::ColPackBiColoring)
Retrieve the colors from a ColPackBiColoring as two vectors of integers, one for the rows and one for the columns respectively.
sourceColPack.get_colors — Methodget_colors(coloring::ColPackColoring)
Retrieve the colors from a ColPackColoring as a vector of integers.
sourceColPack.get_colors — Methodget_colors(coloring::ColPackPartialColoring)
Retrieve the colors from a ColPackPartialColoring as a vector of integers.
sourceInternals
ColPack.ColPackBiColoring — TypeColPackBiColoring
Struct holding the parameters of a bicoloring as well as its results (which can be queried with get_colors).
Danger This is still experimental and not protected by semantic versioning, use at your own risk.
Constructors
ColPackBiColoring(
+ 2
Fields
The fields of this struct are not part of the public API, they are only useful to interface with the C++ library ColPack.
sourceColPack.get_colors — Methodget_colors(coloring::ColPackBiColoring)
Retrieve the colors from a ColPackBiColoring as two vectors of integers, one for the rows and one for the columns respectively.
sourceColPack.get_colors — Methodget_colors(coloring::ColPackColoring)
Retrieve the colors from a ColPackColoring as a vector of integers.
sourceColPack.get_colors — Methodget_colors(coloring::ColPackPartialColoring)
Retrieve the colors from a ColPackPartialColoring as a vector of integers.
sourceInternals
ColPack.ColPackBiColoring — TypeColPackBiColoring
Struct holding the parameters of a bicoloring as well as its results (which can be queried with get_colors).
Danger This is still experimental and not protected by semantic versioning, use at your own risk.
Constructors
ColPackBiColoring(
filename::AbstractString,
method::String,
order::String;
@@ -58,4 +58,4 @@
method::String,
order::String;
verbose::Bool=false
-)
Perform the coloring of a matrix that is either given directly or read from a .mtx file.
The users needs to specify
- a bicoloring
method among ["IMPLICIT_COVERING__STAR_BICOLORING", "EXPLICIT_COVERING__STAR_BICOLORING", "EXPLICIT_COVERING__MODIFIED_STAR_BICOLORING", "IMPLICIT_COVERING__GREEDY_STAR_BICOLORING"] - an
order on the vertices among ["NATURAL", "RANDOM", "LARGEST_FIRST", "DYNAMIC_LARGEST_FIRST", "SMALLEST_LAST", "INCIDENCE_DEGREE"]
Fields
The fields of this struct are not part of the public API, they are only useful to interface with the C++ library ColPack.
sourceSettings
This document was generated with Documenter.jl version 1.4.1 on Wednesday 12 June 2024. Using Julia version 1.10.4.
Perform the coloring of a matrix that is either given directly or read from a .mtx file.
The users needs to specify
- a bicoloring
methodamong["IMPLICIT_COVERING__STAR_BICOLORING", "EXPLICIT_COVERING__STAR_BICOLORING", "EXPLICIT_COVERING__MODIFIED_STAR_BICOLORING", "IMPLICIT_COVERING__GREEDY_STAR_BICOLORING"] - an
orderon the vertices among["NATURAL", "RANDOM", "LARGEST_FIRST", "DYNAMIC_LARGEST_FIRST", "SMALLEST_LAST", "INCIDENCE_DEGREE"]
Fields
The fields of this struct are not part of the public API, they are only useful to interface with the C++ library ColPack.
