seed Class Reference

Potential Cluster. More...

#include <seed.h>

List of all members.

Public Types
typedef std::set < directed_t::vertex >	vertex_set
Public Member Functions
	seed (const density< bidirected_t > *dens, const bidirected_t::graph &g)
	seed (const density< bidirected_t > *dens, const bidirected_t::graph &g, bidirected_t::vertex s)
	seed (const seed &other)
seed &	operator= (const seed &rhs)
bool	can_add_vertex (const bidirected_t::vertex &v) const
bool	can_rm_vertex (const bidirected_t::vertex &v) const
void	add_vertex (const bidirected_t::vertex &v)
void	rm_vertex (const bidirected_t::vertex &v)
const bidirected_t::edge_name_t &	win () const
const bidirected_t::edge_name_t &	wout () const
const bidirected_t::graph &	graph () const
const density< bidirected_t > *	dens_func () const
const vertex_set &	vertices () const
double	dens () const
void	print ()

---

Detailed Description

Potential Cluster.

Keeps track of internal density, external density, vertices in seed, a density class, and provides functions to help decided if vertices should be added or removed.

---

Member Typedef Documentation

typedef std::set<directed_t::vertex> seed::vertex_set

Set of vertices (seed or community)

---

Constructor & Destructor Documentation

seed::seed	(	const density< bidirected_t > *	dens,
		const bidirected_t::graph &	g
	)

Constructor

Parameters:

dens	Density class to compute 'fitness' function
g	The network

seed::seed	(	const density< bidirected_t > *	dens,
		const bidirected_t::graph &	g,
		bidirected_t::vertex	s
	)

Constructor

Parameters:

dens	Density class to compute 'fitness' function
g	The network
s	Vertex to initialize seed with

seed::seed

(

const seed &

other

)

Copy Constructor

Parameters:

other

Seed to copy

---

Member Function Documentation

void seed::add_vertex

(

const bidirected_t::vertex &

v

)

Adds a vertex to the seed

Parameters:

v	Vertex to add

bool seed::can_add_vertex

(

const bidirected_t::vertex &

v

)

const

Checks to see if adding a vertex will increase the density value

Parameters:

v	Vertex to consider adding

bool seed::can_rm_vertex

(

const bidirected_t::vertex &

v

)

const

Checks to see if removing a vertex will increase the density value

Parameters:

v	Vertex to consider removing

double seed::dens

(

)

const [inline]

Calculate the density

Returns:

Density of seed

const density<bidirected_t>* seed::dens_func

(

)

const [inline]

Get Function

Returns:

the density class

const bidirected_t::graph& seed::graph

(

)

const [inline]

Get Function

Returns:

The network

seed & seed::operator=

(

const seed &

rhs

)

Operator overload for assignment operator

Parameters:

rhs	Seed to set equal to

void seed::print

(

)

Print the seed

void seed::rm_vertex

(

const bidirected_t::vertex &

v

)

Removes a vertex to the seed

Parameters:

v	Vertex to remove

const vertex_set& seed::vertices

(

)

const [inline]

Get Function

Returns:

Set of vertices in seed

const bidirected_t::edge_name_t& seed::win

(

)

const [inline]

Get Function

Returns:

Sum of internal edge weights

const bidirected_t::edge_name_t& seed::wout

(

)

const [inline]

Get Function

Returns:

Sum of external edge weights

---

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

• seed.h
• seed.cc