Coin: SbHeap.h Source File

| Coin3D is Free Software, published under the BSD 3-clause license. | https://coin3d.github.io https://www.kongsberg.com/en/kogt/

SbHeap.h
1#ifndef COIN_SBHEAP_H
2#define COIN_SBHEAP_H
3
4/**************************************************************************\
5 * Copyright (c) Kongsberg Oil & Gas Technologies AS
6 * All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions are
10 * met:
11 *
12 * Redistributions of source code must retain the above copyright notice,
13 * this list of conditions and the following disclaimer.
14 *
15 * Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 *
19 * Neither the name of the copyright holder nor the names of its
20 * contributors may be used to endorse or promote products derived from
21 * this software without specific prior written permission.
22 *
23 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
25 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
26 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
27 * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
28 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
29 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
30 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
31 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
32 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34\**************************************************************************/
35
36#include <Inventor/SbBasic.h>
37#include <Inventor/lists/SbList.h>
38#include <cstddef>
39
40 typedef struct
41{
42 float (*eval_func)(void*);
43 int (*get_index_func)(void*);
44 void (*set_index_func)(void*, int);
45} SbHeapFuncs;
46
47 class COIN_DLL_API SbHeap {
48public:
49 SbHeap(const SbHeapFuncs &SbHeapFuncs,
50 const int initsize = 1024);
51 ~SbHeap();
52
53 void emptyHeap(void);
54 int size(void) const;
55 int add(void *obj);
56 void remove(const int pos);
57 void remove(void *obj);
58 void *extractMin();
59 void *getMin();
60 void *operator[](const int idx);
61
62 void newWeight(void *obj, int hpos = -1);
63 SbBool buildHeap(SbBool (*progresscb)(float percentage, void *data) = NULL,
64 void *data = NULL);
65 SbBool traverseHeap(SbBool (*func)(void *, void *), void *userdata) const;
66
67private:
68 SbHeapFuncs funcs;
69 SbList <void*> heap;
70
71 int heapInsert(void *obj);
72 void *heapExtractMin(void);
73 void heapReserve(const int newsize);
74 void heapify(const int idx);
75};
76
77#endif // !COIN_SBHEAP_H
SbHeap
The SbHeap class is a generic heap class.
Definition SbHeap.h:47
SbHeapFuncs
The SbHeapFuncs struct is used to specify functions on heap elements.
Definition SbHeap.h:41