File: dgHeap.h

package info (click to toggle)
scummvm 2.9.1%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 450,580 kB
  • sloc: cpp: 4,299,825; asm: 28,322; python: 12,901; sh: 11,302; java: 9,289; xml: 7,895; perl: 2,639; ansic: 2,465; yacc: 1,670; javascript: 1,020; makefile: 933; lex: 578; awk: 275; objc: 82; sed: 11; php: 1
file content (513 lines) | stat: -rw-r--r-- 14,682 bytes parent folder | download | duplicates (2)
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
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
/* Copyright (c) <2003-2011> <Julio Jerez, Newton Game Dynamics>
*
* This software is provided 'as-is', without any express or implied
* warranty. In no event will the authors be held liable for any damages
* arising from the use of this software.
*
* Permission is granted to anyone to use this software for any purpose,
* including commercial applications, and to alter it and redistribute it
* freely, subject to the following restrictions:
*
* 1. The origin of this software must not be misrepresented; you must not
* claim that you wrote the original software. If you use this software
* in a product, an acknowledgment in the product documentation would be
* appreciated but is not required.
*
* 2. Altered source versions must be plainly marked as such, and must not be
* misrepresented as being the original software.
*
* 3. This notice may not be removed or altered from any source distribution.
*/

/****************************************************************************
*
*  Visual C++ 6.0 created by: Julio Jerez
*
****************************************************************************/
#ifndef __dgHeapBase__
#define __dgHeapBase__

#include "dgStdafx.h"
#include "dgMemory.h"

#include "common/util.h"


//#define DG_HEAP_SANITY_CHECK

template <class OBJECT, class KEY>
class dgHeapBase {
protected:
	struct RECORD {
		KEY m_key;
		OBJECT m_obj;

		RECORD(KEY key, const OBJECT &obj)
			: m_key(key), m_obj(obj) {
		}
	};

	dgHeapBase(dgInt32 maxElements, dgMemoryAllocator *const allocator);
	dgHeapBase(const void *const buffer, dgInt32 sizeInBytes);
	~dgHeapBase();

public:
	DG_CLASS_ALLOCATOR(allocator)

	void Flush();
	KEY MaxValue() const;
	KEY Value(dgInt32 i = 0) const;
	dgInt32 GetCount() const;
	dgInt32 GetMaxCount() const;
	const OBJECT &operator[](dgInt32 i) const;
	OBJECT &operator[](dgInt32 i);
	dgInt32 Find(OBJECT &obj);
	dgInt32 Find(KEY key);

	dgInt32 m_curCount;
	dgInt32 m_maxCount;
//	bool m_allocated;
	dgMemoryAllocator *m_allocator;
	RECORD *m_pool;
};

template <class OBJECT, class KEY>
class dgDownHeap: public dgHeapBase<OBJECT, KEY> {
public:
	dgDownHeap(dgInt32 maxElements, dgMemoryAllocator *const allocator);
	dgDownHeap(const void *const buffer, dgInt32 sizeInBytes);

	void Pop();
	void Push(OBJECT &obj, KEY key);
	void Sort();
	void Remove(dgInt32 Index);

#ifdef DG_HEAP_SANITY_CHECK
	bool SanityCheck();
#endif
};

template <class OBJECT, class KEY>
class dgUpHeap: public dgHeapBase<OBJECT, KEY> {
public:
	dgUpHeap(dgInt32 maxElements, dgMemoryAllocator *const allocator);
	dgUpHeap(const void *const buffer, dgInt32 sizeInBytes);

	void Pop();
	void Push(OBJECT &obj, KEY key);
	void Sort();
	void Remove(dgInt32 Index);

#ifdef DG_HEAP_SANITY_CHECK
	bool SanityCheck();
#endif
};



template <class OBJECT, class KEY>
dgHeapBase<OBJECT, KEY>::dgHeapBase(dgInt32 maxElements, dgMemoryAllocator *const allocator) {
//	m_allocated = true;
	m_allocator = allocator;
	m_pool = (RECORD *)m_allocator->Malloc(maxElements * sizeof(RECORD));
	m_maxCount = maxElements;
	Flush();
}

template <class OBJECT, class KEY>
dgHeapBase<OBJECT, KEY>::dgHeapBase(const void *const buffer, dgInt32 sizeInBytes) {
//	NEWTON_ASSERT (0);
//	m_allocated = false;
	m_allocator = NULL;
	m_pool = const_cast<RECORD *>((const RECORD *)buffer);
	m_maxCount = dgInt32(sizeInBytes / sizeof(RECORD));
	Flush();
}

