VTK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkPBGLRandomGraphSource Class Reference

Generates a distributed graph with random edges. More...

#include <vtkPBGLRandomGraphSource.h>

Inherits vtkGraphAlgorithm.

Public Types

typedef vtkGraphAlgorithm Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkPBGLRandomGraphSourceNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual vtkIdType GetNumberOfVertices ()
 
virtual void SetNumberOfVertices (vtkIdType)
 
virtual vtkIdType GetNumberOfEdges ()
 
virtual void SetNumberOfEdges (vtkIdType)
 
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 SetAllowBalancedEdgeDistribution (bool)
 
virtual bool GetAllowBalancedEdgeDistribution ()
 
virtual void AllowBalancedEdgeDistributionOn ()
 
virtual void AllowBalancedEdgeDistributionOff ()
 
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 vtkPBGLRandomGraphSourceNew ()
 
static int IsTypeOf (const char *type)
 
static vtkPBGLRandomGraphSourceSafeDownCast (vtkObjectBase *o)
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 vtkPBGLRandomGraphSource ()
 
 ~vtkPBGLRandomGraphSource ()
 
virtual int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
virtual int RequestDataObject (vtkInformation *, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 

Protected Attributes

vtkIdType NumberOfVertices
 
vtkIdType NumberOfEdges
 
double EdgeProbability
 
bool Directed
 
bool UseEdgeProbability
 
bool StartWithTree
 
bool IncludeEdgeWeights
 
bool AllowSelfLoops
 
bool AllowBalancedEdgeDistribution
 
bool GeneratePedigreeIds
 
int Seed
 
char * EdgeWeightArrayName
 
char * VertexPedigreeIdArrayName
 
char * EdgePedigreeIdArrayName
 

Detailed Description

Generates a distributed graph with random edges.

Generates a distributed 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). This is the distributed-graph version of vtkRandomGraphSource.

Examples:
vtkPBGLRandomGraphSource (Examples)
Tests:
vtkPBGLRandomGraphSource (Tests)

Definition at line 49 of file vtkPBGLRandomGraphSource.h.

Member Typedef Documentation

typedef vtkGraphAlgorithm vtkPBGLRandomGraphSource::Superclass

Definition at line 53 of file vtkPBGLRandomGraphSource.h.

Constructor & Destructor Documentation

vtkPBGLRandomGraphSource::vtkPBGLRandomGraphSource ( )
protected
vtkPBGLRandomGraphSource::~vtkPBGLRandomGraphSource ( )
protected

Member Function Documentation

static vtkPBGLRandomGraphSource* vtkPBGLRandomGraphSource::New ( )
static
static int vtkPBGLRandomGraphSource::IsTypeOf ( const char *  type)
static
virtual int vtkPBGLRandomGraphSource::IsA ( const char *  type)
virtual
static vtkPBGLRandomGraphSource* vtkPBGLRandomGraphSource::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkPBGLRandomGraphSource::NewInstanceInternal ( ) const
protectedvirtual
vtkPBGLRandomGraphSource* vtkPBGLRandomGraphSource::NewInstance ( ) const
void vtkPBGLRandomGraphSource::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual vtkIdType vtkPBGLRandomGraphSource::GetNumberOfVertices ( )
virtual

The number of vertices in the graph.

virtual void vtkPBGLRandomGraphSource::SetNumberOfVertices ( vtkIdType  )
virtual

The number of vertices in the graph.

virtual vtkIdType vtkPBGLRandomGraphSource::GetNumberOfEdges ( )
virtual

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

virtual void vtkPBGLRandomGraphSource::SetNumberOfEdges ( vtkIdType  )
virtual

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

virtual double vtkPBGLRandomGraphSource::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 vtkPBGLRandomGraphSource::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 vtkPBGLRandomGraphSource::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 vtkPBGLRandomGraphSource::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 vtkPBGLRandomGraphSource::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 vtkPBGLRandomGraphSource::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 vtkPBGLRandomGraphSource::SetEdgeWeightArrayName ( const char *  )
virtual

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

virtual char* vtkPBGLRandomGraphSource::GetEdgeWeightArrayName ( )
virtual

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

