vtkRandomGraphSource Class Reference

#include <vtkRandomGraphSource.h>

Inheritance diagram for vtkRandomGraphSource:

[legend]

Collaboration diagram for vtkRandomGraphSource:

[legend]

List of all members.

Detailed Description

a graph with random edges

Generates a graph with a specified number of vertices, with the density of edges specified by either an exact number of edges or the probability of an edge. You may additionally specify whether to begin with a random tree (which enforces graph connectivity).

Examples:: vtkRandomGraphSource (Examples)

Tests:: vtkRandomGraphSource (Tests)

Definition at line 45 of file vtkRandomGraphSource.h.


Public Types
typedef vtkGraphAlgorithm	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)

virtual int	GetNumberOfVertices ()
virtual void	SetNumberOfVertices (int)

virtual int	GetNumberOfEdges ()
virtual void	SetNumberOfEdges (int)

virtual double	GetEdgeProbability ()
virtual void	SetEdgeProbability (double)

virtual void	SetIncludeEdgeWeights (bool)
virtual bool	GetIncludeEdgeWeights ()
virtual void	IncludeEdgeWeightsOn ()
virtual void	IncludeEdgeWeightsOff ()

virtual void	SetEdgeWeightArrayName (const char *)
virtual char *	GetEdgeWeightArrayName ()

virtual void	SetDirected (bool)
virtual bool	GetDirected ()
virtual void	DirectedOn ()
virtual void	DirectedOff ()

virtual void	SetUseEdgeProbability (bool)
virtual bool	GetUseEdgeProbability ()
virtual void	UseEdgeProbabilityOn ()
virtual void	UseEdgeProbabilityOff ()

virtual void	SetStartWithTree (bool)
virtual bool	GetStartWithTree ()
virtual void	StartWithTreeOn ()
virtual void	StartWithTreeOff ()

virtual void	SetAllowSelfLoops (bool)
virtual bool	GetAllowSelfLoops ()
virtual void	AllowSelfLoopsOn ()
virtual void	AllowSelfLoopsOff ()

virtual void	SetAllowParallelEdges (bool)
virtual bool	GetAllowParallelEdges ()
virtual void	AllowParallelEdgesOn ()
virtual void	AllowParallelEdgesOff ()

virtual void	SetGeneratePedigreeIds (bool)
virtual bool	GetGeneratePedigreeIds ()
virtual void	GeneratePedigreeIdsOn ()
virtual void	GeneratePedigreeIdsOff ()

virtual void	SetVertexPedigreeIdArrayName (const char *)
virtual char *	GetVertexPedigreeIdArrayName ()

virtual void	SetEdgePedigreeIdArrayName (const char *)
virtual char *	GetEdgePedigreeIdArrayName ()

virtual void	SetSeed (int)
virtual int	GetSeed ()
Static Public Member Functions
static vtkRandomGraphSource *	New ()
static int	IsTypeOf (const char *type)
static vtkRandomGraphSource *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkRandomGraphSource ()
	~vtkRandomGraphSource ()
virtual int	RequestData (vtkInformation , vtkInformationVector , vtkInformationVector )

virtual int	RequestDataObject (vtkInformation , vtkInformationVector inputVector, vtkInformationVector outputVector)
Protected Attributes
int	NumberOfVertices
int	NumberOfEdges
double	EdgeProbability
bool	Directed
bool	UseEdgeProbability
bool	StartWithTree
bool	IncludeEdgeWeights
bool	AllowSelfLoops
bool	AllowParallelEdges
bool	GeneratePedigreeIds
int	Seed
char *	EdgeWeightArrayName
char *	VertexPedigreeIdArrayName
char *	EdgePedigreeIdArrayName

Member Typedef Documentation

typedef vtkGraphAlgorithm vtkRandomGraphSource::Superclass

Reimplemented from vtkGraphAlgorithm.

Reimplemented in vtkGeoRandomGraphSource.

Definition at line 49 of file vtkRandomGraphSource.h.

Constructor & Destructor Documentation

vtkRandomGraphSource::vtkRandomGraphSource ( ) [protected]

vtkRandomGraphSource::~vtkRandomGraphSource ( ) [protected]

Member Function Documentation

