vtkDistributedGraphHelper.h

Go to the documentation of this file.

/*=========================================================================
 
  Program:   Visualization Toolkit
  Module:    vtkDistributedGraphHelper.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 (C) 2008 The Trustees of Indiana University.
 * Use, modification and distribution is subject to the Boost Software
 * License, Version 1.0. (See http://www.boost.org/LICENSE_1_0.txt)
 */
 
#ifndef vtkDistributedGraphHelper_h
#define vtkDistributedGraphHelper_h
 
#include "vtkCommonDataModelModule.h" // For export macro
#include "vtkObject.h"
 
class vtkDistributedGraphHelperInternals;
struct vtkEdgeType;
class vtkGraph;
class vtkVariant;
class vtkVariantArray;
class vtkInformationIntegerKey;
 
// .NAME vtkVertexPedigreeIdDistributionFunction - The type of a
// function used to determine how to distribute vertex pedigree IDs
// across processors in a vtkGraph. The pedigree ID distribution
// function takes the pedigree ID of the vertex and a user-supplied
// void pointer and returns a hash value V. A vertex with that
// pedigree ID will reside on processor V % P, where P is the number
// of processors. This type is used in conjunction with the
// vtkDistributedGraphHelper class.
typedef vtkIdType (*vtkVertexPedigreeIdDistribution)
          (const vtkVariant& pedigreeId, void* userData);
 
class VTKCOMMONDATAMODEL_EXPORT vtkDistributedGraphHelper : public vtkObject
{
 public:
  vtkTypeMacro(vtkDistributedGraphHelper,vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent);
 
  vtkIdType GetVertexOwner(vtkIdType v) const;
 
  vtkIdType GetVertexIndex(vtkIdType v) const;
 
  vtkIdType GetEdgeOwner(vtkIdType e_id) const;
 
  vtkIdType GetEdgeIndex(vtkIdType e_id) const;
 
  vtkIdType MakeDistributedId(int owner, vtkIdType local);
 
  //BTX
 
  void SetVertexPedigreeIdDistribution(vtkVertexPedigreeIdDistribution Func,
                                       void *userData);
  //ETX
 
  vtkIdType GetVertexOwnerByPedigreeId(const vtkVariant& pedigreeId);
 
  virtual void Synchronize() = 0;
 
  virtual vtkDistributedGraphHelper *Clone() = 0;
 
 
  static vtkInformationIntegerKey * DISTRIBUTEDVERTEXIDS();
  static vtkInformationIntegerKey * DISTRIBUTEDEDGEIDS();
 
 protected:
  vtkDistributedGraphHelper();
  virtual ~vtkDistributedGraphHelper();
 
 
  virtual void AddVertexInternal(vtkVariantArray *propertyArr,
                         vtkIdType *vertex) = 0;
 
  virtual void AddVertexInternal(const vtkVariant& pedigreeId, vtkIdType *vertex) = 0;
 
 
  virtual void AddEdgeInternal(vtkIdType u, vtkIdType v, bool directed,
                               vtkVariantArray *propertyArr,
                               vtkEdgeType *edge) = 0;
 
 
  virtual void AddEdgeInternal(const vtkVariant& uPedigreeId, vtkIdType v,
                               bool directed, vtkVariantArray *propertyArr,
                               vtkEdgeType *edge) = 0;
 
 
  virtual void AddEdgeInternal(vtkIdType u, const vtkVariant& vPedigreeId,
                               bool directed, vtkVariantArray *propertyArr,
                               vtkEdgeType *edge) = 0;
 
 
  virtual void AddEdgeInternal(const vtkVariant& uPedigreeId,
                               const vtkVariant& vPedigreeId,
                               bool directed, vtkVariantArray *propertyArr,
                               vtkEdgeType *edge) = 0;
 
  virtual vtkIdType FindVertex(const vtkVariant& pedigreeId) = 0;
 
 
  virtual void
  FindEdgeSourceAndTarget(vtkIdType id,
                          vtkIdType *source, vtkIdType *target) = 0;
 
  virtual void AttachToGraph(vtkGraph *graph);
 
  vtkGraph *Graph;
 
  //BTX
  vtkVertexPedigreeIdDistribution VertexDistribution;
 
  void *VertexDistributionUserData;
 
  vtkIdType signBitMask;
 
  vtkIdType highBitShiftMask;
 
  int procBits;
 
 
  int indexBits;
  //ETX
 
 private:
  vtkDistributedGraphHelper(const vtkDistributedGraphHelper&); // Not implemented
  void operator=(const vtkDistributedGraphHelper&); // Not implemented
 
  //BTX
  friend class vtkGraph;
  //ETX
};
 
#endif // vtkDistributedGraphHelper_h