template <class OBJECT, class KEY>
dgHeapBase<OBJECT, KEY>::~dgHeapBase() {
	if (m_allocator) {
		m_allocator->Free(m_pool);
	}
}


template <class OBJECT, class KEY>
KEY dgHeapBase<OBJECT, KEY>::Value(dgInt32 i) const {
	return m_pool[i].m_key;
}


template <class OBJECT, class KEY>
dgInt32 dgHeapBase<OBJECT, KEY>::GetCount() const {
	return m_curCount;
}


template <class OBJECT, class KEY>
void dgHeapBase<OBJECT, KEY>::Flush() {
	m_curCount = 0;

#ifdef _DEBUG
//	dgHeapBase<OBJECT,KEY>::m_pool[dgHeapBase<OBJECT,KEY>::m_curCount].m_key = KEY (0);
#endif
}


template <class OBJECT, class KEY>
KEY dgHeapBase<OBJECT, KEY>::MaxValue() const {
	return m_pool[0].m_key;
}


template <class OBJECT, class KEY>
dgInt32 dgHeapBase<OBJECT, KEY>::GetMaxCount() const {
	return m_maxCount;
}


template <class OBJECT, class KEY>
dgInt32 dgHeapBase<OBJECT, KEY>::Find(OBJECT &obj) {
	// For now let perform a linear search
	// this is efficient if the size of the heap is small
	// ex: m_curCount < 32
	// this will be change to a binary search in the heap should the
	// the size of the heap get larger than 32
	//  NEWTON_ASSERT (m_curCount <= 32);
	for (dgInt32 i = 0; i < m_curCount; i ++) {
		if (m_pool[i].obj == obj) {
			return i;
		}
	}
	return - 1;
}


template <class OBJECT, class KEY>
dgInt32 dgHeapBase<OBJECT, KEY>::Find(KEY key) {
	// ex: m_curCount < 32
	// this will be change to a binary search in the heap shoud the
	// the size of the heap get larger than 32
	NEWTON_ASSERT(m_curCount <= 32);
	for (dgInt32 i = 0; i < m_curCount; i ++)   {
		if (m_pool[i].m_key == key) {
			return i;
		}
	}
	return - 1;
}


template <class OBJECT, class KEY>
const OBJECT &dgHeapBase<OBJECT, KEY>::operator[](dgInt32 i) const {
	NEWTON_ASSERT(i <= m_curCount);
	return m_pool[i].m_obj;
}

template <class OBJECT, class KEY>
OBJECT &dgHeapBase<OBJECT, KEY>::operator[](dgInt32 i) {
	NEWTON_ASSERT(i <= m_curCount);
	return m_pool[i].m_obj;
}


// **************************************************************************
//
// down Heap
//
// **************************************************************************
template <class OBJECT, class KEY>
dgDownHeap<OBJECT, KEY>::dgDownHeap(dgInt32 maxElements, dgMemoryAllocator *const allocator)
	: dgHeapBase<OBJECT, KEY> (maxElements, allocator) {
}

template <class OBJECT, class KEY>
dgDownHeap<OBJECT, KEY>::dgDownHeap(const void *const buffer, dgInt32 sizeInBytes)
	: dgHeapBase<OBJECT, KEY> (buffer, sizeInBytes) {
}


template <class OBJECT, class KEY>
void dgDownHeap<OBJECT, KEY>::Push(OBJECT &obj, KEY key) {
	dgInt32 i;
	dgInt32 j;
#ifdef _DEBUG
//	NEWTON_ASSERT (m_curCount < m_maxCount);
	dgInt32 cc = dgHeapBase<OBJECT, KEY>::m_curCount;
	dgInt32 cm = dgHeapBase<OBJECT, KEY>::m_maxCount;
	NEWTON_ASSERT(cc < cm);
#endif

	dgHeapBase<OBJECT, KEY>::m_curCount ++;

	for (i = dgHeapBase<OBJECT, KEY>::m_curCount; i; i = j) {
		j = i >> 1;
		if (!j || (dgHeapBase<OBJECT, KEY>::m_pool[j - 1].m_key > key)) {
			break;
		}
		dgHeapBase<OBJECT, KEY>::m_pool[i - 1] = dgHeapBase<OBJECT, KEY>::m_pool[j - 1];
	}
	NEWTON_ASSERT(i);
	dgHeapBase<OBJECT, KEY>::m_pool[i - 1].m_key = key;
	dgHeapBase<OBJECT, KEY>::m_pool[i - 1].m_obj = obj;

#ifdef DG_HEAP_SANITY_CHECK
	NEWTON_ASSERT(SanityCheck());
#endif
}