virtual void vtkPBGLRandomGraphSource::SetDirected ( bool  )
virtual

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

virtual bool vtkPBGLRandomGraphSource::GetDirected ( )
virtual

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

virtual void vtkPBGLRandomGraphSource::DirectedOn ( )
virtual

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

virtual void vtkPBGLRandomGraphSource::DirectedOff ( )
virtual

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

virtual void vtkPBGLRandomGraphSource::SetUseEdgeProbability ( bool  )
virtual

When set, uses the EdgeProbability parameter to determine the density of edges. Otherwise, NumberOfEdges is used. Note that using the EdgeProbability on a large, sparse graph is extremely inefficient. For these cases, set NumberOfEdges to the expected number of edges one would receive with the given EdgeProbability and NumberOfVertices.

virtual bool vtkPBGLRandomGraphSource::GetUseEdgeProbability ( )
virtual

When set, uses the EdgeProbability parameter to determine the density of edges. Otherwise, NumberOfEdges is used. Note that using the EdgeProbability on a large, sparse graph is extremely inefficient. For these cases, set NumberOfEdges to the expected number of edges one would receive with the given EdgeProbability and NumberOfVertices.

virtual void vtkPBGLRandomGraphSource::UseEdgeProbabilityOn ( )
virtual

When set, uses the EdgeProbability parameter to determine the density of edges. Otherwise, NumberOfEdges is used. Note that using the EdgeProbability on a large, sparse graph is extremely inefficient. For these cases, set NumberOfEdges to the expected number of edges one would receive with the given EdgeProbability and NumberOfVertices.

virtual void vtkPBGLRandomGraphSource::UseEdgeProbabilityOff ( )
virtual

When set, uses the EdgeProbability parameter to determine the density of edges. Otherwise, NumberOfEdges is used. Note that using the EdgeProbability on a large, sparse graph is extremely inefficient. For these cases, set NumberOfEdges to the expected number of edges one would receive with the given EdgeProbability and NumberOfVertices.

virtual void vtkPBGLRandomGraphSource::SetStartWithTree ( bool  )
virtual

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

virtual bool vtkPBGLRandomGraphSource::GetStartWithTree ( )
virtual

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

virtual void vtkPBGLRandomGraphSource::StartWithTreeOn ( )
virtual

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

virtual void vtkPBGLRandomGraphSource::StartWithTreeOff ( )
virtual

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

virtual void vtkPBGLRandomGraphSource::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 vtkPBGLRandomGraphSource::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 vtkPBGLRandomGraphSource::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 vtkPBGLRandomGraphSource::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 vtkPBGLRandomGraphSource::SetAllowBalancedEdgeDistribution ( bool  )
virtual

When set, allows the generator to create a graph where the number of outgoing edges is balanced across all of the processes. Such graphs are faster to generate in parallel, but do not conform exactly to the random graph model because the generator restricts the domain of the randomly-generated source vertex of each edge.

virtual bool vtkPBGLRandomGraphSource::GetAllowBalancedEdgeDistribution ( )
virtual

When set, allows the generator to create a graph where the number of outgoing edges is balanced across all of the processes. Such graphs are faster to generate in parallel, but do not conform exactly to the random graph model because the generator restricts the domain of the randomly-generated source vertex of each edge.

virtual void vtkPBGLRandomGraphSource::AllowBalancedEdgeDistributionOn ( )
virtual

When set, allows the generator to create a graph where the number of outgoing edges is balanced across all of the processes. Such graphs are faster to generate in parallel, but do not conform exactly to the random graph model because the generator restricts the domain of the randomly-generated source vertex of each edge.

virtual void vtkPBGLRandomGraphSource::AllowBalancedEdgeDistributionOff ( )
virtual

When set, allows the generator to create a graph where the number of outgoing edges is balanced across all of the processes. Such graphs are faster to generate in parallel, but do not conform exactly to the random graph model because the generator restricts the domain of the randomly-generated source vertex of each edge.

virtual void vtkPBGLRandomGraphSource::SetGeneratePedigreeIds ( bool  )
virtual

Add pedigree ids to vertex and edge data.

virtual bool vtkPBGLRandomGraphSource::GetGeneratePedigreeIds ( )
virtual

