this repo has no description
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 arbitrary number of elements
38 *
39 * \ingroup FuncSupport
40 */
41 template<class T, class A>
42 class DynamicStack {
43 private:
44 /// Memory allocator
45 A& a;
46 /// Current size of the stack
47 int limit;
48 /// Top of stack
49 int tos;
50 /// Elements on stack
51 T* stack;
52 /// Resize stack (increase size)
53 void resize(void);
54 public:
55 /// Initialize stack with \a n elements
56 DynamicStack(A& a, int n=64);
57 /// Release memory
58 ~DynamicStack(void);
59
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
75 /** \brief Return entry at position \a i
76 *
77 * Position 0 corresponds to the element first pushed,
78 * whereas position \c entries()-1 corresponds to the
79 * element pushed last.
80 */
81 T& operator [](int i);
82 /** \brief Return entry at position \a i
83 *
84 * Position 0 corresponds to the element first pushed,
85 * whereas position \c entries()-1 corresponds to the
86 * element pushed last.
87 */
88 const T& operator [](int i) const;
89
90 /// Allocate memory from heap (disabled)
91 static void* operator new(size_t s) = delete;
92 /// Free memory allocated from heap (disabled)
93 static void operator delete(void* p) = delete;
94 /// Copy constructor (disabled)
95 DynamicStack(const DynamicStack& s) = delete;
96 /// Assignment operator (disabled)
97 const DynamicStack& operator =(const DynamicStack&) = delete;
98 };
99
100
101 template<class T, class A>
102 void
103 DynamicStack<T,A>::resize(void) {
104 int nl = (limit * 3) / 2;
105 stack = a.template realloc<T>(stack,limit,nl);
106 limit = nl;
107 }
108
109 template<class T, class A>
110 forceinline
111 DynamicStack<T,A>::DynamicStack(A& a0, int n)
112 : a(a0), limit(n), tos(0), stack(a.template alloc<T>(n)) {}
113
114 template<class T, class A>
115 forceinline
116 DynamicStack<T,A>::~DynamicStack(void) {
117 a.free(stack,limit);
118 }
119
120 template<class T, class A>
121 forceinline T
122 DynamicStack<T,A>::pop(void) {
123 return stack[--tos];
124 }
125
126 template<class T, class A>
127 forceinline T&
128 DynamicStack<T,A>::top(void) const {
129 return stack[tos-1];
130 }
131
132 template<class T, class A>
133 forceinline T&
134 DynamicStack<T,A>::last(void) const {
135 return stack[tos];
136 }
137
138 template<class T, class A>
139 forceinline void
140 DynamicStack<T,A>::push(const T& x) {
141 stack[tos++] = x;
142 if (tos==limit)
143 resize();
144 }
145
146 template<class T, class A>
147 forceinline bool
148 DynamicStack<T,A>::empty(void) const {
149 return tos==0;
150 }
151
152 template<class T, class A>
153 forceinline int
154 DynamicStack<T,A>::entries(void) const {
155 return tos;
156 }
157
158 template<class T, class A>
159 forceinline T&
160 DynamicStack<T,A>::operator [](int i) {
161 return stack[i];
162 }
163
164 template<class T, class A>
165 forceinline const T&
166 DynamicStack<T,A>::operator [](int i) const {
167 return stack[i];
168 }
169
170}}
171
172// STATISTICS: support-any