File: LinearStack.h

package info (click to toggle)
intel-graphics-compiler 1.0.12504.6-1%2Bdeb12u1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 83,912 kB
  • sloc: cpp: 910,147; lisp: 202,655; ansic: 15,197; python: 4,025; yacc: 2,241; lex: 1,570; pascal: 244; sh: 104; makefile: 25
file content (315 lines) | stat: -rw-r--r-- 6,980 bytes parent folder | download | duplicates (3)
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
/*========================== begin_copyright_notice ============================

Copyright (C) 2019-2021 Intel Corporation

SPDX-License-Identifier: MIT

============================= end_copyright_notice ===========================*/

#pragma once

#include "Array.h"

namespace iSTD
{

/*****************************************************************************\
Struct: IsLinearStackTypeSupported
\*****************************************************************************/
template<typename T> 
struct IsLinearStackTypeSupported                    { enum { value = false }; };

template<> 
struct IsLinearStackTypeSupported<bool>              { enum { value = true }; };

template<> 
struct IsLinearStackTypeSupported<char>              { enum { value = true }; };

template<> 
struct IsLinearStackTypeSupported<unsigned char>     { enum { value = true }; };

template<> 
struct IsLinearStackTypeSupported<int>               { enum { value = true }; };

template<> 
struct IsLinearStackTypeSupported<unsigned int>      { enum { value = true }; };

#ifndef __LP64__ // u/long on linux64 platform is 64-bit type and collides with U/INT64
template<> 
struct IsLinearStackTypeSupported<long>              { enum { value = true }; };

template<> 
struct IsLinearStackTypeSupported<unsigned long>     { enum { value = true }; };
#endif

template<> 
struct IsLinearStackTypeSupported<float>             { enum { value = true }; };

template<> 
struct IsLinearStackTypeSupported<INT64>             { enum { value = true }; };

template<> 
struct IsLinearStackTypeSupported<UINT64>            { enum { value = true }; };

template<typename T> 
struct IsLinearStackTypeSupported<T*>                { enum { value = true }; };

/*****************************************************************************\
Template Parameters
\*****************************************************************************/
#define LinearStackTemplateList   class Type, class CAllocatorType
#define CLinearStackType          CLinearStack<Type,CAllocatorType>

/*****************************************************************************\

Class:
    CLinearStack

Description:
    Implements an array-based stack

\*****************************************************************************/
template<LinearStackTemplateList>
class CLinearStack : public CObject<CAllocatorType>
{
public:

    CLinearStack( const DWORD size );
    virtual ~CLinearStack( void );

    bool    IsEmpty( void ) const;
    DWORD   GetCount( void ) const;

    bool    Push( const Type element );
    Type    Pop( void );
    Type    Top( void ) const;

    void    Reset( void );

    void    DebugPrint( void ) const;

protected:

    CDynamicArray<Type,CAllocatorType> m_ElementArray;
    DWORD   m_Count;
};

/*****************************************************************************\

Function:
    CLinearStack Constructor

Description:
    Initializes internal data

Input:
    const DWORD size - initial size of the stack

Output:
    none

\*****************************************************************************/
template<LinearStackTemplateList>
CLinearStackType::CLinearStack( const DWORD size )
    : CObject<CAllocatorType>(),
    m_ElementArray( size )
{
    m_Count = 0;
}

/*****************************************************************************\

Function:
    CLinearStack Destructor

Description:
    Deletes internal data

Input:
    none

Output:
    none

\*****************************************************************************/
template<LinearStackTemplateList>
CLinearStackType::~CLinearStack( void )
{
}

/*****************************************************************************\

Function:
    CLinearStack::IsEmpty

Description:
    Returns if the stack is empty

Input:
    none

Output:
    bool - true or false

\*****************************************************************************/
template<LinearStackTemplateList>
bool CLinearStackType::IsEmpty( void ) const
{
    return m_Count == 0;
}

/*****************************************************************************\

Function:
    CLinearStack::GetCount

Description:
    Returns the number of elements in the stack

Input:
    none

Output:
    DWORD - number of elements

\*****************************************************************************/
template<LinearStackTemplateList>
DWORD CLinearStackType::GetCount( void ) const
{
    return m_Count;
}

/*****************************************************************************\

Function:
    CLinearStack::Push

Description:
    Pushes an element on the stack

Input:
    const Type element

Output:
    bool - success or fail

\*****************************************************************************/
template<LinearStackTemplateList>
bool CLinearStackType::Push( const Type element )
{
    // Add element to the end of list
    return m_ElementArray.SetElement( m_Count++, element );
}

/*****************************************************************************\

Function:
    CLinearStack::Pop

Description:
    Pops an element off the stack

Input:
    none

Output:
    Type - element

\*****************************************************************************/
template<LinearStackTemplateList>
Type CLinearStackType::Pop( void )
{
    Type element = (Type)0;

    if( IsEmpty() )
    {
        ASSERT(0);
    }
    else
    {
        // Get the last element on the list and
        // remove the last element
        element = m_ElementArray.GetElement( --m_Count );
    }

    return element;
}

/*****************************************************************************\

Function:
    CLinearStack::Top

Description:
    Returns the top element of the stack

Input:
    none

Output:
    Type - element

\*****************************************************************************/
template<LinearStackTemplateList>
Type CLinearStackType::Top( void ) const
{
    Type element = (Type)0;

    if( IsEmpty() )
    {
        ASSERT(0);
    }
    else
    {
        // Get the last element on the list
        element = m_ElementArray.GetElement( m_Count-1 );
    }

    return element;
}

/*****************************************************************************\

Function:
    CLinearStack::Reset

Description:
    Resets the stack

Input:
    none

Output:
    none

\*****************************************************************************/
template<LinearStackTemplateList>
void CLinearStackType::Reset( void )
{
    m_Count = 0;
}

/*****************************************************************************\

Function:
    CLinearStack::DebugPrint

Description:
    Prints the stack to std output for debug only

Input:
    none

Output:
    none

\*****************************************************************************/
template<LinearStackTemplateList>
void CLinearStackType::DebugPrint( void ) const
{
#ifdef _DEBUG
    m_ElementArray.DebugPrint();
#endif
}

} // iSTD