<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> <title>VTK: vtkPBGLVertexColoring Class Reference</title> <link href="doxygen.css" rel="stylesheet" type="text/css"> <link href="tabs.css" rel="stylesheet" type="text/css"> </head><body> <!-- Generated by Doxygen 1.5.6 --> <div class="navigation" id="top"> <div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li class="current"><a href="classes.html"><span>Classes</span></a></li> <li><a href="files.html"><span>Files</span></a></li> </ul> </div> <div class="tabs"> <ul> <li><a href="classes.html"><span>Alphabetical List</span></a></li> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> </div> <div class="contents"> <h1>vtkPBGLVertexColoring Class Reference</h1><!-- doxytag: class="vtkPBGLVertexColoring" --><!-- doxytag: inherits="vtkGraphAlgorithm" --><code>#include <<a class="el" href="a05109.html">vtkPBGLVertexColoring.h</a>></code> <p> <div class="dynheader"> Inheritance diagram for vtkPBGLVertexColoring:</div> <div class="dynsection"> <p><center><img src="a12890.png" border="0" usemap="#a12891" alt="Inheritance graph"></center> <map name="a12891"> <area shape="rect" href="a00656.html" title="Superclass for algorithms that produce only graph as output." alt="" coords="20,229,156,256"><area shape="rect" href="a00101.html" title="Superclass for all sources, filters, and sinks in VTK." alt="" coords="39,155,137,181"><area shape="rect" href="a01084.html" title="abstract base class for most VTK objects" alt="" coords="48,80,128,107"><area shape="rect" href="a01085.html" title="abstract base class for most VTK objects" alt="" coords="33,5,143,32"></map> <center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div> <div class="dynheader"> Collaboration diagram for vtkPBGLVertexColoring:</div> <div class="dynsection"> <p><center><img src="a12892.png" border="0" usemap="#a12893" alt="Collaboration graph"></center> <map name="a12893"> <area shape="rect" href="a00656.html" title="Superclass for algorithms that produce only graph as output." alt="" coords="183,499,319,525"><area shape="rect" href="a00101.html" title="Superclass for all sources, filters, and sinks in VTK." alt="" coords="281,381,380,408"><area shape="rect" href="a00472.html" title="Superclass for all pipeline executives in VTK." alt="" coords="477,499,576,525"><area shape="rect" href="a01084.html" title="abstract base class for most VTK objects" alt="" coords="407,173,487,200"><area shape="rect" href="a00895.html" title="Store zero or more vtkInformation instances." alt="" coords="404,264,553,291"><area shape="rect" href="a00872.html" title="Store vtkAlgorithm input/output information." alt="" coords="212,264,321,291"><area shape="rect" href="a01085.html" title="abstract base class for most VTK objects" alt="" coords="164,5,273,32"><area shape="rect" href="a00884.html" title="internal structure for vtkInformation" alt="" coords="5,173,168,200"><area shape="rect" href="a00886.html" title="Superclass for vtkInformation keys." alt="" coords="153,83,284,109"><area shape="rect" href="a01719.html" title="record modification and/or execution time" alt="" coords="308,83,417,109"><area shape="rect" href="a00891.html" title="Key for pointer to pointer." alt="" coords="192,173,373,200"></map> <center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div> <p> <a href="a12894.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2> Compute a vertex coloring for a distributed, undirected <a class="el" href="a00654.html" title="Base class for graph data types.">vtkGraph</a>, where each vertex has a color distinct from the colors of its adjacent vertices. <p> This VTK class uses the Parallel BGL's implementation of Boman et al's parallel vertex coloring algorithm.<p> <dl class="user" compact><dt><b>Tests:</b></dt><dd><a class="el" href="c2_vtk_t_12.html#c2_vtk_t_vtkPBGLVertexColoring">vtkPBGLVertexColoring (Tests)</a> </dd></dl> <p>Definition at line <a class="el" href="a05109.html#l00043">43</a> of file <a class="el" href="a05109.html">vtkPBGLVertexColoring.h</a>.</p> <table border="0" cellpadding="0" cellspacing="0"> <tr><td></td></tr> <tr><td colspan="2"><br><h2>Public Types</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <a class="el" href="a00656.html">vtkGraphAlgorithm</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a01195.html#923be1a4fd9d998707e09234b39cf9e6">Superclass</a></td></tr> <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="a01195.html#cad659237afe4b9b91c1abc8f02c2fba">GetClassName</a> ()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="a01195.html#a46c21bb5531cb1d6205ea98190b8afd">IsA</a> (const char *type)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a01195.html#c7920d4322c9a9707bf6f3e508c3b0a0">PrintSelf</a> (ostream &os, <a class="el" href="a00869.html">vtkIndent</a> indent)</td></tr> <tr><td colspan="2"><div class="groupHeader"></div></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a01195.html#4b2813b845d41a237c2498a57aa17dbc">SetBlockSize</a> (<a class="el" href="a02149.html#20bd6b6dedfe1bbb096c50354d52cc7e">vtkIdType</a>)</td></tr> <tr><td colspan="2"><div class="groupHeader"></div></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="a02149.html#20bd6b6dedfe1bbb096c50354d52cc7e">vtkIdType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a01195.html#28d9bea99fbffa1098f8cb1a65e7f367">GetBlockSize</a> ()</td></tr> <tr><td colspan="2"><div class="groupHeader"></div></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a01195.html#f184d7bca9bf5f22d416cb6f5bc0d2fa">SetColorArrayName</a> (const char *)</td></tr> <tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="a01195.html">vtkPBGLVertexColoring</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a01195.html#ced5ed51ca86262f7a980dc31cae97dd">New</a> ()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">static int </td><td class="memItemRight" valign="bottom"><a class="el" href="a01195.html#edeb161a2d60ff508b9ee1aa6c9c6a8e">IsTypeOf</a> (const char *type)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="a01195.html">vtkPBGLVertexColoring</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a01195.html#6736427069c5606209adb12d080c96a6">SafeDownCast</a> (<a class="el" href="a01084.html">vtkObject</a> *o)</td></tr> <tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a01195.html#b3ba04b08e05e1cbfed64eb44be640f1">vtkPBGLVertexColoring</a> ()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a01195.html#11dd3d93df3e97ffccc384cea14884e7">~vtkPBGLVertexColoring</a> ()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="a01195.html#b3d29c9b4bde8e37188d91e046bf85b6">RequestData</a> (<a class="el" href="a00872.html">vtkInformation</a> *, <a class="el" href="a00895.html">vtkInformationVector</a> **, <a class="el" href="a00895.html">vtkInformationVector</a> *)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="a01195.html#3a7bb7fe913e3f0131afac675c0df4cc">FillInputPortInformation</a> (int port, <a class="el" href="a00872.html">vtkInformation</a> *info)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="a01195.html#3d7722a447ee6ac44bfbe3d986a62d6b">FillOutputPortInformation</a> (int port, <a class="el" href="a00872.html">vtkInformation</a> *info)</td></tr> </table> <hr><h2>Member Typedef Documentation</h2> <a class="anchor" name="923be1a4fd9d998707e09234b39cf9e6"></a><!-- doxytag: member="vtkPBGLVertexColoring::Superclass" ref="923be1a4fd9d998707e09234b39cf9e6" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">typedef <a class="el" href="a00656.html">vtkGraphAlgorithm</a> <a class="el" href="a00656.html">vtkPBGLVertexColoring::Superclass</a> </td> </tr> </table> </div> <div class="memdoc"> <p> <p>Reimplemented from <a class="el" href="a00656.html#65ff0af97f9d847799accd57f8814926">vtkGraphAlgorithm</a>.</p> <p>Definition at line <a class="el" href="a05109.html#l00047">47</a> of file <a class="el" href="a05109.html">vtkPBGLVertexColoring.h</a>.</p> </div> </div><p> <hr><h2>Constructor & Destructor Documentation</h2> <a class="anchor" name="b3ba04b08e05e1cbfed64eb44be640f1"></a><!-- doxytag: member="vtkPBGLVertexColoring::vtkPBGLVertexColoring" ref="b3ba04b08e05e1cbfed64eb44be640f1" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">vtkPBGLVertexColoring::vtkPBGLVertexColoring </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td><code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> <p> </div> </div><p> <a class="anchor" name="11dd3d93df3e97ffccc384cea14884e7"></a><!-- doxytag: member="vtkPBGLVertexColoring::~vtkPBGLVertexColoring" ref="11dd3d93df3e97ffccc384cea14884e7" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">vtkPBGLVertexColoring::~vtkPBGLVertexColoring </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td><code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> <p> </div> </div><p> <hr><h2>Member Function Documentation</h2> <a class="anchor" name="ced5ed51ca86262f7a980dc31cae97dd"></a><!-- doxytag: member="vtkPBGLVertexColoring::New" ref="ced5ed51ca86262f7a980dc31cae97dd" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static <a class="el" href="a01195.html">vtkPBGLVertexColoring</a>* vtkPBGLVertexColoring::New </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td><code> [static]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Create an object with Debug turned off, modified time initialized to zero, and reference counting on. <p>Reimplemented from <a class="el" href="a00656.html#1cff1f253656090acf628631b4e0b36e">vtkGraphAlgorithm</a>.</p> </div> </div><p> <a class="anchor" name="cad659237afe4b9b91c1abc8f02c2fba"></a><!-- doxytag: member="vtkPBGLVertexColoring::GetClassName" ref="cad659237afe4b9b91c1abc8f02c2fba" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual const char* vtkPBGLVertexColoring::GetClassName </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> <p>Reimplemented from <a class="el" href="a00656.html#19fd761c1a7702d463ecd187d224ddef">vtkGraphAlgorithm</a>.</p> </div> </div><p> <a class="anchor" name="edeb161a2d60ff508b9ee1aa6c9c6a8e"></a><!-- doxytag: member="vtkPBGLVertexColoring::IsTypeOf" ref="edeb161a2d60ff508b9ee1aa6c9c6a8e" args="(const char *type)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static int vtkPBGLVertexColoring::IsTypeOf </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"> <em>name</em> </td> <td> ) </td> <td><code> [static]</code></td> </tr> </table> </div> <div class="memdoc"> <p> 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 vtkTypeRevisionMacro found in vtkSetGet.h. <p>Reimplemented from <a class="el" href="a00656.html#82cb3fc0686797578cce635b27df2b2e">vtkGraphAlgorithm</a>.</p> </div> </div><p> <a class="anchor" name="a46c21bb5531cb1d6205ea98190b8afd"></a><!-- doxytag: member="vtkPBGLVertexColoring::IsA" ref="a46c21bb5531cb1d6205ea98190b8afd" args="(const char *type)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual int vtkPBGLVertexColoring::IsA </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"> <em>name</em> </td> <td> ) </td> <td><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> 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 vtkTypeRevisionMacro found in vtkSetGet.h. <p>Reimplemented from <a class="el" href="a00656.html#d7389dfdd1ab2579c3109c589b6a2a5d">vtkGraphAlgorithm</a>.</p> </div> </div><p> <a class="anchor" name="6736427069c5606209adb12d080c96a6"></a><!-- doxytag: member="vtkPBGLVertexColoring::SafeDownCast" ref="6736427069c5606209adb12d080c96a6" args="(vtkObject *o)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static <a class="el" href="a01195.html">vtkPBGLVertexColoring</a>* vtkPBGLVertexColoring::SafeDownCast </td> <td>(</td> <td class="paramtype"><a class="el" href="a01084.html">vtkObject</a> * </td> <td class="paramname"> <em>o</em> </td> <td> ) </td> <td><code> [static]</code></td> </tr> </table> </div> <div class="memdoc"> <p> <p>Reimplemented from <a class="el" href="a00656.html#f837b1caa1cdbb31f677e59af1a8895c">vtkGraphAlgorithm</a>.</p> </div> </div><p> <a class="anchor" name="c7920d4322c9a9707bf6f3e508c3b0a0"></a><!-- doxytag: member="vtkPBGLVertexColoring::PrintSelf" ref="c7920d4322c9a9707bf6f3e508c3b0a0" args="(ostream &os, vtkIndent indent)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void vtkPBGLVertexColoring::PrintSelf </td> <td>(</td> <td class="paramtype">ostream & </td> <td class="paramname"> <em>os</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="a00869.html">vtkIndent</a> </td> <td class="paramname"> <em>indent</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use <a class="el" href="a01085.html#edadf6378465fd81c2592ef64262e2a5">Print()</a> instead) but used in the hierarchical print process to combine the output of several classes. <p>Reimplemented from <a class="el" href="a00656.html#f107f75f6b708a81fe0bf11114824a71">vtkGraphAlgorithm</a>.</p> </div> </div><p> <a class="anchor" name="4b2813b845d41a237c2498a57aa17dbc"></a><!-- doxytag: member="vtkPBGLVertexColoring::SetBlockSize" ref="4b2813b845d41a237c2498a57aa17dbc" args="(vtkIdType)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual void vtkPBGLVertexColoring::SetBlockSize </td> <td>(</td> <td class="paramtype"><a class="el" href="a02149.html#20bd6b6dedfe1bbb096c50354d52cc7e">vtkIdType</a> </td> <td class="paramname"> </td> <td> ) </td> <td><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Sets the block size of the algorithm, which is the number of vertices whose colors will be assigned before the processes resynchronize. </div> </div><p> <a class="anchor" name="28d9bea99fbffa1098f8cb1a65e7f367"></a><!-- doxytag: member="vtkPBGLVertexColoring::GetBlockSize" ref="28d9bea99fbffa1098f8cb1a65e7f367" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual <a class="el" href="a02149.html#20bd6b6dedfe1bbb096c50354d52cc7e">vtkIdType</a> vtkPBGLVertexColoring::GetBlockSize </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Retrieve the block size of the algorithm. </div> </div><p> <a class="anchor" name="f184d7bca9bf5f22d416cb6f5bc0d2fa"></a><!-- doxytag: member="vtkPBGLVertexColoring::SetColorArrayName" ref="f184d7bca9bf5f22d416cb6f5bc0d2fa" args="(const char *)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual void vtkPBGLVertexColoring::SetColorArrayName </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"> </td> <td> ) </td> <td><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Set the name of the vertex color output array, which contains the color of each vertex (a non-negative value). If no color array name is set then the name 'Color' is used. </div> </div><p> <a class="anchor" name="b3d29c9b4bde8e37188d91e046bf85b6"></a><!-- doxytag: member="vtkPBGLVertexColoring::RequestData" ref="b3d29c9b4bde8e37188d91e046bf85b6" args="(vtkInformation *, vtkInformationVector **, vtkInformationVector *)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual int vtkPBGLVertexColoring::RequestData </td> <td>(</td> <td class="paramtype"><a class="el" href="a00872.html">vtkInformation</a> * </td> <td class="paramname"> <em>request</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="a00895.html">vtkInformationVector</a> ** </td> <td class="paramname"> <em>inputVector</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="a00895.html">vtkInformationVector</a> * </td> <td class="paramname"> <em>outputVector</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td><code> [protected, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> This is called by the superclass. This is the method you should override. <p>Reimplemented from <a class="el" href="a00656.html#adc44af7541c6076e3953a94e9477abf">vtkGraphAlgorithm</a>.</p> </div> </div><p> <a class="anchor" name="3a7bb7fe913e3f0131afac675c0df4cc"></a><!-- doxytag: member="vtkPBGLVertexColoring::FillInputPortInformation" ref="3a7bb7fe913e3f0131afac675c0df4cc" args="(int port, vtkInformation *info)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual int vtkPBGLVertexColoring::FillInputPortInformation </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"> <em>port</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="a00872.html">vtkInformation</a> * </td> <td class="paramname"> <em>info</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td><code> [protected, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Fill the input port information objects for this algorithm. This is invoked by the first call to GetInputPortInformation for each port so subclasses can specify what they can handle. <p>Reimplemented from <a class="el" href="a00656.html#2119e6b6b3b5be8c1389da0e84b2c235">vtkGraphAlgorithm</a>.</p> </div> </div><p> <a class="anchor" name="3d7722a447ee6ac44bfbe3d986a62d6b"></a><!-- doxytag: member="vtkPBGLVertexColoring::FillOutputPortInformation" ref="3d7722a447ee6ac44bfbe3d986a62d6b" args="(int port, vtkInformation *info)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual int vtkPBGLVertexColoring::FillOutputPortInformation </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"> <em>port</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="a00872.html">vtkInformation</a> * </td> <td class="paramname"> <em>info</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td><code> [protected, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Fill the output port information objects for this algorithm. This is invoked by the first call to GetOutputPortInformation for each port so subclasses can specify what they can handle. <p>Reimplemented from <a class="el" href="a00656.html#3b5a83dfee2bbd4484e7902a77397746">vtkGraphAlgorithm</a>.</p> </div> </div><p> <hr>The documentation for this class was generated from the following file:<ul> <li>dox/Parallel/<a class="el" href="a05109.html">vtkPBGLVertexColoring.h</a></ul> </div> <hr size="1"><address style="text-align: right;"><small>Generated on Wed Jun 3 19:23:13 2009 for VTK by <a href="http://www.doxygen.org/index.html"> <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address> </body> </html>