static-stack.hpp
Go to the documentation of this file.
/* -*- mode: C++; c-basic-offset: 2; indent-tabs-mode: nil -*- */
/*
* Main authors:
* Christian Schulte <schulte@gecode.org>
*
* Copyright:
* Christian Schulte, 2002
*
* This file is part of Gecode, the generic constraint
* development environment:
* http://www.gecode.org
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
* LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
* OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
* WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*
*/
namespace Gecode { namespace Support {
template<class T, class A>
class StaticStack {
private:
A& a;
int n;
unsigned int tos;
T* stack;
public:
StaticStack(A& a, int n);
~StaticStack(void);
void reset(void);
bool empty(void) const;
int entries(void) const;
T pop(void);
T& top(void) const;
T& last(void) const;
void push(const T& x);
private:
static void* operator new(size_t s) throw() { (void) s; return NULL; }
static void operator delete(void* p) { (void) p; };
StaticStack(const StaticStack& s) : a(s.a) {}
const StaticStack& operator =(const StaticStack&) { return *this; }
};
template<class T, class A>
forceinline
StaticStack<T,A>::StaticStack(A& a0, int n0)
: a(a0), n(n0), tos(0), stack(a.template alloc<T>(n)) {}
template<class T, class A>
forceinline
StaticStack<T,A>::~StaticStack(void) {
a.free(stack,n);
}
template<class T, class A>
forceinline bool
StaticStack<T,A>::empty(void) const {
return tos==0;
}
template<class T, class A>
forceinline int
StaticStack<T,A>::entries(void) const {
return tos;
}
template<class T, class A>
forceinline void
StaticStack<T,A>::reset(void) {
tos = 0;
}
template<class T, class A>
forceinline T
StaticStack<T,A>::pop(void) {
assert((tos > 0) && (tos <= static_cast<unsigned int>(n)));
return stack[--tos];
}
template<class T, class A>
forceinline T&
StaticStack<T,A>::top(void) const {
assert((tos > 0) && (tos <= static_cast<unsigned int>(n)));
return stack[tos-1];
}
template<class T, class A>
forceinline T&
StaticStack<T,A>::last(void) const {
assert((tos >= 0) && (tos < static_cast<unsigned int>(n)));
return stack[tos];
}
template<class T, class A>
forceinline void
StaticStack<T,A>::push(const T& x) {
assert(tos < static_cast<unsigned int>(n));
stack[tos++] = x;
}
}}
// STATISTICS: support-any
Gecode::Support::StaticStack::push
void push(const T &x)
Push element x on top of stack.
Definition static-stack.hpp:137
Gecode::Support::StaticStack::reset
void reset(void)
Reset stack (pop all elements).
Definition static-stack.hpp:110
Gecode::Support::StaticStack::~StaticStack
~StaticStack(void)
Release memory.
Definition static-stack.hpp:92
Gecode::Support::StaticStack::pop
T pop(void)
Pop topmost element from stack and return it.
Definition static-stack.hpp:116
Gecode::Support::StaticStack::last
T & last(void) const
Return element that has just been popped.
Definition static-stack.hpp:130
Gecode::Support::StaticStack::empty
bool empty(void) const
Test whether stack is empty.
Definition static-stack.hpp:98
Gecode::Support::StaticStack::StaticStack
StaticStack(A &a, int n)
Initialize for n elements.
Definition static-stack.hpp:87
Gecode::Support::StaticStack::top
T & top(void) const
Return element on top of stack.
Definition static-stack.hpp:123
Gecode::Support::StaticStack::entries
int entries(void) const
Return number of entries currently on stack.
Definition static-stack.hpp:104
Gecode::Support
Support algorithms and datastructures
Gecode
Gecode toplevel namespace
forceinline
#define forceinline
Definition config.hpp:187