Find file
Fetching contributors…
Cannot retrieve contributors at this time
108 lines (89 sloc) 3.85 KB
/*=========================================================================
Program: Visualization Toolkit
Module: vtkUndirectedGraph.h
Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
All rights reserved.
See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notice for more information.
=========================================================================*/
/*-------------------------------------------------------------------------
Copyright 2008 Sandia Corporation.
Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
the U.S. Government retains certain rights in this software.
-------------------------------------------------------------------------*/
// .NAME vtkUndirectedGraph - An undirected graph.
//
// .SECTION Description
// vtkUndirectedGraph is a collection of vertices along with a collection of
// undirected edges (they connect two vertices in no particular order).
// ShallowCopy(), DeepCopy(), CheckedShallowCopy(), CheckedDeepCopy()
// accept instances of vtkUndirectedGraph and vtkMutableUndirectedGraph.
// GetOutEdges(v, it) and GetInEdges(v, it) return the same list of edges,
// which is the list of all edges which have a v as an endpoint.
// GetInDegree(v), GetOutDegree(v) and GetDegree(v) all return the full
// degree of vertex v.
//
// vtkUndirectedGraph is read-only. To create an undirected graph,
// use an instance of vtkMutableUndirectedGraph, then you may set the
// structure to a vtkUndirectedGraph using ShallowCopy().
//
// .SECTION See Also
// vtkGraph vtkMutableUndirectedGraph
#ifndef __vtkUndirectedGraph_h
#define __vtkUndirectedGraph_h
#include "vtkGraph.h"
class VTK_FILTERING_EXPORT vtkUndirectedGraph : public vtkGraph
{
public:
static vtkUndirectedGraph *New();
vtkTypeMacro(vtkUndirectedGraph, vtkGraph);
void PrintSelf(ostream& os, vtkIndent indent);
// Description:
// Return what type of dataset this is.
virtual int GetDataObjectType() {return VTK_UNDIRECTED_GRAPH;}
// Description:
// Returns the full degree of the vertex.
virtual vtkIdType GetInDegree(vtkIdType v);
//BTX
// Description:
// Random-access method for retrieving the in edges of a vertex.
// For an undirected graph, this is the same as the out edges.
virtual vtkInEdgeType GetInEdge(vtkIdType v, vtkIdType i);
//ETX
// Description:
// Random-access method for retrieving incoming edges to vertex v.
// The method fills the vtkGraphEdge instance with the id, source, and
// target of the edge. This method is provided for wrappers,
// GetInEdge(vtkIdType, vtkIdType) is preferred.
virtual void GetInEdge(vtkIdType v, vtkIdType i, vtkGraphEdge* e)
{ this->Superclass::GetInEdge(v, i, e); }
//BTX
// Description:
// Retrieve a graph from an information vector.
static vtkUndirectedGraph *GetData(vtkInformation *info);
static vtkUndirectedGraph *GetData(vtkInformationVector *v, int i=0);
//ETX
// Description:
// Initialize the iterator to get the incoming edges to a vertex.
// For an undirected graph, this is all incident edges.
virtual void GetInEdges(vtkIdType v, vtkInEdgeIterator *it)
{ Superclass::GetInEdges(v, it); }
protected:
vtkUndirectedGraph();
~vtkUndirectedGraph();
// Description:
// Check the structure, and accept it if it is a valid
// undirected graph.
virtual bool IsStructureValid(vtkGraph *g);
//BTX
// Description:
// For iterators, returns the same edge list as GetOutEdges().
virtual void GetInEdges(vtkIdType v, const vtkInEdgeType *& edges, vtkIdType & nedges);
//ETX
private:
vtkUndirectedGraph(const vtkUndirectedGraph&); // Not implemented.
void operator=(const vtkUndirectedGraph&); // Not implemented.
};
#endif