Imported Upstream version 5.3.21
[platform/upstream/libdb.git] / docs / api_reference / STL / db_set.html
1 <?xml version="1.0" encoding="UTF-8" standalone="no"?>
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml">
4   <head>
5     <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
6     <title>Chapter 7.  Db_set</title>
7     <link rel="stylesheet" href="apiReference.css" type="text/css" />
8     <meta name="generator" content="DocBook XSL Stylesheets V1.73.2" />
9     <link rel="start" href="index.html" title="Berkeley DB C++ Standard Template Library API Reference" />
10     <link rel="up" href="index.html" title="Berkeley DB C++ Standard Template Library API Reference" />
11     <link rel="prev" href="stldb_multimapoperator_ueq.html" title="operator!=" />
12     <link rel="next" href="stldb_setdstr_db_set.html" title="~db_set" />
13   </head>
14   <body>
15     <div xmlns="" class="navheader">
16       <div class="libver">
17         <p>Library Version 11.2.5.3</p>
18       </div>
19       <table width="100%" summary="Navigation header">
20         <tr>
21           <th colspan="3" align="center">Chapter 7. 
22  Db_set  </th>
23         </tr>
24         <tr>
25           <td width="20%" align="left"><a accesskey="p" href="stldb_multimapoperator_ueq.html">Prev</a> </td>
26           <th width="60%" align="center"> </th>
27           <td width="20%" align="right"> <a accesskey="n" href="stldb_setdstr_db_set.html">Next</a></td>
28         </tr>
29       </table>
30       <hr />
31     </div>
32     <div class="chapter" lang="en" xml:lang="en">
33       <div class="titlepage">
34         <div>
35           <div>
36             <h2 class="title"><a id="db_set"></a>Chapter 7. 
37  Db_set  </h2>
38           </div>
39         </div>
40       </div>
41       <p>This class is the combination of std::set and hash_set. </p>
42       <p>By setting database handles of DB_BTREE or DB_HASH type, you will be using the equivalent of std::set or hash_set. This container stores the key in the key element of a key/data pair in the underlying database, but doesn't store anything in the data element. Database and environment handle requirement: The same as that of <a class="link" href="db_map.html" title="Chapter 5.  Db_map">db_map</a>
43 . </p>
44       <h4><a id="idp375288"></a>
45 See Also
46 </h4>
47       <p> </p>
48       <p><a class="link" href="db_map.html" title="Chapter 5.  Db_map">db_map</a>
49  <a class="link" href="db_container.html" title="Chapter 3.  Db_container">db_container</a>
50  </p>
51       <div class="sect2" lang="en" xml:lang="en">
52         <div class="titlepage">
53           <div>
54             <div>
55               <h3 class="title"><a id="idp476400"></a>
56 Class Template Parameters</h3>
57             </div>
58           </div>
59         </div>
60         <div class="sect3" lang="en" xml:lang="en">
61           <div class="titlepage">
62             <div>
63               <div>
64                 <h4 class="title"><a id="idp476592"></a>
65 kdt</h4>
66               </div>
67             </div>
68           </div>
69           <p>The key data type. </p>
70         </div>
71         <div class="sect3" lang="en" xml:lang="en">
72           <div class="titlepage">
73             <div>
74               <div>
75                 <h4 class="title"><a id="idp480008"></a>
76 value_type_sub</h4>
77               </div>
78             </div>
79           </div>
80           <p>If kdt is a class/struct type, do not specify anything in this parameter; Otherwise specify ElementHolder&lt;kdt&gt;. </p>
81         </div>
82       </div>
83       <h4><a id="idp477112"></a> Public Members </h4>
84       <div class="informaltable">
85         <table border="1" width="80%">
86           <colgroup>
87             <col />
88             <col />
89           </colgroup>
90           <thead>
91             <tr>
92               <th>Member</th>
93               <th>Description</th>
94             </tr>
95           </thead>
96           <tbody>
97             <tr>
98               <td>
99 <a class="xref" href="db_set.html#stldb_setdb_set" title="db_set">db_set</a>
100 </td>
101               <td>
102    <p>Create a std::set/hash_set equivalent associative container. </p>        </td>
103             </tr>
104             <tr>
105               <td>
106 <a class="xref" href="stldb_setdstr_db_set.html" title="~db_set">~db_set</a>
107 </td>
108               <td>
109    </td>
110             </tr>
111             <tr>
112               <td>
113 <a class="xref" href="stldb_setinsert.html" title="insert">insert</a>
114 </td>
115               <td>
116    <p>Insert a single key/data pair if the key is not in the container. </p>        </td>
117             </tr>
118             <tr>
119               <td>
120 <a class="xref" href="stldb_setoperator_assign.html" title="operator=">operator=</a>
121 </td>
122               <td>
123    <p>Container content assignment operator. </p>        </td>
124             </tr>
125             <tr>
126               <td>
127 <a class="xref" href="stldb_setvalue_comp.html" title="value_comp">value_comp</a>
128 </td>
129               <td>
130    <p>Get value comparison functor. </p>        </td>
131             </tr>
132             <tr>
133               <td>
134 <a class="xref" href="stldb_setswap.html" title="swap">swap</a>
135 </td>
136               <td>
137    <p>Swap content with another container. </p>        </td>
138             </tr>
139             <tr>
140               <td>
141 <a class="xref" href="stldb_setoperator_eq.html" title="operator==">operator==</a>
142 </td>
143               <td>
144    <p>Set content equality comparison operator. </p>        </td>
145             </tr>
146             <tr>
147               <td>
148 <a class="xref" href="stldb_setoperator_ueq.html" title="operator!=">operator!=</a>
149 </td>
150               <td>
151    <p>Inequality comparison operator. </p>        </td>
152             </tr>
153           </tbody>
154         </table>
155       </div>
156       <h4><a id="idp487112"></a>
157 Group</h4>
158       <p>
159 <a class="xref" href="dbstl_containers.html" title="Chapter 2.  Dbstl Container Classes">
160  Dbstl Container Classes  </a>
161 </p>
162       <p>
163 </p>
164       <div class="sect1" lang="en" xml:lang="en">
165         <div class="titlepage">
166           <div>
167             <div>
168               <h2 class="title" style="clear: both"><a id="stldb_setdb_set"></a>db_set</h2>
169             </div>
170           </div>
171         </div>
172         <div class="sect2" lang="en" xml:lang="en">
173           <div class="titlepage">
174             <div>
175               <div>
176                 <h3 class="title"><a id="stldb_setdb_set_details"></a>Function Details</h3>
177               </div>
178             </div>
179           </div>
180           <pre class="programlisting">
181 db_set(Db *dbp=NULL,
182     DbEnv *envp=NULL)
183  </pre>
184           <p>Create a std::set/hash_set equivalent associative container. </p>
185           <p>See the handle requirement in class details to pass correct database/environment handles. </p>
186           <div class="sect3" lang="en" xml:lang="en">
187             <div class="titlepage">
188               <div>
189                 <div>
190                   <h4 class="title"><a id="idp477992"></a>Parameters</h4>
191                 </div>
192               </div>
193             </div>
194             <div class="sect4" lang="en" xml:lang="en">
195               <div class="titlepage">
196                 <div>
197                   <div>
198                     <h5 class="title"><a id="idp496016"></a>dbp</h5>
199                   </div>
200                 </div>
201               </div>
202               <p>The database handle. </p>
203             </div>
204             <div class="sect4" lang="en" xml:lang="en">
205               <div class="titlepage">
206                 <div>
207                   <div>
208                     <h5 class="title"><a id="idp497896"></a>envp</h5>
209                   </div>
210                 </div>
211               </div>
212               <p>The database environment handle. </p>
213             </div>
214           </div>
215           <div class="sect3" lang="en" xml:lang="en">
216             <div class="titlepage">
217               <div>
218                 <div>
219                   <h4 class="title"><a id="idp493816"></a>See Also</h4>
220                 </div>
221               </div>
222             </div>
223             <p>
224     </p>
225             <p><a class="link" href="db_map.html#stldb_mapdb_map" title="db_map">db_map(Db*, DbEnv*)</a>
226  <a class="link" href="stldb_containerdb_container.html" title="db_container">db_container(Db*, DbEnv*)</a>
227  </p>
228             <p>
229    </p>
230           </div>
231           <pre class="programlisting">
232 db_set(Db *dbp, DbEnv *envp, InputIterator first,
233     InputIterator last)
234  </pre>
235           <p>Iteration constructor. </p>
236           <p>Iterates between first and last, copying each of the elements in the range into this container. Create a std::set/hash_set equivalent associative container. Insert a range of elements into the database. The range is [first, last), which contains elements that can be converted to type ddt automatically. This function supports auto-commit. See the handle requirement in class details to pass correct database/environment handles. </p>
237           <div class="sect3" lang="en" xml:lang="en">
238             <div class="titlepage">
239               <div>
240                 <div>
241                   <h4 class="title"><a id="idp478496"></a>Parameters</h4>
242                 </div>
243               </div>
244             </div>
245             <div class="sect4" lang="en" xml:lang="en">
246               <div class="titlepage">
247                 <div>
248                   <div>
249                     <h5 class="title"><a id="idp461192"></a>dbp</h5>
250                   </div>
251                 </div>
252               </div>
253               <p>The database handle. </p>
254             </div>
255             <div class="sect4" lang="en" xml:lang="en">
256               <div class="titlepage">
257                 <div>
258                   <div>
259                     <h5 class="title"><a id="idp501424"></a>envp</h5>
260                   </div>
261                 </div>
262               </div>
263               <p>The database environment handle. </p>
264             </div>
265             <div class="sect4" lang="en" xml:lang="en">
266               <div class="titlepage">
267                 <div>
268                   <div>
269                     <h5 class="title"><a id="idp501744"></a>last</h5>
270                   </div>
271                 </div>
272               </div>
273               <p>The open boundary of the range. </p>
274             </div>
275             <div class="sect4" lang="en" xml:lang="en">
276               <div class="titlepage">
277                 <div>
278                   <div>
279                     <h5 class="title"><a id="idp502064"></a>first</h5>
280                   </div>
281                 </div>
282               </div>
283               <p>The closed boundary of the range. </p>
284             </div>
285           </div>
286           <div class="sect3" lang="en" xml:lang="en">
287             <div class="titlepage">
288               <div>
289                 <div>
290                   <h4 class="title"><a id="idp464864"></a>See Also</h4>
291                 </div>
292               </div>
293             </div>
294             <p>
295     </p>
296             <p><a class="link" href="db_map.html#stldb_mapdb_map" title="db_map">db_map(Db*, DbEnv*, InputIterator, InputIterator)</a>
297  </p>
298             <p>
299    </p>
300           </div>
301           <pre class="programlisting">
302 db_set(const self &amp;x)
303  </pre>
304           <p>Copy constructor. </p>
305           <p>Create a database and insert all key/data pairs in x into this container. x's data members are not copied. This function supports auto-commit. </p>
306           <div class="sect3" lang="en" xml:lang="en">
307             <div class="titlepage">
308               <div>
309                 <div>
310                   <h4 class="title"><a id="idp496232"></a>Parameters</h4>
311                 </div>
312               </div>
313             </div>
314             <div class="sect4" lang="en" xml:lang="en">
315               <div class="titlepage">
316                 <div>
317                   <div>
318                     <h5 class="title"><a id="idp496424"></a>x</h5>
319                   </div>
320                 </div>
321               </div>
322               <p>The source container to initialize this container. </p>
323             </div>
324           </div>
325           <div class="sect3" lang="en" xml:lang="en">
326             <div class="titlepage">
327               <div>
328                 <div>
329                   <h4 class="title"><a id="idp497264"></a>See Also</h4>
330                 </div>
331               </div>
332             </div>
333             <p>
334     </p>
335             <p><a class="link" href="db_map.html#stldb_mapdb_map" title="db_map">db_map(const db_map&amp;)</a>
336  <a class="link" href="stldb_containerdb_container.html" title="db_container">db_container(const db_container&amp;)</a>
337  </p>
338             <p>
339    </p>
340           </div>
341         </div>
342         <div class="sect2" lang="en" xml:lang="en">
343           <div class="titlepage">
344             <div>
345               <div>
346                 <h3 class="title"><a id="idp480736"></a>Class</h3>
347               </div>
348             </div>
349           </div>
350           <p>
351   <a class="link" href="db_set.html" title="Chapter 7.  Db_set">db_set</a>
352      </p>
353         </div>
354       </div>
355     </div>
356     <div class="navfooter">
357       <hr />
358       <table width="100%" summary="Navigation footer">
359         <tr>
360           <td width="40%" align="left"><a accesskey="p" href="stldb_multimapoperator_ueq.html">Prev</a> </td>
361           <td width="20%" align="center"> </td>
362           <td width="40%" align="right"> <a accesskey="n" href="stldb_setdstr_db_set.html">Next</a></td>
363         </tr>
364         <tr>
365           <td width="40%" align="left" valign="top">operator!= </td>
366           <td width="20%" align="center">
367             <a accesskey="h" href="index.html">Home</a>
368           </td>
369           <td width="40%" align="right" valign="top"> ~db_set</td>
370         </tr>
371       </table>
372     </div>
373   </body>
374 </html>