static vtkRandomGraphSource* vtkRandomGraphSource::New ( ) [static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkGraphAlgorithm.

Reimplemented in vtkGeoRandomGraphSource.

virtual const char* vtkRandomGraphSource::GetClassName ( ) [virtual]

Reimplemented from vtkGraphAlgorithm.

Reimplemented in vtkGeoRandomGraphSource.

static int vtkRandomGraphSource::IsTypeOf ( const char * name ) [static]

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkGraphAlgorithm.

Reimplemented in vtkGeoRandomGraphSource.

virtual int vtkRandomGraphSource::IsA ( const char * name ) [virtual]

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkGraphAlgorithm.

Reimplemented in vtkGeoRandomGraphSource.

static vtkRandomGraphSource* vtkRandomGraphSource::SafeDownCast ( vtkObject * o ) [static]

Reimplemented from vtkGraphAlgorithm.

Reimplemented in vtkGeoRandomGraphSource.

void vtkRandomGraphSource::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)			`[virtual]`

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkGraphAlgorithm.

Reimplemented in vtkGeoRandomGraphSource.

virtual int vtkRandomGraphSource::GetNumberOfVertices ( ) [virtual]

The number of vertices in the graph.

virtual void vtkRandomGraphSource::SetNumberOfVertices ( int ) [virtual]

The number of vertices in the graph.

virtual int vtkRandomGraphSource::GetNumberOfEdges ( ) [virtual]

If UseEdgeProbability is off, creates a graph with the specified number of edges. Duplicate (parallel) edges are allowed.

virtual void vtkRandomGraphSource::SetNumberOfEdges ( int ) [virtual]

If UseEdgeProbability is off, creates a graph with the specified number of edges. Duplicate (parallel) edges are allowed.

virtual double vtkRandomGraphSource::GetEdgeProbability ( ) [virtual]

If UseEdgeProbability is on, adds an edge with this probability between 0 and 1 for each pair of vertices in the graph.

virtual void vtkRandomGraphSource::SetEdgeProbability ( double ) [virtual]

If UseEdgeProbability is on, adds an edge with this probability between 0 and 1 for each pair of vertices in the graph.

virtual void vtkRandomGraphSource::SetIncludeEdgeWeights ( bool ) [virtual]

When set, includes edge weights in an array named "edge_weights". Defaults to off. Weights are random between 0 and 1.

virtual bool vtkRandomGraphSource::GetIncludeEdgeWeights ( ) [virtual]

When set, includes edge weights in an array named "edge_weights". Defaults to off. Weights are random between 0 and 1.

virtual void vtkRandomGraphSource::IncludeEdgeWeightsOn ( ) [virtual]

When set, includes edge weights in an array named "edge_weights". Defaults to off. Weights are random between 0 and 1.

virtual void vtkRandomGraphSource::IncludeEdgeWeightsOff ( ) [virtual]

When set, includes edge weights in an array named "edge_weights". Defaults to off. Weights are random between 0 and 1.

virtual void vtkRandomGraphSource::SetEdgeWeightArrayName ( const char * ) [virtual]

The name of the edge weight array. Default "edge weight".

virtual char* vtkRandomGraphSource::GetEdgeWeightArrayName ( ) [virtual]

The name of the edge weight array. Default "edge weight".

virtual void vtkRandomGraphSource::SetDirected ( bool ) [virtual]

When set, creates a directed graph, as opposed to an undirected graph.

virtual bool vtkRandomGraphSource::GetDirected ( ) [virtual]

When set, creates a directed graph, as opposed to an undirected graph.

virtual void vtkRandomGraphSource::DirectedOn ( ) [virtual]

When set, creates a directed graph, as opposed to an undirected graph.

virtual void vtkRandomGraphSource::DirectedOff ( ) [virtual]

When set, creates a directed graph, as opposed to an undirected graph.

virtual void vtkRandomGraphSource::SetUseEdgeProbability ( bool ) [virtual]

When set, uses the EdgeProbability parameter to determine the density of edges. Otherwise, NumberOfEdges is used.

virtual bool vtkRandomGraphSource::GetUseEdgeProbability ( ) [virtual]

When set, uses the EdgeProbability parameter to determine the density of edges. Otherwise, NumberOfEdges is used.

virtual void vtkRandomGraphSource::UseEdgeProbabilityOn ( ) [virtual]

When set, uses the EdgeProbability parameter to determine the density of edges. Otherwise, NumberOfEdges is used.

virtual void vtkRandomGraphSource::UseEdgeProbabilityOff ( ) [virtual]

