dev.md

Internals

CollapsedDocStrings = true
CurrentModule = SparseMatrixColorings

The docstrings on this page describe internals, they are not part of the public API.

Graph storage

SparseMatrixColorings.SparsityPatternCSC
SparseMatrixColorings.AdjacencyGraph
SparseMatrixColorings.BipartiteGraph
SparseMatrixColorings.vertices
SparseMatrixColorings.neighbors
transpose
SparseMatrixColorings.bidirectional_pattern

Low-level coloring

SparseMatrixColorings.partial_distance2_coloring
SparseMatrixColorings.star_coloring
SparseMatrixColorings.acyclic_coloring
SparseMatrixColorings.group_by_color
SparseMatrixColorings.Forest
SparseMatrixColorings.StarSet
SparseMatrixColorings.TreeSet

Concrete coloring results

SparseMatrixColorings.ColumnColoringResult
SparseMatrixColorings.RowColoringResult
SparseMatrixColorings.StarSetColoringResult
SparseMatrixColorings.TreeSetColoringResult
SparseMatrixColorings.LinearSystemColoringResult
SparseMatrixColorings.BicoloringResult
SparseMatrixColorings.remap_colors

Testing

SparseMatrixColorings.directly_recoverable_columns
SparseMatrixColorings.symmetrically_orthogonal_columns
SparseMatrixColorings.structurally_orthogonal_columns
SparseMatrixColorings.structurally_biorthogonal
SparseMatrixColorings.substitutable_columns
SparseMatrixColorings.substitutable_bidirectional
SparseMatrixColorings.rank_nonzeros_from_trees
SparseMatrixColorings.valid_dynamic_order

Matrix handling

SparseMatrixColorings.respectful_similar
SparseMatrixColorings.matrix_versions
SparseMatrixColorings.compatible_pattern

Visualization

SparseMatrixColorings.show_colors

Examples

SparseMatrixColorings.Example
SparseMatrixColorings.what_fig_41
SparseMatrixColorings.what_fig_61
SparseMatrixColorings.efficient_fig_1
SparseMatrixColorings.efficient_fig_4