tpl_arrayStack.H

Go to the documentation of this file.

/*
                          Aleph_w
 
  Data structures & Algorithms
  version 2.0.0b
  https://github.com/lrleon/Aleph-w
 
  This file is part of Aleph-w library
 
  Copyright (c) 2002-2026 Leandro Rabindranath Leon
 
  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.
*/
 
 
#ifndef TPL_ARRAYSTACK_H
#define TPL_ARRAYSTACK_H
 
#include <iostream>
#include <memory>
#include <type_traits>
#include <aleph.H>
#include <htlist.H>
#include <tpl_dynDlist.H>
#include <ah-args-ctor.H>
#include <ah-dry.H>
#include <tpl_memArray.H>
#include <ah-errors.H>
 
namespace Aleph
{
  template <typename T>
  class ArrayStack : public LocateFunctions<ArrayStack<T>, T>,
                     public FunctionalMethods<ArrayStack<T>, T>,
                     public GenericKeys<ArrayStack<T>, T>,
                     public EqualToMethod<ArrayStack<T>>,
                     public StlAlephIterator<ArrayStack<T>>
  {
    MemArray<T> array;
 
  public:
    using Item_Type = T; 
 
    ArrayStack(size_t dim = 4) : array(dim)
    { /* empty */
    }
 
    ArrayStack(const ArrayStack & s) : array(s.array)
    { /* empty */
    }
 
    ArrayStack(ArrayStack && s) noexcept
      : array(std::move(s.array))
    { /* empty */
    }
 
    Special_Ctors(ArrayStack, T);
 
    ArrayStack &operator =(const ArrayStack & s)
    {
      if (this == &s)
        return *this;
 
      array = s.array;
 
      return *this;
    }
 
    void swap(ArrayStack & s) noexcept
    {
      array.swap(s.array);
    }
 
    ArrayStack &operator =(ArrayStack && s) noexcept
    {
      array.swap(s.array);
      return *this;
    }
 
    T &push(const T & data)
    {
      return array.put(data);
    }
 
    T &push(T && data)
    {
      return array.put(std::forward<T>(data));
    }
 
    T &append(const T & data) { return push(data); }
 
    T &append(T && data) { return push(std::forward<T>(data)); }
 
    T &insert(const T & data) { return push(data); }
 
    T &insert(T && data) { return push(std::forward<T>(data)); }
 
    T &pushn(const size_t & n = 1)
    {
      ah_invalid_argument_if(n == 0) << "ArrayStack::pushn: n must be positive";
      array.putn(n);
      return array.last();
    }
 
    T pop()
    {
      return array.get(1);
    }
 
    T pop_ne() noexcept
    {
      return array.get_ne(1);
    }
 
    T popn(size_t n)
    {
      ah_invalid_argument_if(n == 0) << "ArrayStack::popn: n must be positive";
      return array.get(n);
    }
 
    T &top()
    {
      return array.last();
    }
 
    const T &top() const
    {
      return array.last();
    }
 
    T &base() noexcept
    {
      return array.first();
    }
 
    const T &base() const noexcept
    {
      return array.first();
    }
 
    T &top(size_t i)
    {
      const size_t sz = array.size();
      ah_out_of_range_error_if(i >= sz) << "top index out of range";
      return array.access(sz - i - 1);
    }
 
    const T &top(size_t i) const
    {
      const size_t sz = array.size();
      ah_out_of_range_error_if(i >= sz) << "top index out of range";
      return array(sz - i - 1);
    }
 
    T &get_last() { return top(); }
 
    const T &get_last() const { return top(); }
 
    void empty() noexcept { array.empty(); }
 
    void clear() noexcept { empty(); }
 
    bool is_empty() const noexcept { return array.size() == 0; }
 
    size_t size() const noexcept { return array.size(); }
 
    size_t capacity() const noexcept { return array.capacity(); }
 
    template <class Operation>
    bool traverse(Operation & operation)
    {
      return array.traverse(operation);
    }
 
    template <class Operation>
    bool traverse(Operation & operation) const
    {
      return array.traverse(operation);
    }
 
    template <class Operation>
    bool traverse(Operation && operation = Operation()) const
    {
      return array.traverse(operation);
    }
 
    template <class Operation>
    bool traverse(Operation && operation = Operation())
    {
      return array.traverse(operation);
    }
 
    class Iterator : public MemArray<T>::Iterator
    {
    public:
      using Base = typename MemArray<T>::Iterator;
      using Set_Type = ArrayStack;
 
      using Base::Base;
 
      Iterator(const ArrayStack<T> & s) : Base(s.array) {}
    };
  };
 
