Commit 5e27443

authored

adding documentation for graph structure

1 parent e8c075b commit 5e27443Copy full SHA for 5e27443

File tree

+29

-1

lines changed

+29

-1

lines changed

Lines changed: 29 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -16,6 +16,34 @@ Legend:`
`16`	`16`	`* Two vertices are called adjacent if they are connected by an edge.`
`17`	`17`	`* Two edges are called incident, if they share a vertex.`
`18`	`18`
	`19`	`+## Basic Graph`
	`20`	`+`
	`21`	`+![Graph Structure](doc/graph.jpg)`
	`22`	`+`
	`23`	+```cpp
	`24`	`+ class bNode {`
	`25`	`+ private:`
	`26`	`+ string name_; // node name`
	`27`	`+ set<const bEdge*, edgeCompare> edgelist_; // incident list`
	`28`	`+ ...`
	`29`	`+ }/`
	`30`	`+ class bEdge {`
	`31`	`+ private:`
	`32`	`+ const bNode* n1_; // from node for directd graphs`
	`33`	`+ const bNode* n2_; // to node for directed graphs`
	`34`	`+ ...`
	`35`	`+ };`
	`36`	`+ ...`
	`37`	`+ class bGraph {`
	`38`	`+ private:`
	`39`	`+ bool isDirected_;`
	`40`	`+ set<const bNode*, nodeCompare> nodeset_;`
	`41`	`+ set<const bEdge*, edgeCompare> edgeset_;`
	`42`	`+ ...`
	`43`	`+ };`
	`44`	`+`
	`45`	+```
	`46`	`+`
`19`	`47`	`## Algorithms Covered`
`20`	`48`
`21`	`49`	`* [DFS](src/dfs.h)`
@@ -36,7 +64,7 @@ graph (un)directed`
`36`	`64`
`37`	`65`	`*Example Graph File*`
`38`	`66`
`39`		`-![](https://github.com/srohit0/BasicGraphAlgorithmsCpp/blob/master/docs/ExampleGraph.JPG)`
	`67`	`+![Example Graph](docs/ExampleGraph.JPG)`
`40`	`68`
`41`	`69`	```
`42`	`70`	`# Comment, ignored by the graph reader`

Comments

(0)