summaryrefslogtreecommitdiff
path: root/libs/property_map/doc/identity_property_map.html
blob: 3a82ca2c8dd84a81ac5feefc1aa65ab522211b31 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
<HTML>
<!--
     Copyright (c) Jeremy Siek, Lie-Quan Lee, and Andrew Lumsdaine 2000
    
     Distributed under the Boost Software License, Version 1.0.
     (See accompanying file LICENSE_1_0.txt or copy at
     http://www.boost.org/LICENSE_1_0.txt)
  -->
<Head>
<Title>Identity Property Map</Title>
<BODY BGCOLOR="#ffffff" LINK="#0000ee" TEXT="#000000" VLINK="#551a8b" 
	ALINK="#ff0000"> 
<IMG SRC="../../../boost.png" 
     ALT="C++ Boost" width="277" height="86"> 

<BR Clear>

<H2><A NAME="sec:identity-property-map"></A>
</h2>
<PRE>
identity_property_map
</PRE>

This property map applies the identity function, that is, it just
returns a copy of the key object that was input.

<H3>Where Defined</H3>

<P>
<a href="../../../boost/property_map/property_map.hpp"><TT>boost/property_map/property_map.hpp</TT></a>

<h3>Model of</h3>

<a href="./ReadablePropertyMap.html">Readable Property Map</a>

<h3>Associated Types</h3>

<table border>
<tr>
<th>Type</th><th>Description</th>
</tr>

<tr>
<td><tt>
boost::property_traits&lt;identity_property_map&gt;::value_type
</tt></td>
<td>
This type is <tt>std::size_t</tt>; the map functions are templated.
</td>
</tr>

<tr>
<td><tt>
boost::property_traits&lt;identity_property_map&gt;::key_type
</tt></td>
<td>
This type is <tt>std::size_t</tt>; the map functions are templated.
</td>
</tr>

<tr>
<td><tt>
boost::property_traits&lt;identity_property_map&gt;::category
</tt></td>
<td>
This type is <tt>boost::readable_op_bracket_tag</tt>.
</td>
</tr>

</table>

<h3>Member Functions</h3>

<table border>
<tr>
<th>Member</th><th>Description</th>
</tr>


<tr>
<td><tt>
identity_property_map()
</tt></td>
<td>
Default constructor.
</td>
</tr>

<tr>
<td><tt>
identity_property_map(const identity_property_map&amp; x)
</tt></td>
<td>
Copy constructor.
</td>
</tr>

<tr>
<td><tt>
template &lt;class T&gt;<br>
T operator[](T x) const
</tt></td>
<td>
Returns a copy of object <tt>x</tt>.
</td>
</tr>

</table>

<h3>Non-Member Functions</h3>

<table border>
<tr>
<th>Member</th><th>Description</th>
</tr>

<tr>
<td><tt>
template &lt;class T&gt;<br>
T get(const identity_property_map& pmap, T x)
</tt></td>
<td>
Returns a copy of object <tt>x</tt>.
</td>
</tr>

</table>


<br>
<HR>
<TABLE>
<TR valign=top>
<TD nowrap>Copyright &copy 2000</TD><TD>
<a HREF="http://www.boost.org/people/jeremy_siek.htm">Jeremy Siek</a>,
Univ.of Notre Dame (<A
HREF="mailto:jsiek@lsc.nd.edu">jsiek@lsc.nd.edu</A>)<br>
<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>
<A HREF="http://www.lsc.nd.edu/~lums">Andrew Lumsdaine</A>,
Univ.of Notre Dame (<A
HREF="mailto:lums@lsc.nd.edu">lums@lsc.nd.edu</A>)
</TD></TR></TABLE>

</BODY>
</HTML>