tpl_dynListQueue.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_DYNLISTQUEUE_H
# define TPL_DYNLISTQUEUE_H
 
# include <iostream>
# include <ahDry.H>
# include <ahIterator.H>
# include <ah-args-ctor.H>
# include <htlist.H>
# include <tpl_dynDlist.H>
 
namespace Aleph {
 
    template <typename T> 
class DynListQueue 
      : public LocateFunctions<DynListQueue<T>, T>,
  public FunctionalMethods<DynListQueue<T>, T>,
  public GenericKeys<DynListQueue<T>, T>,
  public EqualToMethod<DynListQueue<T>>,
  public StlAlephIterator<DynListQueue<T>>
{
  DynList<T> q;
  size_t num_items = 0;
 
  using Base = DynList<T>;
 
public:
 
  void swap(DynListQueue & __q) noexcept
  {
    std::swap(num_items, __q.num_items);
    q.swap(__q.q);
  }
 
  DynListQueue() noexcept : num_items(0) { /* empty */ }
 
  DynListQueue(const DynListQueue & __q) : q(__q.q), num_items(__q.num_items)
  {
    // empty
  }
 
  DynListQueue(DynListQueue && __q) noexcept
  {
    swap(__q);
  }
 
  Special_Ctors(DynListQueue, T);
 
  DynListQueue & operator = (const DynListQueue & rhs)
  {
    if (this == &rhs)
      return *this;
 
    q = rhs.q;
    num_items = rhs.num_items;
 
    return *this;
  }
 
  DynListQueue & operator = (DynListQueue && rhs) noexcept
  {
    std::swap(num_items, rhs.num_items);
    q.swap(rhs.q);
    return *this;
  }
 
  [[nodiscard]] constexpr size_t size() const noexcept { return num_items; }
 
  [[nodiscard]] bool is_empty() const noexcept { return q.is_empty(); }
 
  using Set_Type = DynListQueue; 
 
  using Item_Type = T; 
 
  T & put(const T & data) 
  {
    T & ret_val = q.append(data);
    ++num_items;
    return ret_val;
  }
 
  T & put(T && data)
  {
    T & ret_val = q.append(std::forward<T>(data));
    ++num_items;
    return ret_val;
  }
 
  T & append(const T & data) { return put(data); }
 
  T & append(T && data)
  {
    return put(std::forward<T>(data)); 
  }
 
  T & insert(const T & data) { return put(data); }
 
  T & insert(T && data)
  {
    return put(std::forward<T>(data));
  }
 
  template <typename... Args>
  T & emplace(Args&&... args)
  {
    return put(T(std::forward<Args>(args)...));
  }
 
  T pop() { return get(); }
 
  void clear() noexcept { empty(); }
 
  T get() 
  {
    T ret_val = q.remove_first();
    --num_items;
    return ret_val;
  }
 
  T & front()
  {
    return q.get_first();
  }
 
  const T & front() const
  {
    return q.get_first();
  }
 
  T & rear()
  {
    return q.get_last();
  }
 
  const T & rear() const
  {
    return q.get_last();
  } 
 
  void empty() noexcept
  {
    q.empty();
    num_items = 0;
    assert(q.is_empty());
  }
 
  template <class Operation>
  bool traverse(Operation & operation)
  {
    return q.traverse(operation);
  }
 
  template <class Operation>
  bool traverse(Operation & operation) const
  {
    return q.traverse(operation);
  }
 
  template <class Operation>
  bool traverse(Operation && operation = Operation()) const
  {
    return q.traverse(std::forward<Operation>(operation));
  }
 
  template <class Operation>
  bool traverse(Operation && operation = Operation()) 
  {
    return q.traverse(std::forward<Operation>(operation));
  }
 
  T * search(const T & key) noexcept
  {
    return this->find_ptr([&key](const T & item) { return item == key; });
  }
 
  const T * search(const T & key) const noexcept
  {
    return const_cast<DynListQueue*>(this)->search(key);
  }
 
  using Key_Type = T;
 
  struct Iterator : public DynList<T>::Iterator
  {
    using Base = typename DynList<T>::Iterator;
    using Base::Base;
 
    Iterator(const DynListQueue<T> & q) noexcept : Base(q.q) {}
  };
};
 
} // end namespace Aleph
# endif // TPL_DYNLISTQUEUE_H