Add pedigree ids to vertex and edge data.

virtual void vtkPBGLRandomGraphSource::GeneratePedigreeIdsOn ( )
virtual

Add pedigree ids to vertex and edge data.

virtual void vtkPBGLRandomGraphSource::GeneratePedigreeIdsOff ( )
virtual

Add pedigree ids to vertex and edge data.

virtual void vtkPBGLRandomGraphSource::SetVertexPedigreeIdArrayName ( const char *  )
virtual

The name of the vertex pedigree id array. Default "vertex id". Vertex pedigree ids will be labeled from 0 to n-1 globally.

virtual char* vtkPBGLRandomGraphSource::GetVertexPedigreeIdArrayName ( )
virtual

The name of the vertex pedigree id array. Default "vertex id". Vertex pedigree ids will be labeled from 0 to n-1 globally.

virtual void vtkPBGLRandomGraphSource::SetEdgePedigreeIdArrayName ( const char *  )
virtual

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

virtual char* vtkPBGLRandomGraphSource::GetEdgePedigreeIdArrayName ( )
virtual

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

virtual void vtkPBGLRandomGraphSource::SetSeed ( int  )
virtual

Control the seed used for pseudo-random-number generation. This ensures that vtkPBGLRandomGraphSource can produce repeatable results. The seed values provided for each process should be different,

virtual int vtkPBGLRandomGraphSource::GetSeed ( )
virtual

Control the seed used for pseudo-random-number generation. This ensures that vtkPBGLRandomGraphSource can produce repeatable results. The seed values provided for each process should be different,

virtual int vtkPBGLRandomGraphSource::RequestData ( vtkInformation *  ,
vtkInformationVector **  ,
vtkInformationVector *   
)
protectedvirtual
virtual int vtkPBGLRandomGraphSource::RequestDataObject ( vtkInformation *  ,
vtkInformationVector **  inputVector,
vtkInformationVector *  outputVector 
)
protectedvirtual

Creates directed or undirected output based on Directed flag.

Member Data Documentation

vtkIdType vtkPBGLRandomGraphSource::NumberOfVertices
protected

Definition at line 168 of file vtkPBGLRandomGraphSource.h.

vtkIdType vtkPBGLRandomGraphSource::NumberOfEdges
protected

Definition at line 169 of file vtkPBGLRandomGraphSource.h.

double vtkPBGLRandomGraphSource::EdgeProbability
protected

Definition at line 170 of file vtkPBGLRandomGraphSource.h.

bool vtkPBGLRandomGraphSource::Directed
protected

Definition at line 171 of file vtkPBGLRandomGraphSource.h.

bool vtkPBGLRandomGraphSource::UseEdgeProbability
protected

Definition at line 172 of file vtkPBGLRandomGraphSource.h.

bool vtkPBGLRandomGraphSource::StartWithTree
protected

Definition at line 173 of file vtkPBGLRandomGraphSource.h.

bool vtkPBGLRandomGraphSource::IncludeEdgeWeights
protected

Definition at line 174 of file vtkPBGLRandomGraphSource.h.

bool vtkPBGLRandomGraphSource::AllowSelfLoops
protected

Definition at line 175 of file vtkPBGLRandomGraphSource.h.

bool vtkPBGLRandomGraphSource::AllowBalancedEdgeDistribution
protected

Definition at line 176 of file vtkPBGLRandomGraphSource.h.

bool vtkPBGLRandomGraphSource::GeneratePedigreeIds
protected

Definition at line 177 of file vtkPBGLRandomGraphSource.h.

int vtkPBGLRandomGraphSource::Seed
protected

Definition at line 178 of file vtkPBGLRandomGraphSource.h.

char* vtkPBGLRandomGraphSource::EdgeWeightArrayName
protected

Definition at line 179 of file vtkPBGLRandomGraphSource.h.

char* vtkPBGLRandomGraphSource::VertexPedigreeIdArrayName
protected

Definition at line 180 of file vtkPBGLRandomGraphSource.h.

char* vtkPBGLRandomGraphSource::EdgePedigreeIdArrayName
protected

Definition at line 181 of file vtkPBGLRandomGraphSource.h.


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