graphene 0.1.5

A general purpose, extensible Graph Theory data type and algorithm library for Rust.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62


# graphene
[![Build Status](https://travis-ci.org/Emoun/graphene.svg?branch=master)](https://travis-ci.org/Emoun/graphene)
[![](http://meritbadge.herokuapp.com/graphene)](https://crates.io/crates/graphene)
[![](https://docs.rs/graphene/badge.svg)](https://docs.rs/graphene)

A general purpose, extensible [Graph Theory](https://en.wikipedia.org/wiki/Graph_theory)
data type and algorithm library for Rust.

This project is still in early design and development stage and is still changing a lot.
A good public API is not the focus of the project yet, documentation may be scarce, and bugs may be rampant.

## Example

```Rust
#[macro_use]
extern crate graphene;
use graphene::core::*;
use graphene::core::constraint::*;
use graphene::common::AdjListGraph;
//!
custom_graph!{
	// Name of the resulting graph type
	struct MyGraph<V,W>
	// The BaseGraph implementation to base the new graph on.
	as AdjListGraph<V,W>
	// The graph wrappers that will constrain the BaseGraph implementation so that
	// it upholds the constraint traits.
	use UniqueGraph,UndirectedGraph
	// The constraint traits the new graph implements
	impl Unique,Undirected
	// The generic bounds
	where V: Vertex, W: Weight
}

fn main(){
    let mut g = MyGraph::graph(vec![1,2,3], vec![(1,2,1),(2,3,2),(3,1,3)]).unwrap();
	assert_eq!(g.edges_between(1,2).len(), 2);

	// Cannot add an edge that is already there because the graph
	// is declared as Unique, meaning no two edges may be incident
	// on the same vertices and have the weight.
	assert!(g.add_edge(BaseEdge::new(1,2,1)).is_err());
	assert_eq!(g.edges_between(1,2).len(), 2);
}
```

### License

Licensed under the MIT license.

Any file with its own license header is also licensed under the above license, at your option.
If the header specifies a different license than the above, it must be seen as an additional choice of license
and the above license or the header license can be chosen at your option.

Any intentional contribution to this repository is licensed under the above license in addition
to any contribution specific license without exception.