ColorValue.html 2.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108
  1. <HTML>
  2. <!--
  3. Copyright (c) Jeremy Siek, Lie-Quan Lee, and Andrew Lumsdaine 2000
  4. Distributed under the Boost Software License, Version 1.0.
  5. (See accompanying file LICENSE_1_0.txt or copy at
  6. http://www.boost.org/LICENSE_1_0.txt)
  7. -->
  8. <Head>
  9. <Title>Boost Graph Library: ColorValue Concept</Title>
  10. <BODY BGCOLOR="#ffffff" LINK="#0000ee" TEXT="#000000" VLINK="#551a8b"
  11. ALINK="#ff0000">
  12. <IMG SRC="../../../boost.png"
  13. ALT="C++ Boost" width="277" height="86">
  14. <BR Clear>
  15. <H1><A NAME="concept:ColorValue"></A>
  16. ColorValue
  17. </H1>
  18. <P>
  19. This concept describes the requirements for the type used for color
  20. values, as in for coloring a graph during a breath-first search to
  21. mark which vertices have been visited.
  22. <P>
  23. <h3>Refinement of</h3> <a
  24. href="http://www.boost.org/sgi/stl/EqualityComparable.html">EqualityComparable</a>
  25. and <a
  26. href="http://www.boost.org/sgi/stl/DefaultConstructible.html">DefaultConstructible</a>
  27. <h3>Notation</h3>
  28. <Table>
  29. <TR>
  30. <TD><tt>T</tt></TD>
  31. <TD>A type that is a model of ColorValue.</TD>
  32. </TR>
  33. <TR>
  34. <TD><tt>cv</tt></TD>
  35. <TD>An object of type <tt>T</tt>.</TD>
  36. </TR>
  37. </table>
  38. <h3>Valid Expressions</h3>
  39. <Table border>
  40. <tr>
  41. <th>Name</th><th>Expression</th><th>Return Type</th><th>Description</th>
  42. </tr>
  43. <tr>
  44. <td>Get Color White </td>
  45. <TD><TT>color_traits&lt;T&gt;::white()</TT></TD>
  46. <TD><TT>T</TT></TD>
  47. <TD>Returns an object that represents the color white.</TD>
  48. </TR>
  49. <tr>
  50. <td>Get Color Gray </td>
  51. <TD><TT>color_traits&lt;T&gt;::gray()</TT></TD>
  52. <TD><TT>T</TT></TD>
  53. <TD>Returns an object that represents the color gray.</TD>
  54. </TR>
  55. <tr>
  56. <td>Get Color Black </td>
  57. <TD><TT>color_traits&lt;T&gt;::black()</TT></TD>
  58. <TD><TT>T</TT></TD>
  59. <TD>Returns an object that represents the color black.</TD>
  60. </TR>
  61. </TABLE>
  62. <P>
  63. </LI>
  64. </UL>
  65. <h3>Models</h3>
  66. <ul>
  67. <li><tt>default_color_type</tt> (in <a href="../../../boost/graph/properties.hpp"><tt>boost/graph/properties.hpp</tt>)
  68. </ul>
  69. <br>
  70. <HR>
  71. <TABLE>
  72. <TR valign=top>
  73. <TD nowrap>Copyright &copy; 2000-2001</TD><TD>
  74. <A HREF="http://www.boost.org/people/jeremy_siek.htm">Jeremy Siek</A>,
  75. Indiana University (<A
  76. HREF="mailto:jsiek@osl.iu.edu">jsiek@osl.iu.edu</A>)<br>
  77. <A HREF="http://www.boost.org/people/liequan_lee.htm">Lie-Quan Lee</A>, Indiana University (<A HREF="mailto:llee@cs.indiana.edu">llee@cs.indiana.edu</A>)<br>
  78. <A HREF="https://homes.cs.washington.edu/~al75">Andrew Lumsdaine</A>,
  79. Indiana University (<A
  80. HREF="mailto:lums@osl.iu.edu">lums@osl.iu.edu</A>)
  81. </TD></TR></TABLE>
  82. </BODY>
  83. </HTML>