@spec parse(String.t()) :: {:ok, Yog.graph()} | {:error, atom()}

Parses a graph6 string into an undirected graph.

Returns {:ok, graph} on success, or {:error, reason} if the string is empty, malformed, or contains invalid characters or payload lengths.

Raises ArgumentError if string is not a binary string.

Time complexity: $\mathcal{O}(V^2)$ where $V$ is the number of nodes.

Examples

iex> {:ok, graph} = Yog.IO.Graph6.parse("DqK")
iex> Yog.Model.node_count(graph)
5
iex> Yog.Model.edge_count(graph)
5

@spec read(String.t()) :: {:ok, [Yog.graph()]} | {:error, atom()}

Reads one or more graph6 graphs from a file.

Each non-empty line in the file is treated as a separate graph6 string. Returns {:ok, [graph]} on success.

Raises ArgumentError if path is not a binary string.

@spec serialize(Yog.graph()) :: {:ok, String.t()} | {:error, atom()}

Serializes an undirected simple graph to a graph6 string.

The graph must be undirected, simple, and use integer node IDs 0..n-1.

Returns {:ok, string} on success, or {:error, reason} if the graph cannot be represented in graph6 format.

Raises ArgumentError if graph is not a Yog.Graph or Yog.DAG struct.

Time complexity: $\mathcal{O}(V^2 + E)$ where $V$ is the number of nodes and $E$ is the number of edges.

Examples

iex> graph = Yog.undirected() |> Yog.add_edge_ensure(0, 1, 1) |> Yog.add_edge_ensure(0, 2, 1) |> Yog.add_edge_ensure(1, 3, 1) |> Yog.add_edge_ensure(2, 4, 1) |> Yog.add_edge_ensure(3, 4, 1)
iex> {:ok, g6} = Yog.IO.Graph6.serialize(graph)
iex> g6
"DqK"

@spec write(String.t(), Yog.graph() | [Yog.graph()]) :: :ok | {:error, atom()}

Writes one or more graphs to a graph6 file.

Accepts either a single graph or a list of graphs. Each graph is written on its own line.

Raises ArgumentError if path is not a binary string or if graphs is not a valid graph struct or list of graph structs.