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