Skip to content

Commit

Permalink
Add draft description of the project.
Browse files Browse the repository at this point in the history
  • Loading branch information
vahancho committed Dec 4, 2023
1 parent 0d32d98 commit 54e0e5a
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# The Graphene

Graphene is a library that implements an abstract graph. The class template allows
creation of graphs of any types of nodes both directed and undirected with
the custom weight function.

## Shortest paths

The library calculates shortest path between two nodes using the Dijkstra algorithm.
However the term "shortest" is an abstraction, because the distance between
to nodes is just a particular notion of the weight of the graph edge. `Graphene`
allows to define custom weight functions, so that the algorithm will calculate
not only the shortest path, but the path that corresponds to the minimal overall
"weight".

# See also

[California Road Network](https://users.cs.utah.edu/~lifeifei/SpatialDataset.htm)

0 comments on commit 54e0e5a

Please sign in to comment.