Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: downloads/boost_1_33_1/libs/property_map/identity_property_map.html @ 13

Last change on this file since 13 was 12, checked in by landauf, 18 years ago

added boost
File size: 2.9 KB
Line 
1<HTML>
2<!--
3  -- Copyright (c) Jeremy Siek, Lie-Quan Lee, and Andrew Lumsdaine 2000
4  --
5  -- Permission to use, copy, modify, distribute and sell this software
6  -- and its documentation for any purpose is hereby granted without fee,
7  -- provided that the above copyright notice appears in all copies and
8  -- that both that copyright notice and this permission notice appear
9  -- in supporting documentation.  We make no
10  -- representations about the suitability of this software for any
11  -- purpose.  It is provided "as is" without express or implied warranty.
12  -->
13<Head>
14<Title>Identity Property Map</Title>
15<BODY BGCOLOR="#ffffff" LINK="#0000ee" TEXT="#000000" VLINK="#551a8b" 
16        ALINK="#ff0000"> 
17<IMG SRC="../../boost.png" 
18     ALT="C++ Boost" width="277" height="86"> 
19
20<BR Clear>
21
22<H2><A NAME="sec:identity-property-map"></A>
23</h2>
24<PRE>
25identity_property_map
26</PRE>
27
28This property map applies the identity function, that is, it just
29returns a copy of the key object that was input.
30
31<H3>Where Defined</H3>
32
33<P>
34<a href="../../boost/property_map.hpp"><TT>boost/property_map.hpp</TT></a>
35
36<h3>Model of</h3>
37
38<a href="./ReadablePropertyMap.html">Readable Property Map</a>
39
40<h3>Associated Types</h3>
41
42<table border>
43<tr>
44<th>Type</th><th>Description</th>
45</tr>
46
47<tr>
48<td><tt>
49boost::property_traits&lt;identity_property_map&gt;::value_type
50</tt></td>
51<td>
52This type is <tt>void</tt>; the map functions are templated.
53</td>
54</tr>
55
56<tr>
57<td><tt>
58boost::property_traits&lt;identity_property_map&gt;::key_type
59</tt></td>
60<td>
61This type is <tt>void</tt>; the map functions are templated.
62</td>
63</tr>
64
65<tr>
66<td><tt>
67boost::property_traits&lt;identity_property_map&gt;::category
68</tt></td>
69<td>
70This type is <tt>boost::readable_op_bracket_tag</tt>.
71</td>
72</tr>
73
74</table>
75
76<h3>Member Functions</h3>
77
78<table border>
79<tr>
80<th>Member</th><th>Description</th>
81</tr>
82
83
84<tr>
85<td><tt>
86identity_property_map()
87</tt></td>
88<td>
89Default constructor.
90</td>
91</tr>
92
93<tr>
94<td><tt>
95identity_property_map(const identity_property_map&amp; x)
96</tt></td>
97<td>
98Copy constructor.
99</td>
100</tr>
101
102<tr>
103<td><tt>
104template &lt;class T&gt;<br>
105T operator[](T x) const
106</tt></td>
107<td>
108Returns a copy of object <tt>x</tt>.
109</td>
110</tr>
111
112</table>
113
114<h3>Non-Member Functions</h3>
115
116<table border>
117<tr>
118<th>Member</th><th>Description</th>
119</tr>
120
121<tr>
122<td><tt>
123template &lt;class T&gt;<br>
124T get(const identity_property_map& pmap, T x)
125</tt></td>
126<td>
127Returns a copy of object <tt>x</tt>.
128</td>
129</tr>
130
131</table>
132
133
134<br>
135<HR>
136<TABLE>
137<TR valign=top>
138<TD nowrap>Copyright &copy 2000</TD><TD>
139<a HREF="../../people/jeremy_siek.htm">Jeremy Siek</a>,
140Univ.of Notre Dame (<A
141HREF="mailto:jsiek@lsc.nd.edu">jsiek@lsc.nd.edu</A>)<br>
142<A HREF=http://www.boost.org/people/liequan_lee.htm>Lie-Quan Lee</A>, Univ.of Notre Dame (<A HREF="mailto:llee1@lsc.nd.edu">llee1@lsc.nd.edu</A>)<br>
143<A HREF=http://www.lsc.nd.edu/~lums>Andrew Lumsdaine</A>,
144Univ.of Notre Dame (<A
145HREF="mailto:lums@lsc.nd.edu">lums@lsc.nd.edu</A>)
146</TD></TR></TABLE>
147
148</BODY>
149</HTML> 
Note: See TracBrowser for help on using the repository browser.