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
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
|
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- q3memarray.qdoc -->
<title>Qt 4.8: Q3MemArray Class Reference</title>
<link rel="stylesheet" type="text/css" href="style/offline.css" />
</head>
<body>
<div class="header" id="qtdocheader">
<div class="content">
<a href="index.html" class="qtref"><span>Qt Reference Documentation</span></a>
</div>
<div class="breadcrumb toolblock">
<ul>
<li class="first"><a href="index.html">Home</a></li>
<!-- Breadcrumbs go here -->
<li><a href="modules.html">Modules</a></li>
<li>Qt3SupportLight</li>
<li>Q3MemArray</li>
</ul>
</div>
</div>
<div class="content mainContent">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#public-types">Public Types</a></li>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#protected-functions">Protected Functions</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">Q3MemArray Class Reference</h1>
<!-- $$$Q3MemArray-brief -->
<p>The Q3MemArray class is a template class that provides arrays of simple types. <a href="#details">More...</a></p>
<!-- @@@Q3MemArray -->
<pre class="cpp"> <span class="preprocessor">#include <Q3MemArray></span></pre><p><b>This class is part of the Qt 3 support library.</b> It is provided to keep old source code working. We strongly advise against using it in new code. See <a href="porting4.html">Porting to Qt 4</a> for more information.</p>
<ul>
<li><a href="q3memarray-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-types"></a>
<h2>Public Types</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> typedef </td><td class="memItemRight bottomAlign"><b><a href="q3memarray.html#ConstIterator-typedef">ConstIterator</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> typedef </td><td class="memItemRight bottomAlign"><b><a href="q3memarray.html#Iterator-typedef">Iterator</a></b></td></tr>
</table>
<a name="public-functions"></a>
<h2>Public Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="q3memarray.html#Q3MemArray-2">Q3MemArray</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="q3memarray.html#Q3MemArray-3">Q3MemArray</a></b> ( int <i>size</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="q3memarray.html#Q3MemArray-4">Q3MemArray</a></b> ( const Q3MemArray<type> & <i>a</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="q3memarray.html#Q3MemArray-5">Q3MemArray</a></b> ( const QVector<type> & <i>vector</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="q3memarray.html#dtor.Q3MemArray">~Q3MemArray</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> Q3MemArray<type> & </td><td class="memItemRight bottomAlign"><b><a href="q3memarray.html#assign">assign</a></b> ( const Q3MemArray<type> & <i>a</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> Q3MemArray<type> & </td><td class="memItemRight bottomAlign"><b><a href="q3memarray.html#assign-2">assign</a></b> ( const type * <i>data</i>, uint <i>size</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> type & </td><td class="memItemRight bottomAlign"><b><a href="q3memarray.html#at">at</a></b> ( uint <i>index</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> Iterator </td><td class="memItemRight bottomAlign"><b><a href="q3memarray.html#begin">begin</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> ConstIterator </td><td class="memItemRight bottomAlign"><b><a href="q3memarray.html#begin-2">begin</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="q3memarray.html#bsearch">bsearch</a></b> ( const type & <i>v</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="q3memarray.html#contains">contains</a></b> ( const type & <i>v</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> Q3MemArray<type> </td><td class="memItemRight bottomAlign"><b><a href="q3memarray.html#copy">copy</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> uint </td><td class="memItemRight bottomAlign"><b><a href="q3memarray.html#count">count</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> type * </td><td class="memItemRight bottomAlign"><b><a href="q3memarray.html#data">data</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> Q3MemArray<type> & </td><td class="memItemRight bottomAlign"><b><a href="q3memarray.html#duplicate">duplicate</a></b> ( const Q3MemArray<type> & <i>a</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> Q3MemArray<type> & </td><td class="memItemRight bottomAlign"><b><a href="q3memarray.html#duplicate-2">duplicate</a></b> ( const type * <i>data</i>, uint <i>size</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> Iterator </td><td class="memItemRight bottomAlign"><b><a href="q3memarray.html#end">end</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> ConstIterator </td><td class="memItemRight bottomAlign"><b><a href="q3memarray.html#end-2">end</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="q3memarray.html#fill">fill</a></b> ( const type & <i>v</i>, int <i>size</i> = -1 )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="q3memarray.html#find">find</a></b> ( const type & <i>v</i>, uint <i>index</i> = 0 ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="q3memarray.html#isEmpty">isEmpty</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="q3memarray.html#isNull">isNull</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> uint </td><td class="memItemRight bottomAlign"><b><a href="q3memarray.html#nrefs">nrefs</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="q3memarray.html#resetRawData">resetRawData</a></b> ( const type * <i>data</i>, uint <i>size</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="q3memarray.html#resize">resize</a></b> ( uint <i>size</i>, Optimization <i>optim</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="q3memarray.html#resize-2">resize</a></b> ( uint <i>size</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> Q3MemArray<type> & </td><td class="memItemRight bottomAlign"><b><a href="q3memarray.html#setRawData">setRawData</a></b> ( const type * <i>data</i>, uint <i>size</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> uint </td><td class="memItemRight bottomAlign"><b><a href="q3memarray.html#size">size</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="q3memarray.html#sort">sort</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="q3memarray.html#truncate">truncate</a></b> ( uint <i>pos</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="q3memarray.html#operator-QVector-lttype-gt">operator QVector<type></a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="q3memarray.html#operator-const-type--2a">operator const type *</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="q3memarray.html#operator-not-eq">operator!=</a></b> ( const Q3MemArray<type> & <i>a</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> Q3MemArray<type> & </td><td class="memItemRight bottomAlign"><b><a href="q3memarray.html#operator-eq">operator=</a></b> ( const Q3MemArray<type> & <i>a</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="q3memarray.html#operator-eq-eq">operator==</a></b> ( const Q3MemArray<type> & <i>a</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> type & </td><td class="memItemRight bottomAlign"><b><a href="q3memarray.html#operator-5b-5d">operator[]</a></b> ( int <i>index</i> ) const</td></tr>
</table>
<a name="reimplemented-public-functions"></a>
<h2>Reimplemented Public Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="q3memarray.html#detach">detach</a></b> ()</td></tr>
</table>
<a name="protected-functions"></a>
<h2>Protected Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="q3memarray.html#Q3MemArray">Q3MemArray</a></b> ( int <i>arg1</i>, int <i>arg2</i> )</td></tr>
</table>
<a name="details"></a>
<!-- $$$Q3MemArray-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The Q3MemArray class is a template class that provides arrays of simple types.</p>
<p>Q3MemArray is implemented as a template class. Define a template instance Q3MemArray<X> to create an array that contains X items.</p>
<p>Q3MemArray stores the array elements directly in the array. It can only deal with simple types (i.e. C++ types, structs, and classes that have no constructors, destructors, or virtual functions). Q3MemArray uses bitwise operations to copy and compare array elements.</p>
<p>The <a href="q3ptrvector.html">Q3PtrVector</a> collection class is also a kind of array. Like most old Qt collection classes, it uses pointers to the contained items.</p>
<p>Q3MemArray uses explicit sharing with a reference count. If more than one array shares common data and one of the arrays is modified, all the arrays are modified.</p>
<p>The benefit of sharing is that a program does not need to duplicate data when it is not required, which results in lower memory use and less copying of data.</p>
<p>Example:</p>
<pre class="cpp"> <span class="preprocessor">#include <q3memarray.h></span>
<span class="preprocessor">#include <stdio.h></span>
<span class="type">Q3MemArray</span><span class="operator"><</span><span class="type">int</span><span class="operator">></span> fib( <span class="type">int</span> num ) <span class="comment">// returns fibonacci array</span>
{
Q_ASSERT( num <span class="operator">></span> <span class="number">2</span> );
<span class="type">Q3MemArray</span><span class="operator"><</span><span class="type">int</span><span class="operator">></span> f( num ); <span class="comment">// array of ints</span>
f<span class="operator">[</span><span class="number">0</span><span class="operator">]</span> <span class="operator">=</span> f<span class="operator">[</span><span class="number">1</span><span class="operator">]</span> <span class="operator">=</span> <span class="number">1</span>;
<span class="keyword">for</span> ( <span class="type">int</span> i <span class="operator">=</span> <span class="number">2</span>; i <span class="operator"><</span> num; i<span class="operator">+</span><span class="operator">+</span> )
f<span class="operator">[</span>i<span class="operator">]</span> <span class="operator">=</span> f<span class="operator">[</span>i<span class="operator">-</span><span class="number">1</span><span class="operator">]</span> <span class="operator">+</span> f<span class="operator">[</span>i<span class="operator">-</span><span class="number">2</span><span class="operator">]</span>;
<span class="keyword">return</span> f;
}
<span class="type">int</span> main()
{
<span class="type">Q3MemArray</span><span class="operator"><</span><span class="type">int</span><span class="operator">></span> a <span class="operator">=</span> fib( <span class="number">6</span> ); <span class="comment">// get first 6 fibonaccis</span>
<span class="keyword">for</span> ( <span class="type">int</span> i <span class="operator">=</span> <span class="number">0</span>; i <span class="operator"><</span> a<span class="operator">.</span>size(); i<span class="operator">+</span><span class="operator">+</span> )
<a href="qtglobal.html#qDebug">qDebug</a>( <span class="string">"%d: %d"</span><span class="operator">,</span> i<span class="operator">,</span> a<span class="operator">[</span>i<span class="operator">]</span> );
<a href="qtglobal.html#qDebug">qDebug</a>( <span class="string">"1 is found %d times"</span><span class="operator">,</span> a<span class="operator">.</span>contains(<span class="number">1</span>) );
<a href="qtglobal.html#qDebug">qDebug</a>( <span class="string">"5 is found at index %d"</span><span class="operator">,</span> a<span class="operator">.</span>find(<span class="number">5</span>) );
<span class="keyword">return</span> <span class="number">0</span>;
}</pre>
<p>Program output:</p>
<pre class="cpp"> 0: 1
1: 1
2: 2
3: 3
4: 5
5: 8
1 is found 2 times
5 is found at index 4</pre>
<p>Note concerning the use of Q3MemArray for manipulating structs or classes: Compilers will often pad the size of structs of odd sizes up to the nearest word boundary. This will then be the size Q3MemArray will use for its bitwise element comparisons. Because the remaining bytes will typically be uninitialized, this can cause <a href="q3memarray.html#find">find</a>() etc. to fail to find the element. Example:</p>
<pre class="cpp"> <span class="comment">// MyStruct may be padded to 4 or 8 bytes</span>
<span class="keyword">struct</span> MyStruct
{
<span class="type">short</span> i; <span class="comment">// 2 bytes</span>
<span class="type">char</span> c; <span class="comment">// 1 byte</span>
};
<span class="type">Q3MemArray</span><span class="operator"><</span>MyStruct<span class="operator">></span> a(<span class="number">1</span>);
a<span class="operator">[</span><span class="number">0</span><span class="operator">]</span><span class="operator">.</span>i <span class="operator">=</span> <span class="number">5</span>;
a<span class="operator">[</span><span class="number">0</span><span class="operator">]</span><span class="operator">.</span>c <span class="operator">=</span> <span class="char">'t'</span>;
MyStruct x;
x<span class="operator">.</span>i <span class="operator">=</span> <span class="char">'5'</span>;
x<span class="operator">.</span>c <span class="operator">=</span> <span class="char">'t'</span>;
<span class="type">int</span> i <span class="operator">=</span> a<span class="operator">.</span><a href="q3memarray.html#find">find</a>( x ); <span class="comment">// may return -1 if the pad bytes differ</span></pre>
<p>To work around this, make sure that you use a struct where sizeof() returns the same as the sum of the sizes of the members either by changing the types of the struct members or by adding dummy members.</p>
<p>Q3MemArray data can be traversed by iterators (see <a href="q3memarray.html#begin">begin</a>() and <a href="q3memarray.html#end">end</a>()). The number of items is returned by <a href="q3memarray.html#count">count</a>(). The array can be resized with <a href="q3memarray.html#resize">resize</a>() and filled using <a href="q3memarray.html#fill">fill</a>().</p>
<p>You can make a shallow copy of the array with <a href="q3memarray.html#assign">assign</a>() (or operator=()) and a deep copy with <a href="q3memarray.html#duplicate">duplicate</a>().</p>
<p>Search for values in the array with <a href="q3memarray.html#find">find</a>() and <a href="q3memarray.html#contains">contains</a>(). For sorted arrays (see <a href="q3memarray.html#sort">sort</a>()) you can search using <a href="q3memarray.html#bsearch">bsearch</a>().</p>
<p>You can set the data directly using <a href="q3memarray.html#setRawData">setRawData</a>() and <a href="q3memarray.html#resetRawData">resetRawData</a>(), although this requires care.</p>
</div>
<!-- @@@Q3MemArray -->
<div class="types">
<h2>Member Type Documentation</h2>
<!-- $$$ConstIterator -->
<h3 class="fn"><a name="ConstIterator-typedef"></a>typedef Q3MemArray::<span class="name">ConstIterator</span></h3>
<p>A const <a href="q3memarray.html" class="compat">Q3MemArray</a> iterator.</p>
<p><b>See also </b><a href="q3memarray.html#begin">begin</a>() and <a href="q3memarray.html#end">end</a>().</p>
<!-- @@@ConstIterator -->
<!-- $$$Iterator -->
<h3 class="fn"><a name="Iterator-typedef"></a>typedef Q3MemArray::<span class="name">Iterator</span></h3>
<p>A <a href="q3memarray.html" class="compat">Q3MemArray</a> iterator.</p>
<p><b>See also </b><a href="q3memarray.html#begin">begin</a>() and <a href="q3memarray.html#end">end</a>().</p>
<!-- @@@Iterator -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$Q3MemArray[overload1]$$$Q3MemArrayintint -->
<h3 class="fn"><a name="Q3MemArray"></a>Q3MemArray::<span class="name">Q3MemArray</span> ( <span class="type">int</span> <i>arg1</i>, <span class="type">int</span> <i>arg2</i> )<tt> [protected]</tt></h3>
<p>Constructs an array <i>without allocating</i> array space. The arguments <i>arg1</i> and <i>arg2</i> should be zero. Use at your own risk.</p>
<!-- @@@Q3MemArray -->
<!-- $$$Q3MemArray$$$Q3MemArray -->
<h3 class="fn"><a name="Q3MemArray-2"></a>Q3MemArray::<span class="name">Q3MemArray</span> ()</h3>
<p>Constructs a null array.</p>
<p><b>See also </b><a href="q3memarray.html#isNull">isNull</a>().</p>
<!-- @@@Q3MemArray -->
<!-- $$$Q3MemArray$$$Q3MemArrayint -->
<h3 class="fn"><a name="Q3MemArray-3"></a>Q3MemArray::<span class="name">Q3MemArray</span> ( <span class="type">int</span> <i>size</i> )</h3>
<p>Constructs an array with room for <i>size</i> elements. Makes a null array if <i>size</i> == 0.</p>
<p>The elements are left uninitialized.</p>
<p><b>See also </b><a href="q3memarray.html#resize">resize</a>() and <a href="q3memarray.html#isNull">isNull</a>().</p>
<!-- @@@Q3MemArray -->
<!-- $$$Q3MemArray$$$Q3MemArrayconstQ3MemArray<type>& -->
<h3 class="fn"><a name="Q3MemArray-4"></a>Q3MemArray::<span class="name">Q3MemArray</span> ( const <span class="type">Q3MemArray</span><<span class="type">type</span>> & <i>a</i> )</h3>
<p>Constructs a shallow copy of <i>a</i>.</p>
<p><b>See also </b><a href="q3memarray.html#assign">assign</a>().</p>
<!-- @@@Q3MemArray -->
<!-- $$$Q3MemArray$$$Q3MemArrayconstQVector<type>& -->
<h3 class="fn"><a name="Q3MemArray-5"></a>Q3MemArray::<span class="name">Q3MemArray</span> ( const <span class="type"><a href="qvector.html">QVector</a></span><<span class="type">type</span>> & <i>vector</i> )</h3>
<p>Constructs a copy of <i>vector</i>.</p>
<!-- @@@Q3MemArray -->
<!-- $$$~Q3MemArray[overload1]$$$~Q3MemArray -->
<h3 class="fn"><a name="dtor.Q3MemArray"></a>Q3MemArray::<span class="name">~Q3MemArray</span> ()</h3>
<p>Dereferences the array data and deletes it if this was the last reference.</p>
<!-- @@@~Q3MemArray -->
<!-- $$$assign[overload1]$$$assignconstQ3MemArray<type>& -->
<h3 class="fn"><a name="assign"></a><span class="type">Q3MemArray</span><<span class="type">type</span>> & Q3MemArray::<span class="name">assign</span> ( const <span class="type">Q3MemArray</span><<span class="type">type</span>> & <i>a</i> )</h3>
<p>Shallow copy. Dereferences the current array and references the data contained in <i>a</i> instead. Returns a reference to this array.</p>
<p><b>See also </b><a href="q3memarray.html#operator-eq">operator=</a>().</p>
<!-- @@@assign -->
<!-- $$$assign$$$assignconsttype*uint -->
<h3 class="fn"><a name="assign-2"></a><span class="type">Q3MemArray</span><<span class="type">type</span>> & Q3MemArray::<span class="name">assign</span> ( const <span class="type">type</span> * <i>data</i>, <span class="type"><a href="qtglobal.html#uint-typedef">uint</a></span> <i>size</i> )</h3>
<p>This is an overloaded function.</p>
<p>Shallow copy. Dereferences the current array and references the array data <i>data</i>, which contains <i>size</i> elements. Returns a reference to this array.</p>
<p>Do not delete <i>data</i> later; <a href="q3memarray.html" class="compat">Q3MemArray</a> will call free() on it at the right time.</p>
<!-- @@@assign -->
<!-- $$$at[overload1]$$$atuint -->
<h3 class="fn"><a name="at"></a><span class="type">type</span> & Q3MemArray::<span class="name">at</span> ( <span class="type"><a href="qtglobal.html#uint-typedef">uint</a></span> <i>index</i> ) const</h3>
<p>Returns a reference to the element at position <i>index</i> in the array.</p>
<p>This can be used to both read and set an element.</p>
<p><b>See also </b><a href="q3memarray.html#operator-5b-5d">operator[]</a>().</p>
<!-- @@@at -->
<!-- $$$begin[overload1]$$$begin -->
<h3 class="fn"><a name="begin"></a><span class="type"><a href="q3memarray.html#Iterator-typedef">Iterator</a></span> Q3MemArray::<span class="name">begin</span> ()</h3>
<p>Returns an iterator pointing at the beginning of this array. This iterator can be used in the same way as the iterators of <a href="q3valuelist.html" class="compat">Q3ValueList</a> and <a href="qmap.html">QMap</a>, for example.</p>
<!-- @@@begin -->
<!-- $$$begin$$$begin -->
<h3 class="fn"><a name="begin-2"></a><span class="type"><a href="q3memarray.html#ConstIterator-typedef">ConstIterator</a></span> Q3MemArray::<span class="name">begin</span> () const</h3>
<p>This is an overloaded function.</p>
<p>Returns a const iterator pointing at the beginning of this array. This iterator can be used in the same way as the iterators of <a href="q3valuelist.html" class="compat">Q3ValueList</a> and <a href="qmap.html">QMap</a>, for example.</p>
<!-- @@@begin -->
<!-- $$$bsearch[overload1]$$$bsearchconsttype& -->
<h3 class="fn"><a name="bsearch"></a><span class="type">int</span> Q3MemArray::<span class="name">bsearch</span> ( const <span class="type">type</span> & <i>v</i> ) const</h3>
<p>In a sorted array (as sorted by <a href="q3memarray.html#sort">sort</a>()), finds the first occurrence of <i>v</i> by using a binary search. For a sorted array this is generally much faster than <a href="q3memarray.html#find">find</a>(), which does a linear search.</p>
<p>Returns the position of <i>v</i>, or -1 if <i>v</i> could not be found.</p>
<p><b>See also </b><a href="q3memarray.html#sort">sort</a>() and <a href="q3memarray.html#find">find</a>().</p>
<!-- @@@bsearch -->
<!-- $$$contains[overload1]$$$containsconsttype& -->
<h3 class="fn"><a name="contains"></a><span class="type">int</span> Q3MemArray::<span class="name">contains</span> ( const <span class="type">type</span> & <i>v</i> ) const</h3>
<p>Returns the number of times <i>v</i> occurs in the array.</p>
<p><b>See also </b><a href="q3memarray.html#find">find</a>().</p>
<!-- @@@contains -->
<!-- $$$copy[overload1]$$$copy -->
<h3 class="fn"><a name="copy"></a><span class="type">Q3MemArray</span><<span class="type">type</span>> Q3MemArray::<span class="name">copy</span> () const</h3>
<p>Returns a deep copy of this array.</p>
<p><b>See also </b><a href="q3memarray.html#detach">detach</a>() and <a href="q3memarray.html#duplicate">duplicate</a>().</p>
<!-- @@@copy -->
<!-- $$$count[overload1]$$$count -->
<h3 class="fn"><a name="count"></a><span class="type"><a href="qtglobal.html#uint-typedef">uint</a></span> Q3MemArray::<span class="name">count</span> () const</h3>
<p>Returns the same as <a href="q3memarray.html#size">size</a>().</p>
<p><b>See also </b><a href="q3memarray.html#size">size</a>().</p>
<!-- @@@count -->
<!-- $$$data[overload1]$$$data -->
<h3 class="fn"><a name="data"></a><span class="type">type</span> * Q3MemArray::<span class="name">data</span> () const</h3>
<p>Returns a pointer to the actual array data.</p>
<p>The array is a null array if data() == 0 (null pointer).</p>
<p><b>See also </b><a href="q3memarray.html#isNull">isNull</a>().</p>
<!-- @@@data -->
<!-- $$$detach[overload1]$$$detach -->
<h3 class="fn"><a name="detach"></a><span class="type">void</span> Q3MemArray::<span class="name">detach</span> ()<tt> [virtual]</tt></h3>
<p>Detaches this array from shared array data; i.e. it makes a private, deep copy of the data.</p>
<p>Copying will be performed only if the <a href="q3memarray.html#nrefs">reference count</a> is greater than one.</p>
<p><b>See also </b><a href="q3memarray.html#copy">copy</a>().</p>
<!-- @@@detach -->
<!-- $$$duplicate[overload1]$$$duplicateconstQ3MemArray<type>& -->
<h3 class="fn"><a name="duplicate"></a><span class="type">Q3MemArray</span><<span class="type">type</span>> & Q3MemArray::<span class="name">duplicate</span> ( const <span class="type">Q3MemArray</span><<span class="type">type</span>> & <i>a</i> )</h3>
<p>Deep copy. Dereferences the current array and obtains a copy of the data contained in <i>a</i> instead. Returns a reference to this array.</p>
<p><b>See also </b><a href="q3memarray.html#copy">copy</a>().</p>
<!-- @@@duplicate -->
<!-- $$$duplicate$$$duplicateconsttype*uint -->
<h3 class="fn"><a name="duplicate-2"></a><span class="type">Q3MemArray</span><<span class="type">type</span>> & Q3MemArray::<span class="name">duplicate</span> ( const <span class="type">type</span> * <i>data</i>, <span class="type"><a href="qtglobal.html#uint-typedef">uint</a></span> <i>size</i> )</h3>
<p>This is an overloaded function.</p>
<p>Deep copy. Dereferences the current array and obtains a copy of the array data <i>data</i> instead. Returns a reference to this array. The size of the array is given by <i>size</i>.</p>
<p><b>See also </b><a href="q3memarray.html#copy">copy</a>().</p>
<!-- @@@duplicate -->
<!-- $$$end[overload1]$$$end -->
<h3 class="fn"><a name="end"></a><span class="type"><a href="q3memarray.html#Iterator-typedef">Iterator</a></span> Q3MemArray::<span class="name">end</span> ()</h3>
<p>Returns an iterator pointing behind the last element of this array. This iterator can be used in the same way as the iterators of <a href="q3valuelist.html" class="compat">Q3ValueList</a> and <a href="qmap.html">QMap</a>, for example.</p>
<!-- @@@end -->
<!-- $$$end$$$end -->
<h3 class="fn"><a name="end-2"></a><span class="type"><a href="q3memarray.html#ConstIterator-typedef">ConstIterator</a></span> Q3MemArray::<span class="name">end</span> () const</h3>
<p>This is an overloaded function.</p>
<p>Returns a const iterator pointing behind the last element of this array. This iterator can be used in the same way as the iterators of <a href="q3valuelist.html" class="compat">Q3ValueList</a> and <a href="qmap.html">QMap</a>, for example.</p>
<!-- @@@end -->
<!-- $$$fill[overload1]$$$fillconsttype&int -->
<h3 class="fn"><a name="fill"></a><span class="type">bool</span> Q3MemArray::<span class="name">fill</span> ( const <span class="type">type</span> & <i>v</i>, <span class="type">int</span> <i>size</i> = -1 )</h3>
<p>Fills the array with the value <i>v</i>. If <i>size</i> is specified as different from -1, then the array will be resized before being filled.</p>
<p>Returns TRUE if successful, i.e. if <i>size</i> is -1, or <i>size</i> is != -1 and the memory can be allocated; otherwise returns FALSE.</p>
<p><b>See also </b><a href="q3memarray.html#resize">resize</a>().</p>
<!-- @@@fill -->
<!-- $$$find[overload1]$$$findconsttype&uint -->
<h3 class="fn"><a name="find"></a><span class="type">int</span> Q3MemArray::<span class="name">find</span> ( const <span class="type">type</span> & <i>v</i>, <span class="type"><a href="qtglobal.html#uint-typedef">uint</a></span> <i>index</i> = 0 ) const</h3>
<p>Finds the first occurrence of <i>v</i>, starting at position <i>index</i>.</p>
<p>Returns the position of <i>v</i>, or -1 if <i>v</i> could not be found.</p>
<p><b>See also </b><a href="q3memarray.html#contains">contains</a>().</p>
<!-- @@@find -->
<!-- $$$isEmpty[overload1]$$$isEmpty -->
<h3 class="fn"><a name="isEmpty"></a><span class="type">bool</span> Q3MemArray::<span class="name">isEmpty</span> () const</h3>
<p>Returns TRUE if the array is empty; otherwise returns FALSE.</p>
<p>isEmpty() is equivalent to <a href="q3memarray.html#isNull">isNull</a>() for <a href="q3memarray.html" class="compat">Q3MemArray</a> (unlike <a href="qstring.html">QString</a>).</p>
<!-- @@@isEmpty -->
<!-- $$$isNull[overload1]$$$isNull -->
<h3 class="fn"><a name="isNull"></a><span class="type">bool</span> Q3MemArray::<span class="name">isNull</span> () const</h3>
<p>Returns TRUE if the array is null; otherwise returns FALSE.</p>
<p>A null array has <a href="q3memarray.html#size">size</a>() == 0 and <a href="q3memarray.html#data">data</a>() == 0.</p>
<!-- @@@isNull -->
<!-- $$$nrefs[overload1]$$$nrefs -->
<h3 class="fn"><a name="nrefs"></a><span class="type"><a href="qtglobal.html#uint-typedef">uint</a></span> Q3MemArray::<span class="name">nrefs</span> () const</h3>
<p>Returns the reference count for the shared array data. This reference count is always greater than zero.</p>
<!-- @@@nrefs -->
<!-- $$$resetRawData[overload1]$$$resetRawDataconsttype*uint -->
<h3 class="fn"><a name="resetRawData"></a><span class="type">void</span> Q3MemArray::<span class="name">resetRawData</span> ( const <span class="type">type</span> * <i>data</i>, <span class="type"><a href="qtglobal.html#uint-typedef">uint</a></span> <i>size</i> )</h3>
<p>Removes internal references to the raw data that was set using <a href="q3memarray.html#setRawData">setRawData</a>(). This means that <a href="q3memarray.html" class="compat">Q3MemArray</a> no longer has access to the <i>data</i>, so you are free to manipulate <i>data</i> as you wish. You can now use the <a href="q3memarray.html" class="compat">Q3MemArray</a> without affecting the original <i>data</i>, for example by calling <a href="q3memarray.html#setRawData">setRawData</a>() with a pointer to some other data.</p>
<p>The arguments must be the <i>data</i> and length, <i>size</i>, that were passed to <a href="q3memarray.html#setRawData">setRawData</a>(). This is for consistency checking.</p>
<p><b>See also </b><a href="q3memarray.html#setRawData">setRawData</a>().</p>
<!-- @@@resetRawData -->
<!-- $$$resize[overload1]$$$resizeuintOptimization -->
<h3 class="fn"><a name="resize"></a><span class="type">bool</span> Q3MemArray::<span class="name">resize</span> ( <span class="type"><a href="qtglobal.html#uint-typedef">uint</a></span> <i>size</i>, <span class="type">Optimization</span> <i>optim</i> )</h3>
<p>Resizes (expands or shrinks) the array to <i>size</i> elements. The array becomes a null array if <i>size</i> == 0.</p>
<p>Returns TRUE if successful, or FALSE if the memory cannot be allocated.</p>
<p>New elements are not initialized.</p>
<p><i>optim</i> is either <tt>MemOptim</tt> (the default) or <tt>SpeedOptim</tt>. When optimizing for speed rather than memory consumption, the array uses a smart grow and shrink algorithm that might allocate more memory than is actually needed for <i>size</i> elements. This speeds up subsequent resize operations, for example when appending many elements to an array, since the space has already been allocated.</p>
<p><b>See also </b><a href="q3memarray.html#size">size</a>().</p>
<!-- @@@resize -->
<!-- $$$resize$$$resizeuint -->
<h3 class="fn"><a name="resize-2"></a><span class="type">bool</span> Q3MemArray::<span class="name">resize</span> ( <span class="type"><a href="qtglobal.html#uint-typedef">uint</a></span> <i>size</i> )</h3>
<p>This is an overloaded function.</p>
<p>Resizes (expands or shrinks) the array to <i>size</i> elements. The array becomes a null array if <i>size</i> == 0.</p>
<p>Returns TRUE if successful, i.e. if the memory can be allocated; otherwise returns FALSE.</p>
<p>New elements are not initialized.</p>
<p><b>See also </b><a href="q3memarray.html#size">size</a>().</p>
<!-- @@@resize -->
<!-- $$$setRawData[overload1]$$$setRawDataconsttype*uint -->
<h3 class="fn"><a name="setRawData"></a><span class="type">Q3MemArray</span><<span class="type">type</span>> & Q3MemArray::<span class="name">setRawData</span> ( const <span class="type">type</span> * <i>data</i>, <span class="type"><a href="qtglobal.html#uint-typedef">uint</a></span> <i>size</i> )</h3>
<p>Sets raw data and returns a reference to the array.</p>
<p>Dereferences the current array and sets the new array data to <i>data</i> and the new array size to <i>size</i>. Do not attempt to resize or re-assign the array data when raw data has been set. Call resetRawData(<i>data</i>, <i>size</i>) to reset the array.</p>
<p>Setting raw data is useful because it sets <a href="q3memarray.html" class="compat">Q3MemArray</a> data without allocating memory or copying data.</p>
<p>Example I (intended use):</p>
<pre class="cpp"> <span class="keyword">static</span> <span class="type">char</span> bindata<span class="operator">[</span><span class="operator">]</span> <span class="operator">=</span> { <span class="number">231</span><span class="operator">,</span> <span class="number">1</span><span class="operator">,</span> <span class="number">44</span><span class="operator">,</span> <span class="operator">.</span><span class="operator">.</span><span class="operator">.</span> };
<span class="type"><a href="qbytearray.html">QByteArray</a></span> a;
a<span class="operator">.</span>setRawData( bindata<span class="operator">,</span> <span class="keyword">sizeof</span>(bindata) ); <span class="comment">// a points to bindata</span>
<span class="type"><a href="qdatastream.html">QDataStream</a></span> s( a<span class="operator">,</span> IO_ReadOnly ); <span class="comment">// open on a's data</span>
s <span class="operator">></span><span class="operator">></span> <span class="operator"><</span>something<span class="operator">></span>; <span class="comment">// read raw bindata</span>
a<span class="operator">.</span><a href="q3memarray.html#resetRawData">resetRawData</a>( bindata<span class="operator">,</span> <span class="keyword">sizeof</span>(bindata) ); <span class="comment">// finished</span></pre>
<p>Example II (you don't want to do this):</p>
<pre class="cpp"> <span class="keyword">static</span> <span class="type">char</span> bindata<span class="operator">[</span><span class="operator">]</span> <span class="operator">=</span> { <span class="number">231</span><span class="operator">,</span> <span class="number">1</span><span class="operator">,</span> <span class="number">44</span><span class="operator">,</span> <span class="operator">.</span><span class="operator">.</span><span class="operator">.</span> };
<span class="type"><a href="qbytearray.html">QByteArray</a></span> a<span class="operator">,</span> b;
a<span class="operator">.</span>setRawData( bindata<span class="operator">,</span> <span class="keyword">sizeof</span>(bindata) ); <span class="comment">// a points to bindata</span>
a<span class="operator">.</span><a href="q3memarray.html#resize">resize</a>( <span class="number">8</span> ); <span class="comment">// will crash</span>
b <span class="operator">=</span> a; <span class="comment">// will crash</span>
a<span class="operator">[</span><span class="number">2</span><span class="operator">]</span> <span class="operator">=</span> <span class="number">123</span>; <span class="comment">// might crash</span>
<span class="comment">// forget to resetRawData: will crash</span></pre>
<p><b>Warning:</b> If you do not call <a href="q3memarray.html#resetRawData">resetRawData</a>(), <a href="q3memarray.html" class="compat">Q3MemArray</a> will attempt to deallocate or reallocate the raw data, which might not be too good. Be careful.</p>
<p><b>See also </b><a href="q3memarray.html#resetRawData">resetRawData</a>().</p>
<!-- @@@setRawData -->
<!-- $$$size[overload1]$$$size -->
<h3 class="fn"><a name="size"></a><span class="type"><a href="qtglobal.html#uint-typedef">uint</a></span> Q3MemArray::<span class="name">size</span> () const</h3>
<p>Returns the size of the array (maximum number of elements).</p>
<p>The array is a null array if size() == 0.</p>
<p><b>See also </b><a href="q3memarray.html#isNull">isNull</a>() and <a href="q3memarray.html#resize">resize</a>().</p>
<!-- @@@size -->
<!-- $$$sort[overload1]$$$sort -->
<h3 class="fn"><a name="sort"></a><span class="type">void</span> Q3MemArray::<span class="name">sort</span> ()</h3>
<p>Sorts the array elements in ascending order, using bitwise comparison (memcmp()).</p>
<p><b>See also </b><a href="q3memarray.html#bsearch">bsearch</a>().</p>
<!-- @@@sort -->
<!-- $$$truncate[overload1]$$$truncateuint -->
<h3 class="fn"><a name="truncate"></a><span class="type">bool</span> Q3MemArray::<span class="name">truncate</span> ( <span class="type"><a href="qtglobal.html#uint-typedef">uint</a></span> <i>pos</i> )</h3>
<p>Truncates the array at position <i>pos</i>.</p>
<p>Returns TRUE if successful, i.e. if the memory can be allocated; otherwise returns FALSE.</p>
<p>Equivalent to resize(<i>pos</i>).</p>
<p><b>See also </b><a href="q3memarray.html#resize">resize</a>().</p>
<!-- @@@truncate -->
<!-- $$$operator QVector<type>[overload1]$$$operator QVector<type> -->
<h3 class="fn"><a name="operator-QVector-lttype-gt"></a>Q3MemArray::<span class="name">operator QVector<type></span> () const</h3>
<p>Automatically converts the <a href="q3memarray.html" class="compat">Q3MemArray</a><type> into a <a href="qvector.html">QVector</a><type>.</p>
<!-- @@@operator QVector<type> -->
<!-- $$$operator const type *[overload1]$$$operator const type * -->
<h3 class="fn"><a name="operator-const-type--2a"></a>Q3MemArray::<span class="name">operator const type *</span> () const</h3>
<p>Cast operator. Returns a pointer to the array.</p>
<p><b>See also </b><a href="q3memarray.html#data">data</a>().</p>
<!-- @@@operator const type * -->
<!-- $$$operator!=[overload1]$$$operator!=constQ3MemArray<type>& -->
<h3 class="fn"><a name="operator-not-eq"></a><span class="type">bool</span> Q3MemArray::<span class="name">operator!=</span> ( const <span class="type">Q3MemArray</span><<span class="type">type</span>> & <i>a</i> ) const</h3>
<p>Returns TRUE if this array is different from <i>a</i>; otherwise returns FALSE.</p>
<p>The two arrays are compared bitwise.</p>
<p><b>See also </b><a href="q3memarray.html#operator-eq-eq">operator==</a>().</p>
<!-- @@@operator!= -->
<!-- $$$operator=[overload1]$$$operator=constQ3MemArray<type>& -->
<h3 class="fn"><a name="operator-eq"></a><span class="type">Q3MemArray</span><<span class="type">type</span>> & Q3MemArray::<span class="name">operator=</span> ( const <span class="type">Q3MemArray</span><<span class="type">type</span>> & <i>a</i> )</h3>
<p>Assigns a shallow copy of <i>a</i> to this array and returns a reference to this array.</p>
<p>Equivalent to assign( a ).</p>
<!-- @@@operator= -->
<!-- $$$operator==[overload1]$$$operator==constQ3MemArray<type>& -->
<h3 class="fn"><a name="operator-eq-eq"></a><span class="type">bool</span> Q3MemArray::<span class="name">operator==</span> ( const <span class="type">Q3MemArray</span><<span class="type">type</span>> & <i>a</i> ) const</h3>
<p>Returns TRUE if this array is equal to <i>a</i>; otherwise returns FALSE.</p>
<p>The two arrays are compared bitwise.</p>
<p><b>See also </b><a href="q3memarray.html#operator-not-eq">operator!=</a>().</p>
<!-- @@@operator== -->
<!-- $$$operator[][overload1]$$$operator[]int -->
<h3 class="fn"><a name="operator-5b-5d"></a><span class="type">type</span> & Q3MemArray::<span class="name">operator[]</span> ( <span class="type">int</span> <i>index</i> ) const</h3>
<p>Returns a reference to the element at position <i>index</i> in the array.</p>
<p>This can be used to both read and set an element. Equivalent to <a href="q3memarray.html#at">at</a>().</p>
<p><b>See also </b><a href="q3memarray.html#at">at</a>().</p>
<!-- @@@operator[] -->
</div>
<div class="ft">
<span></span>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2012 Nokia Corporation and/or its
subsidiaries. Documentation contributions included herein are the copyrights of
their respective owners.</p>
<br />
<p>
The documentation provided herein is licensed under the terms of the
<a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation
License version 1.3</a> as published by the Free Software Foundation.</p>
<p>
Documentation sources may be obtained from <a href="http://www.qt-project.org">
www.qt-project.org</a>.</p>
<br />
<p>
Nokia, Qt and their respective logos are trademarks of Nokia Corporation
in Finland and/or other countries worldwide. All other trademarks are property
of their respective owners. <a title="Privacy Policy"
href="http://en.gitorious.org/privacy_policy/">Privacy Policy</a></p>
</div>
</body>
</html>
|