template <class OBJECT, class KEY>
void dgDownHeap<OBJECT, KEY>::Remove(dgInt32 index) {
	dgInt32 j;
	dgInt32 k;

	dgHeapBase<OBJECT, KEY>::m_curCount--;
	KEY key(dgHeapBase<OBJECT, KEY>::m_pool[dgHeapBase<OBJECT, KEY>::m_curCount].m_key);
	for (k = index + 1; k <= (dgHeapBase<OBJECT, KEY>::m_curCount >> 1); k = j) {
		j = k + k;
		if ((j < dgHeapBase<OBJECT, KEY>::m_curCount) &&
		        (dgHeapBase<OBJECT, KEY>::m_pool[j - 1].m_key < dgHeapBase<OBJECT, KEY>::m_pool[j].m_key)) {
			j ++;
		}
		if (key >= dgHeapBase<OBJECT, KEY>::m_pool[j - 1].m_key) {
			break;
		}
		dgHeapBase<OBJECT, KEY>::m_pool[k - 1] = dgHeapBase<OBJECT, KEY>::m_pool[j - 1];
	}
	dgHeapBase<OBJECT, KEY>::m_pool[k - 1].m_key = key;
	dgHeapBase<OBJECT, KEY>::m_pool[k - 1].m_obj = dgHeapBase<OBJECT, KEY>::m_pool[dgHeapBase<OBJECT, KEY>::m_curCount].m_obj;

#ifdef DG_HEAP_SANITY_CHECK
	NEWTON_ASSERT(SanityCheck());
#endif

}

template <class OBJECT, class KEY>
void dgDownHeap<OBJECT, KEY>::Pop() {
	dgInt32 j;
	dgInt32 k;

	dgHeapBase<OBJECT, KEY>::m_curCount--;
	KEY key(dgHeapBase<OBJECT, KEY>::m_pool[dgHeapBase<OBJECT, KEY>::m_curCount].m_key);
	for (k = 1; k <= (dgHeapBase<OBJECT, KEY>::m_curCount >> 1); k = j) {
		j = k + k;
		if ((j < dgHeapBase<OBJECT, KEY>::m_curCount) &&
		        (dgHeapBase<OBJECT, KEY>::m_pool[j - 1].m_key < dgHeapBase<OBJECT, KEY>::m_pool[j].m_key)) {
			j ++;
		}
		if (key >= dgHeapBase<OBJECT, KEY>::m_pool[j - 1].m_key) {
			break;
		}
		dgHeapBase<OBJECT, KEY>::m_pool[k - 1] = dgHeapBase<OBJECT, KEY>::m_pool[j - 1];
	}
	dgHeapBase<OBJECT, KEY>::m_pool[k - 1].m_key = key;
	dgHeapBase<OBJECT, KEY>::m_pool[k - 1].m_obj = dgHeapBase<OBJECT, KEY>::m_pool[dgHeapBase<OBJECT, KEY>::m_curCount].m_obj;

#ifdef DG_HEAP_SANITY_CHECK
	NEWTON_ASSERT(SanityCheck());
#endif
}



template <class OBJECT, class KEY>
void dgDownHeap<OBJECT, KEY>::Sort() {

	dgInt32 count = dgHeapBase<OBJECT, KEY>::m_curCount;
	for (dgInt32 i = 1; i < count; i ++) {
		KEY key(dgHeapBase<OBJECT, KEY>::m_pool[0].m_key);
		OBJECT obj(dgHeapBase<OBJECT, KEY>::m_pool[0].m_obj);

		Pop();

		dgHeapBase<OBJECT, KEY>::m_pool[dgHeapBase<OBJECT, KEY>::m_curCount].m_key = key;
		dgHeapBase<OBJECT, KEY>::m_pool[dgHeapBase<OBJECT, KEY>::m_curCount].m_obj = obj;
	}

	dgHeapBase<OBJECT, KEY>::m_curCount = count;
	for (dgInt32 i = 0; i < count / 2; i ++) {
		KEY key(dgHeapBase<OBJECT, KEY>::m_pool[i].m_key);
		OBJECT obj(dgHeapBase<OBJECT, KEY>::m_pool[i].m_obj);

		dgHeapBase<OBJECT, KEY>::m_pool[i].m_key = dgHeapBase<OBJECT, KEY>::m_pool[count - i - 1].m_key;
		dgHeapBase<OBJECT, KEY>::m_pool[i].m_obj = dgHeapBase<OBJECT, KEY>::m_pool[count - i - 1].m_obj;

		dgHeapBase<OBJECT, KEY>::m_pool[count - i - 1].m_key = key;
		dgHeapBase<OBJECT, KEY>::m_pool[count - i - 1].m_obj = obj;
	}
#ifdef DG_HEAP_SANITY_CHECK
	NEWTON_ASSERT(SanityCheck());
#endif
}

