yog_io - v0.5.0

yog_io

Yog IO - Graph file format I/O for the yog graph library.

Provides serialization and deserialization support for popular graph file formats:

Quick Start

import yog/model.{Directed}
import yog_io

// Create a graph
let graph =
  model.new(Directed)
  |> model.add_node(1, "Alice")
  |> model.add_node(2, "Bob")

let assert Ok(graph) = model.add_edge(graph, from: 1, to: 2, with: "friend")

// Write to GraphML
let assert Ok(Nil) = yog_io.write_graphml("graph.graphml", graph)

// Read from GraphML
let assert Ok(loaded) = yog_io.read_graphml("graph.graphml")

// Write to GDF
let assert Ok(Nil) = yog_io.write_gdf("graph.gdf", graph)

Module Structure

For more control over serialization, use the submodules directly.

Types

AttributeType

</> 
pub type AttributeType =
  graphml.AttributeType

AttributedGraph

</> 
pub type AttributedGraph =
  model.Graph(
    dict.Dict(String, String),
    dict.Dict(String, String),
  )

EdgeAttributes

</> 
pub type EdgeAttributes =
  dict.Dict(String, String)

GdfOptions

</> 
pub type GdfOptions =
  gdf.GdfOptions

GraphMLOptions

</> 
pub type GraphMLOptions =
  graphml.GraphMLOptions

NodeAttributes

</> 
pub type NodeAttributes =
  dict.Dict(String, String)

TypedEdgeAttributes

</> 
pub type TypedEdgeAttributes =
  dict.Dict(String, #(String, graphml.AttributeType))

TypedNodeAttributes

</> 
pub type TypedNodeAttributes =
  dict.Dict(String, #(String, graphml.AttributeType))

Values

boolean_type

</> 
pub const boolean_type: graphml.AttributeType

default_gdf_options

</> 
pub fn default_gdf_options() -> gdf.GdfOptions

Default options for GDF serialization.

default_graphml_options

</> 
pub fn default_graphml_options() -> graphml.GraphMLOptions

Default options for GraphML serialization.

double_type

</> 
pub const double_type: graphml.AttributeType

float_type

</> 
pub const float_type: graphml.AttributeType

int_type

</> 
pub const int_type: graphml.AttributeType

long_type

</> 
pub const long_type: graphml.AttributeType

read_gdf

</> 
pub fn read_gdf(
  path: String,
) -> Result(
  model.Graph(
    dict.Dict(String, String),
    dict.Dict(String, String),
  ),
  String,
)

Reads a graph from a GDF file.

This is a convenience function that reads node and edge data as string dictionaries. For custom data types, use gdf.read_with.

Example

let assert Ok(graph) = yog_io.read_gdf("graph.gdf")

read_graphml

</> 
pub fn read_graphml(
  path: String,
) -> Result(
  model.Graph(
    dict.Dict(String, String),
    dict.Dict(String, String),
  ),
  String,
)

Reads a graph from a GraphML file.

This is a convenience function that reads node and edge data as string dictionaries. For custom data types, use graphml.read_with.

Example

let assert Ok(graph) = yog_io.read_graphml("graph.graphml")

// Access node data
import gleam/dict
let node1_data = dict.get(graph.nodes, 1)

string_type

</> 
pub const string_type: graphml.AttributeType

write_gdf

</> 
pub fn write_gdf(
  path: String,
  graph: model.Graph(String, String),
) -> Result(Nil, simplifile.FileError)

Writes a graph to a GDF file.

This is a convenience function for graphs with string data. For custom data types, use gdf.write_with.

Example

import yog/model.{Directed}

let graph =
  model.new(Directed)
  |> model.add_node(1, "Alice")
  |> model.add_node(2, "Bob")

let assert Ok(graph) = model.add_edge(graph, from: 1, to: 2, with: "5")

let assert Ok(Nil) = yog_io.write_gdf("graph.gdf", graph)

write_graphml

</> 
pub fn write_graphml(
  path: String,
  graph: model.Graph(String, String),
) -> Result(Nil, simplifile.FileError)

Writes a graph to a GraphML file.

This is a convenience function for graphs with string data. For custom data types, use graphml.write_with.

Example

import yog/model.{Directed}

let graph =
  model.new(Directed)
  |> model.add_node(1, "Alice")
  |> model.add_node(2, "Bob")

let assert Ok(graph) = model.add_edge(graph, from: 1, to: 2, with: "5")

let assert Ok(Nil) = yog_io.write_graphml("graph.graphml", graph)
✨ Search Document