sentinel-stack.icc

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, 2006
 *
 *  Last modified:
 *     $Date: 2008-07-11 11:13:44 +0200 (Fri, 11 Jul 2008) $ by $Author: tack $
 *     $Revision: 7358 $
 *
 *  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 SentinelStack {
  private:
#ifndef NDEBUG
    unsigned int size;
    T* bos;
#endif
    const T sentinel;
    T* tos;
  public:
    SentinelStack(T* p, T s, int n);
    bool empty(void) const;
    T top(void) const;
    T last(void) const;
    T pop(void);
    void push(T x);
  };

  template<class T>
  forceinline
  SentinelStack<T>::SentinelStack(T* p, T s, int n) 
    : 
#ifndef NDEBUG
    size(n), bos(p),
#endif
    sentinel(s), tos(p) {
    (void) n;
    *(tos++) = sentinel;
  }
  template<class T>
  forceinline bool
  SentinelStack<T>::empty(void) const {
    return *(tos-1) == sentinel;
  }
  template<class T>
  forceinline T
  SentinelStack<T>::top(void) const {
    assert(*(tos-1) != sentinel);
    return *(tos-1);
  }
  template<class T>
  forceinline T
  SentinelStack<T>::last(void) const {
    return *tos;
  }
  template<class T>
  forceinline T
  SentinelStack<T>::pop(void) {
#ifndef NDEBUG
    assert(tos-bos > 1);
#endif
    return *(--tos);
  }
  template<class T>
  forceinline void
  SentinelStack<T>::push(T x) {
    assert(x != sentinel);
#ifndef NDEBUG
    assert(tos-bos < size+1);
#endif
    *(tos++) = x;
  }

}}

#define GECODE_AUTOSTACK(T,S,X,N)                                     \
  int __GECODE__AS__ ## X ## __LINE__ ## n = (N); \
  GECODE_AUTOARRAY(T,__GECODE__AS__ ## X ## __LINE__,(__GECODE__AS__ ## X ## __LINE__ ## n) + 1);               \
  Gecode::Support::SentinelStack<T> X(__GECODE__AS__ ## X ## __LINE__,(S),__GECODE__AS__ ## X ## __LINE__ ## n);
// STATISTICS: support-any