From e72da382aa16166cabfd231b0017da8774264bf3 Mon Sep 17 00:00:00 2001 From: "Documenter.jl" Date: Wed, 12 Jun 2024 06:38:17 +0000 Subject: [PATCH] build based on bd53666 --- dev/.documenter-siteinfo.json | 2 +- dev/api/index.html | 8 ++++---- dev/index.html | 2 +- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/dev/.documenter-siteinfo.json b/dev/.documenter-siteinfo.json index f1288b3..d2a96ca 100644 --- a/dev/.documenter-siteinfo.json +++ b/dev/.documenter-siteinfo.json @@ -1 +1 @@ -{"documenter":{"julia_version":"1.10.4","generation_timestamp":"2024-06-11T13:03:28","documenter_version":"1.4.1"}} \ No newline at end of file +{"documenter":{"julia_version":"1.10.4","generation_timestamp":"2024-06-12T06:38:14","documenter_version":"1.4.1"}} \ No newline at end of file diff --git a/dev/api/index.html b/dev/api/index.html index f0bfa05..c7c96c2 100644 --- a/dev/api/index.html +++ b/dev/api/index.html @@ -1,5 +1,5 @@ -API reference · ColPack.jl
GitHub

API reference

Public

ColPack.ColPackColoring — Type
ColPackColoring

Struct holding the parameters of a coloring as well as its results (which can be queried with get_colors).

Constructors

ColPackColoring(
+API reference · ColPack.jl
GitHub
API reference
Public
ColPack.ColPackColoring — Type
ColPackColoring
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.
source
ColPack.ColPackPartialColoring — Type
ColPackPartialColoring
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.
source
ColPack.ColPackPartialColoring — Type
ColPackPartialColoring
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.
source
Internals
ColPack.ColPackBiColoring — Type
ColPackBiColoring
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.
source
Internals
ColPack.ColPackBiColoring — Type
ColPackBiColoring
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.
source

+)

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.

source
diff --git a/dev/index.html b/dev/index.html index 02de3cb..56c5de0 100644 --- a/dev/index.html +++ b/dev/index.html @@ -1,2 +1,2 @@ -Home · ColPack.jl
GitHub

ColPack

Build Status Stable Documentation Dev Documentation

A Julia interface to the C++ library ColPack for graph and sparse matrix coloring.

Getting started

You can install this package by running the following command in a Julia Pkg REPL (the necessary binaries will be downloaded automatically):

pkg> add ColPack

Mathematical background

To understand the link between graph coloring and automatic differentiation, read the following survey:

What Color Is Your Jacobian? Graph Coloring for Computing Derivatives, Gebremedhin et al. (2005)

The ColPack library itself is described in:

ColPack: Software for graph coloring and related problems in scientific computing, Gebremedhin et al. (2012)

+Home · ColPack.jl
GitHub

ColPack

Build Status Stable Documentation Dev Documentation

A Julia interface to the C++ library ColPack for graph and sparse matrix coloring.

Getting started

You can install this package by running the following command in a Julia Pkg REPL (the necessary binaries will be downloaded automatically):

pkg> add ColPack

Mathematical background

To understand the link between graph coloring and automatic differentiation, read the following survey:

What Color Is Your Jacobian? Graph Coloring for Computing Derivatives, Gebremedhin et al. (2005)

The ColPack library itself is described in:

ColPack: Software for graph coloring and related problems in scientific computing, Gebremedhin et al. (2012)