PageRenderTime 14ms CodeModel.GetById 6ms app.highlight 4ms RepoModel.GetById 1ms app.codeStats 0ms

/Src/Dependencies/Boost/libs/property_map/doc/shared_array_property_map.html

http://hadesmem.googlecode.com/
HTML | 131 lines | 89 code | 35 blank | 7 comment | 0 complexity | bb731e371bbcc7d9a5200d23f43a2684 MD5 | raw file
  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>
 22shared_array_property_map&lt;ValueType, OffsetMap&gt;
 23</PRE>
 24
 25<P>
 26This property map is an adaptor that contains a <a
 27href="../../smart_ptr/shared_array.htm">boost::shared_array</a> and uses that
 28array to store the property map's data.  The resulting property map is a model
 29of <a href="./LvaluePropertyMap.html">Lvalue Property Map</a>.
 30The <tt>OffsetMap</tt> type is responsible for converting
 31key 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>&nbsp;</TD>
 61</TR>
 62
 63
 64<TR>
 65<TD><TT>OffsetMap</TT></TD> <TD>Must be a model of <a
 66href="./ReadablePropertyMap.html">Readable Property Map</a>
 67and the value type must be convertible to <tt>std::size_t</tt>.
 68</TD> <TD>&nbsp;</TD>
 69</TR>
 70
 71</TABLE>
 72<P>
 73
 74<H3>Members</H3>
 75
 76<P>
 77In addition to the methods and functions required by <a
 78href="./LvaluePropertyMap.html">Lvalue Property Map</a>, this
 79class has the following members.
 80
 81<hr>
 82
 83<pre>
 84property_traits&lt;shared_array_property_map&gt;::value_type
 85</pre>
 86This is the same type as
 87<TT>ValueType</TT>.
 88
 89<hr>
 90
 91<pre>
 92shared_array_property_map(size_t n)
 93</pre>
 94Constructor. 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>
100shared_array_property_map(size_t n, OffsetMap m)
101</pre>
102Constructor.  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 &lt;class ValueType, class OffsetMap&gt;
114  shared_array_property_map&lt;ValueType, OffsetMap&gt;
115  make_shared_array_property_map(size_t n, const ValueType&amp;, OffsetMap omap)
116</pre>
117A 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 &copy; 2009</TD><TD>
127Trustees of Indiana University.
128</TD></TR></TABLE>
129
130</BODY>
131</HTML>