projects / ceph.git / blame
| Commit | Line | Data |
|---|---|---|
| 7c673cae FG |
1 | <HTML> |
| 2 | <!-- | |
| 3 | Copyright (c) Trustees of Indiana University 2009 | |
| 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>Shared Array Property Map</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 | <H2><A NAME="sec:shared-array-property-map"></A> | |
| 20 | </h2> | |
| 21 | <PRE> | |
| 22 | shared_array_property_map<ValueType, OffsetMap> | |
| 23 | </PRE> | |
| 24 | ||
| 25 | <P> | |
| 26 | This property map is an adaptor that contains a <a | |
| 27 | href="../../smart_ptr/shared_array.htm">boost::shared_array</a> and uses that | |
| 28 | array to store the property map's data. The resulting property map is a model | |
| 29 | of <a href="./LvaluePropertyMap.html">Lvalue Property Map</a>. | |
| 30 | The <tt>OffsetMap</tt> type is responsible for converting | |
| 31 | key objects to integers that can be used as offsets into the array. | |
| 32 | ||
| 33 | <P> | |
| 34 | ||
| 35 | <H3>Where Defined</H3> | |
| 36 | ||
| 37 | <P> | |
| 38 | <a href="../../../boost/property_map/shared_array_property_map.hpp"><TT>boost/property_map/shared_array_property_map.hpp</TT></a> | |
| 39 | ||
| 40 | <p> | |
| 41 | <H3>Model Of</H3> | |
| 42 | ||
| 43 | <a href="./LvaluePropertyMap.html">Lvalue Property Map</a> | |
| 44 | ||
| 45 | <P> | |
| 46 | ||
| 47 | <H3>Template Parameters</H3> | |
| 48 | ||
| 49 | <P> | |
| 50 | ||
| 51 | <TABLE border> | |
| 52 | <TR> | |
| 53 | <th>Parameter</th><th>Description</th><th>Default</th> | |
| 54 | </tr> | |
| 55 | ||
| 56 | ||
| 57 | <TR> | |
| 58 | <TD><TT>ValueType</TT></TD> | |
| 59 | <TD>The value type of the property map.</TD> | |
| 60 | <TD> </TD> | |
| 61 | </TR> | |
| 62 | ||
| 63 | ||
| 64 | <TR> | |
| 65 | <TD><TT>OffsetMap</TT></TD> <TD>Must be a model of <a | |
| 66 | href="./ReadablePropertyMap.html">Readable Property Map</a> | |
| 67 | and the value type must be convertible to <tt>std::size_t</tt>. | |
| 68 | </TD> <TD> </TD> | |
| 69 | </TR> | |
| 70 | ||
| 71 | </TABLE> | |
| 72 | <P> | |
| 73 | ||
| 74 | <H3>Members</H3> | |
| 75 | ||
| 76 | <P> | |
| 77 | In addition to the methods and functions required by <a | |
| 78 | href="./LvaluePropertyMap.html">Lvalue Property Map</a>, this | |
| 79 | class has the following members. | |
| 80 | ||
| 81 | <hr> | |
| 82 | ||
| 83 | <pre> | |
| 84 | property_traits<shared_array_property_map>::value_type | |
| 85 | </pre> | |
| 86 | This is the same type as | |
| 87 | <TT>ValueType</TT>. | |
| 88 | ||
| 89 | <hr> | |
| 90 | ||
| 91 | <pre> | |
| 92 | shared_array_property_map(size_t n) | |
| 93 | </pre> | |
| 94 | Constructor. Builds the property map with a size of <tt>n</tt> elements. The | |
| 95 | <tt>OffsetMap</tt> is default constructed. | |
| 96 | ||
| 97 | <hr> | |
| 98 | ||
| 99 | <pre> | |
| 100 | shared_array_property_map(size_t n, OffsetMap m) | |
| 101 | </pre> | |
| 102 | Constructor. Builds the property map with a size of <tt>n</tt> elements. | |
| 103 | ||
| 104 | <hr> | |
| 105 | ||
| 106 | <hr> | |
| 107 | ||
| 108 | <h3>Non-Member functions</h3> | |
| 109 | ||
| 110 | <hr> | |
| 111 | ||
| 112 | <pre> | |
| 113 | template <class ValueType, class OffsetMap> | |
| 114 | shared_array_property_map<ValueType, OffsetMap> | |
| 115 | make_shared_array_property_map(size_t n, const ValueType&, OffsetMap omap) | |
| 116 | </pre> | |
| 117 | A function for conveniently creating a shared array map. | |
| 118 | ||
| 119 | ||
| 120 | <hr> | |
| 121 | ||
| 122 | <br> | |
| 123 | <HR> | |
| 124 | <TABLE> | |
| 125 | <TR valign=top> | |
| 126 | <TD nowrap>Copyright © 2009</TD><TD> | |
| 127 | Trustees of Indiana University. | |
| 128 | </TD></TR></TABLE> | |
| 129 | ||
| 130 | </BODY> | |
| 131 | </HTML> |