this repo has no description
dekker.one
1/* -*- mode: C++; c-basic-offset: 2; indent-tabs-mode: nil -*- */
2/*
3 * Main authors:
4 * Christian Schulte <schulte@gecode.org>
5 *
6 * Copyright:
7 * Christian Schulte, 2002
8 *
9 * This file is part of Gecode, the generic constraint
10 * development environment:
11 * http://www.gecode.org
12 *
13 * Permission is hereby granted, free of charge, to any person obtaining
14 * a copy of this software and associated documentation files (the
15 * "Software"), to deal in the Software without restriction, including
16 * without limitation the rights to use, copy, modify, merge, publish,
17 * distribute, sublicense, and/or sell copies of the Software, and to
18 * permit persons to whom the Software is furnished to do so, subject to
19 * the following conditions:
20 *
21 * The above copyright notice and this permission notice shall be
22 * included in all copies or substantial portions of the Software.
23 *
24 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
25 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
26 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
27 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
28 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
29 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
30 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
31 *
32 */
33
34namespace Gecode { namespace Support {
35
36 /**
37 * \brief Stack with fixed number of elements
38 *
39 * \ingroup FuncSupport
40 */
41 template<class T, class A>
42 class StaticStack {
43 private:
44 /// Allocator
45 A& a;
46 /// Number of elements
47 int n;
48 /// Top of stack
49 unsigned int tos;
50 /// Stack space
51 T* stack;
52 public:
53 /// Initialize for \a n elements
54 StaticStack(A& a, int n);
55 /// Release memory
56 ~StaticStack(void);
57
58 /// Reset stack (pop all elements)
59 void reset(void);
60 /// Test whether stack is empty
61 bool empty(void) const;
62 /// Return number of entries currently on stack
63 int entries(void) const;
64
65 /// Pop topmost element from stack and return it
66 T pop(void);
67 /// Return element on top of stack
68 T& top(void) const;
69 /// Return element that has just been popped
70 T& last(void) const;
71 /// Push element \a x on top of stack
72 void push(const T& x);
73
74 /// Allocate memory from heap (disabled)
75 static void* operator new(size_t s) = delete;
76 /// Free memory allocated from heap (disabled)
77 static void operator delete(void* p) = delete;
78 /// Copy constructor (disabled)
79 StaticStack(const StaticStack& s) = delete;
80 /// Assignment operator (disabled)
81 const StaticStack& operator =(const StaticStack&) = delete;
82 };
83
84 template<class T, class A>
85 forceinline
86 StaticStack<T,A>::StaticStack(A& a0, int n0)
87 : a(a0), n(n0), tos(0), stack(a.template alloc<T>(n)) {}
88
89 template<class T, class A>
90 forceinline
91 StaticStack<T,A>::~StaticStack(void) {
92 a.free(stack,n);
93 }
94
95 template<class T, class A>
96 forceinline bool
97 StaticStack<T,A>::empty(void) const {
98 return tos==0;
99 }
100
101 template<class T, class A>
102 forceinline int
103 StaticStack<T,A>::entries(void) const {
104 return tos;
105 }
106
107 template<class T, class A>
108 forceinline void
109 StaticStack<T,A>::reset(void) {
110 tos = 0;
111 }
112
113 template<class T, class A>
114 forceinline T
115 StaticStack<T,A>::pop(void) {
116 assert((tos > 0) && (tos <= static_cast<unsigned int>(n)));
117 return stack[--tos];
118 }
119
120 template<class T, class A>
121 forceinline T&
122 StaticStack<T,A>::top(void) const {
123 assert((tos > 0) && (tos <= static_cast<unsigned int>(n)));
124 return stack[tos-1];
125 }
126
127 template<class T, class A>
128 forceinline T&
129 StaticStack<T,A>::last(void) const {
130 assert((tos >= 0) && (tos < static_cast<unsigned int>(n)));
131 return stack[tos];
132 }
133
134 template<class T, class A>
135 forceinline void
136 StaticStack<T,A>::push(const T& x) {
137 assert(tos < static_cast<unsigned int>(n));
138 stack[tos++] = x;
139 }
140
141}}
142
143// STATISTICS: support-any