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

use super::*;
///
/// Represents an edge between two vertices in a graph.
///
///	The edge is implicitly directed from the `source` to the `sink` with some weight `weight`.
///
/// Parameters:
///
/// - `V`: The type of the vertices.
/// - `W`: The type of the weight.
#[derive(Copy,Clone,Debug,PartialEq,Eq)]
pub struct BaseEdge<V,W>
where
	V: Vertex,
	W: Weight,
{
	/// The vertex the edge starts in.
	pub source: V,
	/// The vertex the edge ends in.
	pub sink:V,
	/// The weight of the edge.
	pub weight: W,
}

impl<V:Vertex, W:Weight> BaseEdge<V,W>{
	
	/// Creates a new edge
	pub fn new(source: V, sink: V, weight: W)-> BaseEdge<V,W>{
		BaseEdge{source, sink, weight}
	}
	/// Returns a copy of the vertex the edge starts in.
	pub fn source(&self) -> V {
		self.source
	}
	/// Returns a copy of the vertex the edge ends in.
	pub fn sink(&self) -> V {
		self.sink
	}
	/// Returns a copy of the weight of the edge.
	pub fn weight(&self) -> W{
		self.weight
	}
}