tpl_array.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_ARRAY_H
#define TPL_ARRAY_H
 
#include <iostream>
#include <utility>
#include <vector>
#include <concepts>
#include <type_traits>
#include <aleph.H>
#include <htlist.H>
#include <tpl_dynDlist.H>
#include <ah-dry.H>
#include <ah-args-ctor.H>
#include <tpl_memArray.H>
 
namespace Aleph {
 
template <typename T>
class Array : public LocateFunctions<Array<T>, T>,
              public FunctionalMethods<Array<T>, T>,
              public GenericKeys<Array<T>, T>,
              public EqualSequenceMethod<Array<T>>,
              public StlAlephIterator<Array<T>>
{
  MemArray<T> array;
 
public:
  using Item_Type = T;  
  using Key_Type = T;   
 
  Array(size_t dim = 32) : array(dim)
  { /* empty */
  }
 
  Array(size_t n, const T &value)
    requires(std::is_copy_constructible_v<T> and std::is_copy_assignable_v<T>)
    : array(n)
  {
    for (size_t i = 0; i < n; ++i)
      array.put(value);
  }
 
  static Array create(size_t n)
  {
    Array ret(n);
    ret.putn(n);
    return ret;
  }
 
  Array(const Array &s)
    requires(std::is_copy_constructible_v<T> and std::is_copy_assignable_v<T>)
    : array(s.array)
  { /* empty */
  }
 
  Array(Array &&s) noexcept : array(std::forward<MemArray<T>>(s.array))
  { /* empty */
  }
 
  Special_Ctors(Array, T);
 
  Args_Ctor(Array, T);
 
  Array &operator = (const Array &s)
    requires(std::is_copy_constructible_v<T> and std::is_copy_assignable_v<T>)
  {
    if (this == &s)
      return *this;
 
    array = s.array;
 
    return *this;
  }
 
  void swap(Array &s) noexcept
  {
    array.swap(s.array);
  }
 
  Array &operator = (Array &&s) noexcept
  {
    array.swap(s.array);
    return *this;
  }
 
  T &append(const T &data)
    requires std::is_copy_assignable_v<T>
  {
    return array.put(data);
  }
 
  T &append(T &&data)
  {
    return array.put(std::forward<T>(data));
  }
 
  Array &append(const Array &a)
  {
    array.append(a.array);
    return *this;
  }
 
  Array append(const Array &a) const
  {
    Array ret = *this;
    return ret.append(a);
  }
 
  T &insert(const T &data)
  {
    return array.push(data);
  }
 
  T &insert(T &&data)
  {
    return array.push(std::forward<T>(data));
  }
 
  void putn(const size_t n)
  {
    array.putn(n);
  }
 
  void reserve(size_t cap)
  {
    array.reserve(cap);
  }
 
  T &base()
  {
    ah_underflow_error_if(is_empty()) << "Array::base(): empty array";
    return *array.get_ptr();
  }
 
  const T &base() const
  {
    ah_underflow_error_if(is_empty()) << "Array::base(): empty array";
    return *array.get_ptr();
  }
 
  void empty() noexcept
  {
    array.empty();
  }
 
  void clear() noexcept
  {
    empty();
  }
 
  [[nodiscard]] constexpr bool is_empty() const noexcept
  {
    return array.size() == 0;
  }
 
  [[nodiscard]] constexpr size_t size() const noexcept
  {
    return array.size();
  }
 
  [[nodiscard]] constexpr size_t capacity() const noexcept
  {
    return array.capacity();
  }
 
  [[nodiscard]] T &get_first() noexcept
  {
    return array.first();
  }
 
  [[nodiscard]] const T &get_first() const noexcept
  {
    return array.first();
  }
 
  [[nodiscard]] T &get_last() noexcept
  {
    return array.last();
  }
 
  [[nodiscard]] const T &get_last() const noexcept
  {
    return array.last();
  }
 
  [[nodiscard]] T remove_last()
  {
    return array.remove_last();
  }
 
  [[nodiscard]] T remove_first()
  {
    return array.remove_first();
  }
 
  [[nodiscard]] T &operator [] (size_t i)
  {
    return array[i];
  }
 
  [[nodiscard]] const T &operator [] (size_t i) const
  {
    return array[i];
  }
 
  [[nodiscard]] constexpr T &operator () (const size_t i) noexcept
  {
    return array(i);
  }
 
  [[nodiscard]] constexpr const T &operator () (const size_t i) const noexcept
  {
    return array(i);
  }
 
  Array &reverse()
  {
    array.reverse();
    return *this;
  }
 
  Array reverse() const
  {
    const size_t &n = array.size();
    Array ret(n);
    for (size_t i = 0; i < n; ++i)
      ret.append(array(n - i - 1));
    return ret;
  }
 
  Array &reverse_in_place()
  {
    return reverse();
  }
 
  Array &rev()
  {
    return reverse_in_place();
  }
 
  Array rev() const
  {
    return reverse();
  }
 
  template <class Op>
    requires std::predicate<Op &, T &>
  bool traverse(Op &op)
  {
    return array.traverse(op);
  }
 
  template <class Op>
    requires std::predicate<Op &, const T &>
  bool traverse(Op &op) const
  {
    for (size_t i = 0; i < size(); ++i)
      if (not op((*this)[i]))
        return false;
    return true;
  }
 
  template <class Op>
    requires std::predicate<Op &, T &>
  bool traverse(Op &&op)
  {
    return traverse<Op>(op);
  }
 
  template <class Op>
    requires std::predicate<Op &, const T &>
  bool traverse(Op &&op) const
  {
    return traverse<Op>(op);
  }
 
  [[nodiscard]] bool is_valid() const noexcept
  {
    return array.is_valid();
  }
 
  Array to_array() const
    requires std::copy_constructible<T>
  {
    return *this;  // copy
  }
 
  struct Iterator : public MemArray<T>::Iterator
  {
    using Base = typename MemArray<T>::Iterator;
    using Base::Base;
    using Set_Type = Array;
 
    using aleph_random_access_iterator = Iterator;
 
    Iterator(const Array<T> &s) noexcept : Base(s.array) {}
  };
};
 
template <typename T, typename... Args>
Array<T> build_array(Args... args)
{
  return build_container<Array<T>>(args...);
}
 
template <class Container>
inline std::vector<typename Container::Item_Type> to_stdvector(const Container &c)
{
  std::vector<typename Container::Item_Type> ret(c.size());
  for (size_t i = 0; i < c.size(); ++i)
    ret[i] = c(i);
  return ret;
}
 
}  // end namespace Aleph
 
#endif /* TPL_ARRAY_H */