#ifdef DG_HEAP_SANITY_CHECK
template <class OBJECT, class KEY>
bool dgDownHeap<OBJECT, KEY>::SanityCheck() {
	for (dgInt32 i = 0; i < dgHeapBase<OBJECT, KEY>::m_curCount / 2; i ++) {
		if (dgHeapBase<OBJECT, KEY>::m_pool[i].m_key < dgHeapBase<OBJECT, KEY>::m_pool[i * 2 + 1].m_key) {
			return false;
		}
		if ((i * 2 + 2) < dgHeapBase<OBJECT, KEY>::m_curCount) {
			if (dgHeapBase<OBJECT, KEY>::m_pool[i].m_key < dgHeapBase<OBJECT, KEY>::m_pool[i * 2 + 2].m_key) {
				return false;
			}
		}
	}

	return true;
}
#endif




// **************************************************************************
//
// down Heap
//
// **************************************************************************
template <class OBJECT, class KEY>
dgUpHeap<OBJECT, KEY>::dgUpHeap(dgInt32 maxElements, dgMemoryAllocator *const allocator)
	: dgHeapBase<OBJECT, KEY> (maxElements, allocator) {
}

template <class OBJECT, class KEY>
dgUpHeap<OBJECT, KEY>::dgUpHeap(const void *const buffer, dgInt32 sizeInBytes)
	: dgHeapBase<OBJECT, KEY> (buffer, sizeInBytes) {
}

#ifdef DG_HEAP_SANITY_CHECK
template <class OBJECT, class KEY>
bool dgUpHeap<OBJECT, KEY>::SanityCheck() {
	for (dgInt32 i = 0; i < dgHeapBase<OBJECT, KEY>::m_curCount / 2; i ++) {
		if (dgHeapBase<OBJECT, KEY>::m_pool[i].m_key > dgHeapBase<OBJECT, KEY>::m_pool[i * 2 + 1].m_key) {
			return false;
		}
		if ((i * 2 + 2) < dgHeapBase<OBJECT, KEY>::m_curCount) {
			if (dgHeapBase<OBJECT, KEY>::m_pool[i].m_key > dgHeapBase<OBJECT, KEY>::m_pool[i * 2 + 2].m_key) {
				return false;
			}
		}
	}

	return true;
}
#endif

template <class OBJECT, class KEY>
void dgUpHeap<OBJECT, KEY>::Push(OBJECT &obj, KEY key) {
	dgInt32 i;
	dgInt32 j;

#ifdef _DEBUG
	//  NEWTON_ASSERT (m_curCount < m_maxCount);
	dgInt32 cc = dgHeapBase<OBJECT, KEY>::m_curCount;
	dgInt32 cm = dgHeapBase<OBJECT, KEY>::m_maxCount;
	NEWTON_ASSERT(cc < cm);
#endif
	dgHeapBase<OBJECT, KEY>::m_curCount ++;

	for (i = dgHeapBase<OBJECT, KEY>::m_curCount; i; i = j) {
		j = i >> 1;
		if (!j || (dgHeapBase<OBJECT, KEY>::m_pool[j - 1].m_key < key)) {
			break;
		}
		dgHeapBase<OBJECT, KEY>::m_pool[i - 1] = dgHeapBase<OBJECT, KEY>::m_pool[j - 1];
	}
	NEWTON_ASSERT(i);
	dgHeapBase<OBJECT, KEY>::m_pool[i - 1].m_key = key;
	dgHeapBase<OBJECT, KEY>::m_pool[i - 1].m_obj = obj;

#ifdef DG_HEAP_SANITY_CHECK
	NEWTON_ASSERT(SanityCheck());
#endif
}


