SearchableStack.h

Go to the documentation of this file.

// this is for emacs file handling -*- mode: c++; indent-tabs-mode: nil -*-

// -- BEGIN LICENSE BLOCK ----------------------------------------------
// This file is part of FZIs ic_workspace.
//
// This program is free software licensed under the LGPL
// (GNU LESSER GENERAL PUBLIC LICENSE Version 3).
// You can find a copy of this license in LICENSE folder in the top
// directory of the source code.
//
// © Copyright 2016 FZI Forschungszentrum Informatik, Karlsruhe, Germany
//
// -- END LICENSE BLOCK ------------------------------------------------

//----------------------------------------------------------------------
//----------------------------------------------------------------------
#ifndef ICL_CORE_SEARCHABLE_STACK_H_INCLUDED
#define ICL_CORE_SEARCHABLE_STACK_H_INCLUDED

#include <functional>
#include <vector>

#include "icl_core/BaseTypes.h"
#include "icl_core/TemplateHelper.h"

namespace icl_core {

template <typename T, typename TCompare = std::equal_to<T>, typename TAlloc = std::allocator<T> >
class SearchableStack : protected std::vector<T, TAlloc>
{
public:
  typedef typename std::vector<T>::const_iterator const_iterator;
  typedef typename std::vector<T>::const_reverse_iterator const_reverse_iterator;
  typedef typename std::vector<T>::size_type size_type;

  SearchableStack() : std::vector<T, TAlloc>(), m_comp() { }

  void clear() { std::vector<T, TAlloc>::clear(); }
  bool empty() const { return std::vector<T, TAlloc>::empty(); }
  size_type size() const { return std::vector<T, TAlloc>::size(); }

  void push(typename ConvertToRef<T>::ToConstRef t) { std::vector<T, TAlloc>::push_back(t); }
  void pop() { std::vector<T, TAlloc>::pop_back(); }
  typename ConvertToRef<T>::ToRef top() { return std::vector<T, TAlloc>::back(); }
  typename ConvertToRef<T>::ToConstRef top() const { return std::vector<T, TAlloc>::back(); }

  const_iterator begin() const { return std::vector<T, TAlloc>::begin(); }
  const_iterator end() const { return std::vector<T, TAlloc>::end(); }
  const_reverse_iterator rbegin() const { return std::vector<T, TAlloc>::rbegin(); }
  const_reverse_iterator rend() const { return std::vector<T, TAlloc>::rend(); }

  const_iterator find(typename ConvertToRef<T>::ToConstRef t) const
  {
    for (const_iterator it = begin(); it != end(); ++it)
    {
      if (m_comp(*it, t)) { return it; }
    }
    return end();
  }

  TCompare m_comp;
};

typedef SearchableStack<uint8_t> Unsigned8SearchableStack;
typedef SearchableStack<uint16_t> Unsigned16SearchableStack;
typedef SearchableStack<uint32_t> Unsigned32SearchableStack;
typedef SearchableStack<uint64_t> Unsigned64SearchableStack;
typedef SearchableStack<int8_t> Signed8SearchableStack;
typedef SearchableStack<int16_t> Signed16SearchableStack;
typedef SearchableStack<int32_t> Signed32SearchableStack;
typedef SearchableStack<int64_t> Signed64SearchableStack;
typedef SearchableStack<float> FloaSearchableStack;
typedef SearchableStack<double> DoubleSearchableStack;

}

#endif