123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164 |
- <HTML>
- <!--
- Copyright (c) Jeremy Siek, Lie-Quan Lee, and Andrew Lumsdaine 2000, Alex Hagen-Zanker (2012)
-
- 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>
- boost::typed_identity_property_map<T>
- typedef boost::typed_identity_propoperty_map<std::size_t> boost::identity_property_map
- </PRE>
- <p>The <code>typed_identity_property_map</code> property map applies the identity function, that is, it just returns a copy of the key object that was input. The key and value types are both the same as the template parameter <code>T</code>. The <code>identity_property_map</code> name is for the common case where the key and value type are <code>std::size_t</code> (this name is deprecated for use within Boost.Graph). </p>
- <p><em>Note:</em> Previously the function <code>get()</code> and <code>operator[]</code> for <code>identity_property_map</code> were overloaded to return a copy of keys of any type, i.e., not just <code>size_t</code>. These overloads are now deprecated, because they did not adhere to the property map concepts.</p>
- <H3>Where Defined</H3>
- <P>
- <a href="../../../boost/property_map/property_map.hpp"><TT>boost/property_map/property_map.hpp</TT></a>
- </P>
-
- <h3>Model of</h3>
- <a href="./ReadablePropertyMap.html">Readable Property Map</a>
- <h3>Template Parameters</h3>
- <TABLE border>
- <TR>
- <th>Parameter</th>
- <th>Description</th>
- <th>Default</th>
- </tr>
- <TR>
- <TD><TT>T</TT></TD>
- <TD>Must be Copy Contructible</TD>
- <TD> </td>
- </tr>
- </TABLE>
- <h3>Associated Types</h3>
- <table border>
- <tr>
- <th>Type</th><th>Description</th>
- </tr>
- <tr>
- <td><tt>
- boost::property_traits<typed_identity_property_map<T> >::value_type
- </tt></td>
- <td>
- This type is <tt>T</tt>. </td>
- </tr>
- <tr>
- <td><tt>
- boost::property_traits<typed_identity_property_map<T> >::key_type
- </tt></td>
- <td>
- This type is <tt>T</tt>.</td>
- </tr>
- <tr>
- <td><tt>
- boost::property_traits<typed_identity_property_map<T> >::reference
- </tt></td>
- <td>
- This type is <tt>T</tt>..</td>
- </tr>
- <tr>
- <td><tt>
- boost::property_traits<typed_identity_property_map<T> >::category
- </tt></td>
- <td>
- This type is <tt>boost::readable_property_map_tag</tt>.
- </td>
- </tr>
- </table>
- <h3>Member Functions</h3>
- <table border>
- <tr>
- <th>Member</th><th>Description</th>
- </tr>
- <tr>
- <td><tt>
- typed_identity_property_map()
- </tt></td>
- <td>
- Default constructor.
- </td>
- </tr>
- <tr>
- <td><tt>
- typed_identity_property_map(const typed_identity_property_map<T>& x)
- </tt></td>
- <td>
- Copy constructor.
- </td>
- </tr>
- <tr>
- <td><tt>
- T operator[](const 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> T get(const typed_identity_property_map<T>& pmap, const 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 © 2000-2012</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>)<br>
- Alex Hagen-Zanker</TD></TR></TABLE>
- </BODY>
- </HTML>
|