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
|
/*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
#ifndef __BLI_STACK_CXX_H__
#define __BLI_STACK_CXX_H__
/** \file
* \ingroup bli
*
* Basic stack implementation with support for small object optimization.
*/
#include "BLI_vector.h"
namespace BLI {
template<typename T, uint N = 4, typename Allocator = GuardedAllocator> class Stack {
private:
Vector<T, N, Allocator> m_elements;
public:
Stack() = default;
/**
* Construct a stack from an array ref. The elements will be pushed in the same order they are in
* the array.
*/
Stack(ArrayRef<T> values) : m_elements(values)
{
}
operator ArrayRef<T>()
{
return m_elements;
}
/**
* Return the number of elements in the stack.
*/
uint size() const
{
return m_elements.size();
}
/**
* Return true when the stack is empty, otherwise false.
*/
bool is_empty() const
{
return this->size() == 0;
}
/**
* Add a new element to the top of the stack.
*/
void push(const T &value)
{
m_elements.append(value);
}
void push(T &&value)
{
m_elements.append(std::move(value));
}
void push_multiple(ArrayRef<T> values)
{
m_elements.extend(values);
}
/**
* Remove the element from the top of the stack and return it.
* This will assert when the stack is empty.
*/
T pop()
{
return m_elements.pop_last();
}
/**
* Return a reference to the value a the top of the stack.
* This will assert when the stack is empty.
*/
T &peek()
{
BLI_assert(!this->is_empty());
return m_elements[this->size() - 1];
}
T *begin()
{
return m_elements.begin();
}
T *end()
{
return m_elements.end();
}
const T *begin() const
{
return m_elements.begin();
}
const T *end() const
{
return m_elements.end();
}
/**
* Remove all elements from the stack but keep the memory.
*/
void clear()
{
m_elements.clear();
}
/**
* Remove all elements and free any allocated memory.
*/
void clear_and_make_small()
{
m_elements.clear_and_make_small();
}
/**
* Does a linear search to check if the value is in the stack.
*/
bool contains(const T &value)
{
return m_elements.contains(value);
}
};
} /* namespace BLI */
#endif /* __BLI_STACK_CXX_H__ */
|
