WhiteheadGraph Class Reference

Interface class for Whitehead graphs. More...

#include <WhiteheadGraph.h>

Inheritance diagram for WhiteheadGraph:

List of all members.

Public Member Functions
	WhiteheadGraph (const Word &w, int num_of_gens)
	Constructor.
const Word &	getWord () const
	Get the input word.
	WhiteheadGraph (int n_gens, const Word &w)
template<class ConstIterator>
void	assign (int n_gens, ConstIterator B, ConstIterator E)
const Graph &	getGraph ()
Protected Attributes
Word	theWord
	The input word.
int	nOfGenerators
	The number of generators in the group.
Private Attributes
Graph	theGraph

---

Detailed Description

Interface class for Whitehead graphs.

Definition at line 121 of file WhiteheadGraph.h.

---

Constructor & Destructor Documentation

WhiteheadGraph::WhiteheadGraph	(	const Word &	w,
		int	num_of_gens
	)			[inline]

Constructor.

Parameters:

	w	- the input word.
	num_of_gens	- the number of generators in the corresponding group (i.e. .

Definition at line 130 of file WhiteheadGraph.h.

WhiteheadGraph::WhiteheadGraph	(	int	n_gens,
		const Word &	w
	)			[inline]

Definition at line 35 of file WhiteheadGraph.h.

References assign(), Word::begin(), and Word::end().

---

Member Function Documentation

const Word& WhiteheadGraph::getWord

(

)

const [inline]

Get the input word.

Definition at line 138 of file WhiteheadGraph.h.

References theWord.

template<class ConstIterator>

void WhiteheadGraph::assign	(	int	n_gens,
		ConstIterator	B,
		ConstIterator	E
	)			[inline]

Definition at line 44 of file WhiteheadGraph.h.

References Graph::clear(), Graph::newEdge(), and theGraph.

Referenced by WhiteheadGraph().

const Graph& WhiteheadGraph::getGraph

(

)

[inline]

Definition at line 65 of file WhiteheadGraph.h.

References theGraph.

---

Member Data Documentation

Word WhiteheadGraph::theWord [protected]

The input word.

Definition at line 141 of file WhiteheadGraph.h.

Referenced by getWord().

int WhiteheadGraph::nOfGenerators [protected]

The number of generators in the group.

Definition at line 143 of file WhiteheadGraph.h.

Referenced by WhiteheadSimpleGraph::genToIndex(), and WhiteheadSimpleGraph::indToGenerator().

Graph WhiteheadGraph::theGraph [private]

Definition at line 76 of file WhiteheadGraph.h.

Referenced by assign(), and getGraph().

---

The documentation for this class was generated from the following files:

• FreeGroup/include/WhiteheadGraph.h
• SbgpFG/include/WhiteheadGraph.h