When set, uses the EdgeProbability parameter to determine the density of edges. Otherwise, NumberOfEdges is used.

virtual void vtkRandomGraphSource::SetStartWithTree ( bool ) [virtual]

When set, builds a random tree structure first, then adds additional random edges.

virtual bool vtkRandomGraphSource::GetStartWithTree ( ) [virtual]

When set, builds a random tree structure first, then adds additional random edges.

virtual void vtkRandomGraphSource::StartWithTreeOn ( ) [virtual]

When set, builds a random tree structure first, then adds additional random edges.

virtual void vtkRandomGraphSource::StartWithTreeOff ( ) [virtual]

When set, builds a random tree structure first, then adds additional random edges.

virtual void vtkRandomGraphSource::SetAllowSelfLoops ( bool ) [virtual]

If this flag is set to true, edges where the source and target vertex are the same can be generated. The default is to forbid such loops.

virtual bool vtkRandomGraphSource::GetAllowSelfLoops ( ) [virtual]

If this flag is set to true, edges where the source and target vertex are the same can be generated. The default is to forbid such loops.

virtual void vtkRandomGraphSource::AllowSelfLoopsOn ( ) [virtual]

If this flag is set to true, edges where the source and target vertex are the same can be generated. The default is to forbid such loops.

virtual void vtkRandomGraphSource::AllowSelfLoopsOff ( ) [virtual]

If this flag is set to true, edges where the source and target vertex are the same can be generated. The default is to forbid such loops.

virtual void vtkRandomGraphSource::SetAllowParallelEdges ( bool ) [virtual]

When set, multiple edges from a source to a target vertex are allowed. The default is to forbid such loops.

virtual bool vtkRandomGraphSource::GetAllowParallelEdges ( ) [virtual]

When set, multiple edges from a source to a target vertex are allowed. The default is to forbid such loops.

virtual void vtkRandomGraphSource::AllowParallelEdgesOn ( ) [virtual]

When set, multiple edges from a source to a target vertex are allowed. The default is to forbid such loops.

virtual void vtkRandomGraphSource::AllowParallelEdgesOff ( ) [virtual]

When set, multiple edges from a source to a target vertex are allowed. The default is to forbid such loops.

virtual void vtkRandomGraphSource::SetGeneratePedigreeIds ( bool ) [virtual]

Add pedigree ids to vertex and edge data.

virtual bool vtkRandomGraphSource::GetGeneratePedigreeIds ( ) [virtual]

Add pedigree ids to vertex and edge data.

virtual void vtkRandomGraphSource::GeneratePedigreeIdsOn ( ) [virtual]

Add pedigree ids to vertex and edge data.

virtual void vtkRandomGraphSource::GeneratePedigreeIdsOff ( ) [virtual]

Add pedigree ids to vertex and edge data.

virtual void vtkRandomGraphSource::SetVertexPedigreeIdArrayName ( const char * ) [virtual]

The name of the vertex pedigree id array. Default "vertex id".

virtual char* vtkRandomGraphSource::GetVertexPedigreeIdArrayName ( ) [virtual]

The name of the vertex pedigree id array. Default "vertex id".

virtual void vtkRandomGraphSource::SetEdgePedigreeIdArrayName ( const char * ) [virtual]

The name of the edge pedigree id array. Default "edge id".

virtual char* vtkRandomGraphSource::GetEdgePedigreeIdArrayName ( ) [virtual]

The name of the edge pedigree id array. Default "edge id".

virtual void vtkRandomGraphSource::SetSeed ( int ) [virtual]

Control the seed used for pseudo-random-number generation. This ensures that vtkRandomGraphSource can produce repeatable results.

virtual int vtkRandomGraphSource::GetSeed ( ) [virtual]

Control the seed used for pseudo-random-number generation. This ensures that vtkRandomGraphSource can produce repeatable results.

virtual int vtkRandomGraphSource::RequestData	(	vtkInformation *	request,
		vtkInformationVector **	inputVector,
		vtkInformationVector *	outputVector
	)			`[protected, virtual]`

This is called by the superclass. This is the method you should override.

Reimplemented from vtkGraphAlgorithm.

Reimplemented in vtkGeoRandomGraphSource.

virtual int vtkRandomGraphSource::RequestDataObject	(	vtkInformation *	,
		vtkInformationVector **	inputVector,
		vtkInformationVector *	outputVector
	)			`[protected, virtual]`