  template <typename T>
  class FixedStack : public LocateFunctions<FixedStack<T>, T>,
                     public FunctionalMethods<FixedStack<T>, T>,
                     public GenericKeys<FixedStack<T>, T>,
                     public EqualToMethod<FixedStack<T>>,
                     public StlAlephIterator<FixedStack<T>>
  {
    T *array = nullptr;
    size_t head = 0;
    size_t dim = 0;
 
  public:
    using Item_Type = T; 
 
    FixedStack(size_t d = 1024)
    // Don't change the default value because you would risk of
    // breaking the tests
      : array(new T[d]), head(0), dim(d)
    {
      /* empty */
    }
 
    ~FixedStack()
    {
      if (array)
        delete [] array;
    }
 
    FixedStack(const FixedStack & s)
      : array(nullptr), head(s.head), dim(s.dim)
    {
      std::unique_ptr<T[]> tmp(new T[s.dim]);
      for (size_t i = 0; i < head; ++i)
        tmp[i] = s.array[i];
      array = tmp.release();
    }
 
    Special_Ctors(FixedStack, T);
 
    void swap(FixedStack & s) noexcept
    {
      std::swap(array, s.array);
      std::swap(head, s.head);
      std::swap(dim, s.dim);
    }
 
    FixedStack(FixedStack && s) noexcept
      : array(nullptr), head(0), dim(0)
    {
      swap(s);
    }
 
    FixedStack &operator =(const FixedStack & s)
    {
      if (this == &s)
        return *this;
 
      FixedStack tmp(s);
      swap(tmp);
      return *this;
    }
 
    FixedStack &operator =(FixedStack && s) noexcept
    {
      swap(s);
      return *this;
    }
 
    T &push(const T & data) noexcept(std::is_nothrow_copy_assignable_v<T>)
    {
      assert(head < dim);
      array[head++] = data;
      return array[head - 1];
    }
 
    T &push(T && data) noexcept(std::is_nothrow_move_assignable_v<T>)
    {
      assert(head < dim);
      array[head++] = std::move(data);
      return array[head - 1];
    }
 
    T &append(const T & data) noexcept(std::is_nothrow_copy_assignable_v<T>)
    {
      return push(data);
    }
 
    T &append(T && data) noexcept(std::is_nothrow_move_assignable_v<T>)
    {
      return push(std::forward<T>(data));
    }
 
    T &insert(const T & data) noexcept(std::is_nothrow_copy_assignable_v<T>)
    {
      return push(data);
    }
 
    T &insert(T && data) noexcept(std::is_nothrow_move_assignable_v<T>)
    {
      return push(std::forward<T>(data));
    }
 
    T &pushn(const size_t & n = 1) noexcept
    {
      assert(n > 0);
      assert(n <= dim - head);
 
      head += n;
      return array[head - 1];
    }
 
    T pop() noexcept
    {
      assert(head > 0);
 
      return std::move(array[--head]);
    }
 
    T popn(const int & n) noexcept
    {
      assert(n >= 0);
      const auto count = static_cast<size_t>(n);
      assert(head >= count);
 
      head -= count;
      return std::move(array[head]);
    }
 
    T &top() noexcept
    {
      assert(head > 0);
 
      return array[head - 1];
    }
 
    const T &top() const noexcept
    {
      assert(head > 0);
 
      return array[head - 1];
    }
 
    T &get_last() noexcept { return top(); }
 
    const T &get_last() const noexcept { return top(); }
 
    T &base() noexcept { return array[0]; }
 
    const T &base() const noexcept { return array[0]; }
 
    T &top(const size_t i) noexcept
    {
      assert(i < head);
      return array[head - i - 1];
    }
 
    const T &top(const size_t i) const noexcept
    {
      assert(i < head);
      return array[head - i - 1];
    }
 
    [[nodiscard]] bool is_empty() const noexcept { return head == 0; }
 
    void empty() noexcept { head = 0; }
 
    void clear() noexcept { empty(); }
 
    [[nodiscard]] size_t size() const noexcept { return head; }
 
    template <class Operation>
    bool traverse(Operation & operation)
    {
      for (size_t i = 0; i < head; i++)
        if (not operation(array[i]))
          return false;
 
      return true;
    }
 
    template <class Operation>
    bool traverse(Operation & operation) const
    {
      return const_cast<FixedStack *>(this)->traverse(operation);
    }
 
    template <class Operation>
    bool traverse(Operation && operation = Operation()) const
    {
      return traverse<Operation>(operation);
    }
 
    template <class Operation>
    bool traverse(Operation && operation = Operation())
    {
      return traverse<Operation>(operation);
    }
 
    class Iterator : public Array_Iterator<T>
    {
    public:
      using Base = Array_Iterator<T>;
      using Base::Base;
      using Set_Type = FixedStack;
 
      Iterator(const FixedStack<T> & s)
        : Base(no_exception_ctor, s.array, s.dim, s.head) {}
    };
  };
} // end namespace Aleph
 
# endif /* TPL_ARRAYSTACK_H */