template <class OBJECT, class KEY>
void dgUpHeap<OBJECT, KEY>::Sort() {
	dgInt32 count = dgHeapBase<OBJECT, KEY>::m_curCount;
	for (dgInt32 i = 1; i < count; i ++) {
		KEY key(dgHeapBase<OBJECT, KEY>::m_pool[0].m_key);
		OBJECT obj(dgHeapBase<OBJECT, KEY>::m_pool[0].m_obj);

		Pop();

		dgHeapBase<OBJECT, KEY>::m_pool[dgHeapBase<OBJECT, KEY>::m_curCount].m_key = key;
		dgHeapBase<OBJECT, KEY>::m_pool[dgHeapBase<OBJECT, KEY>::m_curCount].m_obj = obj;
	}

	dgHeapBase<OBJECT, KEY>::m_curCount = count;
	for (dgInt32 i = 0; i < count / 2; i ++) {
		KEY key(dgHeapBase<OBJECT, KEY>::m_pool[i].m_key);
		OBJECT obj(dgHeapBase<OBJECT, KEY>::m_pool[i].m_obj);

		dgHeapBase<OBJECT, KEY>::m_pool[i].m_key = dgHeapBase<OBJECT, KEY>::m_pool[count - i - 1].m_key;
		dgHeapBase<OBJECT, KEY>::m_pool[i].m_obj = dgHeapBase<OBJECT, KEY>::m_pool[count - i - 1].m_obj;

		dgHeapBase<OBJECT, KEY>::m_pool[count - i - 1].m_key = key;
		dgHeapBase<OBJECT, KEY>::m_pool[count - i - 1].m_obj = obj;
	}
#ifdef DG_HEAP_SANITY_CHECK
	NEWTON_ASSERT(SanityCheck());
#endif
}


template <class OBJECT, class KEY>
void dgUpHeap<OBJECT, KEY>::Remove(dgInt32 index) {
	dgInt32 j;
	dgInt32 k;

	dgHeapBase<OBJECT, KEY>::m_curCount--;
	KEY key(dgHeapBase<OBJECT, KEY>::m_pool[dgHeapBase<OBJECT, KEY>::m_curCount].m_key);
	for (k = index + 1; k <= (dgHeapBase<OBJECT, KEY>::m_curCount >> 1); k = j) {
		j = k + k;
		if ((j < dgHeapBase<OBJECT, KEY>::m_curCount) &&
		        (dgHeapBase<OBJECT, KEY>::m_pool[j - 1].m_key > dgHeapBase<OBJECT, KEY>::m_pool[j].m_key)) {
			j ++;
		}
		if (key <= dgHeapBase<OBJECT, KEY>::m_pool[j - 1].m_key) {
			break;
		}
		dgHeapBase<OBJECT, KEY>::m_pool[k - 1] = dgHeapBase<OBJECT, KEY>::m_pool[j - 1];
	}
	dgHeapBase<OBJECT, KEY>::m_pool[k - 1].m_key = key;
	dgHeapBase<OBJECT, KEY>::m_pool[k - 1].m_obj = dgHeapBase<OBJECT, KEY>::m_pool[dgHeapBase<OBJECT, KEY>::m_curCount].m_obj;

#ifdef DG_HEAP_SANITY_CHECK
	NEWTON_ASSERT(SanityCheck());
#endif
}


template <class OBJECT, class KEY>
void dgUpHeap<OBJECT, KEY>::Pop() {
	dgInt32 j;
	dgInt32 k;

	dgHeapBase<OBJECT, KEY>::m_curCount--;
	KEY key(dgHeapBase<OBJECT, KEY>::m_pool[dgHeapBase<OBJECT, KEY>::m_curCount].m_key);
	for (k = 1; k <= (dgHeapBase<OBJECT, KEY>::m_curCount >> 1); k = j) {
		j = k + k;
		if ((j < dgHeapBase<OBJECT, KEY>::m_curCount) &&
		        (dgHeapBase<OBJECT, KEY>::m_pool[j - 1].m_key > dgHeapBase<OBJECT, KEY>::m_pool[j].m_key)) {
			j ++;
		}
		if (key <= dgHeapBase<OBJECT, KEY>::m_pool[j - 1].m_key) {
			break;
		}
		dgHeapBase<OBJECT, KEY>::m_pool[k - 1] = dgHeapBase<OBJECT, KEY>::m_pool[j - 1];
	}
	dgHeapBase<OBJECT, KEY>::m_pool[k - 1].m_key = key;
	dgHeapBase<OBJECT, KEY>::m_pool[k - 1].m_obj = dgHeapBase<OBJECT, KEY>::m_pool[dgHeapBase<OBJECT, KEY>::m_curCount].m_obj;

#ifdef DG_HEAP_SANITY_CHECK
	NEWTON_ASSERT(SanityCheck());
#endif
}


#endif