juliagraphs / graphsinterfacechecker.jl

Formalization of the AbstractGraph interface from Graphs.jl, specified using Interfaces.jl.

GraphsInterfaceChecker

Formalization of the AbstractGraph interface from Graphs.jl, specified using Interfaces.jl.

Getting started

Install GraphsInterfaceChecker.jl using the GitHub URL, and install Interfaces.jl from the general registry:

using Pkg

Pkg.add(url="https://github.com/JuliaGraphs/GraphsInterfaceChecker.jl")
Pkg.add("Interfaces")

using GraphsInterfaceChecker
using Interfaces

Creating a new graph type

The only name exported by this package is AbstractGraphInterface.

Suppose you define a new graph type MyGraphType <: Graphs.AbstractGraph. To declare that you implement the interface, you need to provide a list of (small) test_graphs, then use the macro Interfaces.@implements like so:

Interfaces.@implements AbstractGraphInterface MyGraphType test_graphs

Then, you can validate your implementation as follows:

Interfaces.test(AbstractGraphInterface, MyGraphType)

graphsinterfacechecker.jl's Issues

Conditional tests

Example: directedness

• If the graph is undirected, check that has_edge(g, s, d) == has_edge(g, d, s)

Check vertex types

Move to JuliaGraphs and register

Optional parts of the interface

Graph modification:

• add_vertex!, add_edge!
• rem_vertex!, rem_edge!

Weights

• weights