tpl_dynMat.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_DYNMAT_H
#define TPL_DYNMAT_H
 
#include <ah-errors.H>
#include <ahDry.H>
#include <tpl_dynArray.H>
 
namespace Aleph {
 
template <typename T>
class DynMatrix
    : public LocateFunctions<DynMatrix<T>, T>,
      public FunctionalMethods<DynMatrix<T>, T>
{
  size_t n = 0;  
  size_t m = 0;  
 
  DynArray<T> * array_ptr = nullptr;
 
  T default_value = T();
 
  [[nodiscard]] const T & read_array_entry(const size_t i) const noexcept
  {
    T * entry_ptr = array_ptr->test(i);
    return entry_ptr == nullptr ? default_value : *entry_ptr;
  }
 
  T & write_array_entry(const size_t i, const T & data)
  {
    T & ref = array_ptr->touch(i) = data;
    return ref;
  }
 
  T & write_array_entry(const size_t i, T && data)
  {
    T & ref = array_ptr->touch(i) = std::move(data);
    return ref;
  }
 
  [[nodiscard]] constexpr size_t get_index(const size_t i,
                                           const size_t j) const noexcept
  {
    return i * m + j;
  }
 
  void check_indices(const size_t i, const size_t j) const
  {
    ah_out_of_range_error_if(i >= n)
      << "DynMatrix: row index " << i << " out of range [0, " << n << ")";
    ah_out_of_range_error_if(j >= m)
      << "DynMatrix: column index " << j << " out of range [0, " << m << ")";
  }
 
public:
 
  using Set_Type = DynMatrix<T>;
 
  using Item_Type = T;
 
  using Key_Type = T;
 
  void set_default_initial_value(const T & value)
  {
    default_value = value;
    if (array_ptr)
      array_ptr->set_default_initial_value(value);
  }
 
  [[nodiscard]] const T & get_default_value() const noexcept
  {
    return default_value;
  }
 
  void swap(DynMatrix & mat) noexcept
  {
    std::swap(n, mat.n);
    std::swap(m, mat.m);
    std::swap(default_value, mat.default_value);
    std::swap(array_ptr, mat.array_ptr);
  }
 
  void set_dimension(const size_t num_rows, const size_t num_cols)
  {
    delete array_ptr;
 
    n = num_rows;
    m = num_cols;
    size_t d, s, b;
    const size_t N = n * m;
    DynArray<T>::compute_sizes(N, d, s, b);
 
    array_ptr = new DynArray<T>(d, s, b);
    array_ptr->set_default_initial_value(default_value);
  }
 
  void allocate()
  {
    array_ptr->reserve(n * m);
  }
 
  DynMatrix(const size_t num_rows, const size_t num_cols, const T & zero = T())
    : n(num_rows), m(num_cols), array_ptr(nullptr), default_value(zero)
  {
    ah_invalid_argument_if(num_rows == 0 || num_cols == 0)
      << "DynMatrix dimensions must be > 0";
    set_dimension(n, m);
  }
 
  DynMatrix() noexcept = default;
 
  ~DynMatrix()
  {
    delete array_ptr;
  }
 
  DynMatrix(const DynMatrix<T> & mat)
    : n(mat.n), m(mat.m), array_ptr(nullptr), default_value(mat.default_value)
  {
    if (mat.array_ptr)
      {
        set_dimension(n, m);
        *array_ptr = *mat.array_ptr;
      }
  }
 
  DynMatrix(DynMatrix<T> && mat) noexcept
    : n(mat.n),
      m(mat.m),
      array_ptr(mat.array_ptr),
      default_value(std::move(mat.default_value))
  {
    mat.n = mat.m = 0;
    mat.array_ptr = nullptr;
    mat.default_value = T();
  }
 
  DynMatrix<T> & operator = (const DynMatrix<T> & mat)
  {
    if (this == &mat)
      return *this;
 
    default_value = mat.default_value;
 
    if (n != mat.n || m != mat.m)
      set_dimension(mat.n, mat.m);
 
    if (mat.array_ptr)
      array_ptr->copy_array(*mat.array_ptr);
 
    return *this;
  }
 
  DynMatrix<T> & operator = (DynMatrix<T> && mat) noexcept
  {
    if (this == &mat)
      return *this;
 
    delete array_ptr;
 
    n = mat.n;
    m = mat.m;
    default_value = std::move(mat.default_value);
    array_ptr = mat.array_ptr;
 
    mat.n = mat.m = 0;
    mat.array_ptr = nullptr;
    mat.default_value = T();
 
    return *this;
  }
 
  [[nodiscard]] bool operator == (const DynMatrix<T> & mat) const
  {
    if (n != mat.n || m != mat.m)
      return false;
 
    const size_t N = n * m;
    for (size_t i = 0; i < N; ++i)
      if (read_array_entry(i) != mat.read_array_entry(i))
        return false;
 
    return true;
  }
 
  [[nodiscard]] bool operator != (const DynMatrix<T> & mat) const
  {
    return !(*this == mat);
  }
 
  [[nodiscard]] constexpr size_t rows() const noexcept { return n; }
 
  [[nodiscard]] constexpr size_t cols() const noexcept { return m; }
 
  [[nodiscard]] constexpr size_t size() const noexcept { return n * m; }
 
  [[nodiscard]] constexpr bool is_square() const noexcept { return n == m; }
 
  [[nodiscard]] constexpr bool is_empty() const noexcept { return n == 0 || m == 0; }
 
  [[nodiscard]] const T & read(const size_t i, const size_t j) const
  {
    check_indices(i, j);
    return read_array_entry(get_index(i, j));
  }
 
  [[nodiscard]] const T & read_ne(const size_t i, const size_t j) const noexcept
  {
    return read_array_entry(get_index(i, j));
  }
 
  T & write(const size_t i, const size_t j, const T & data)
  {
    check_indices(i, j);
    return write_array_entry(get_index(i, j), data);
  }
 
  T & write(const size_t i, const size_t j, T && data)
  {
    check_indices(i, j);
    return write_array_entry(get_index(i, j), std::move(data));
  }
 
  [[nodiscard]] T & access(const size_t i, const size_t j)
  {
    return array_ptr->access(get_index(i, j));
  }
 
  [[nodiscard]] const T & access(const size_t i, const size_t j) const
  {
    return array_ptr->access(get_index(i, j));
  }
 
  [[nodiscard]] T & operator () (const size_t i, const size_t j)
  {
    return access(i, j);
  }
 
  [[nodiscard]] const T & operator () (const size_t i, const size_t j) const
  {
    return access(i, j);
  }
 
  void fill(const T & value)
  {
    allocate();
    for (size_t idx = 0; idx < n * m; ++idx)
      array_ptr->access(idx) = value;
  }
 
  [[nodiscard]] DynMatrix<T> transpose() const
  {
    DynMatrix<T> result(m, n, default_value);
    for (size_t i = 0; i < n; ++i)
      for (size_t j = 0; j < m; ++j)
        {
          const T & val = read_array_entry(get_index(i, j));
          if (&val != &default_value)  // Only copy non-default entries
            result.write(j, i, val);
        }
    return result;
  }
 
  class Iterator
  {
    const DynMatrix * mat_ptr = nullptr;
    size_t curr_idx = 0;
 
  public:
 
    using Set_Type = DynMatrix<T>;
 
    Iterator(const DynMatrix<T> & mat) noexcept
      : mat_ptr(&mat), curr_idx(0) {}
 
    [[nodiscard]] bool has_curr() const noexcept
    {
      return curr_idx < mat_ptr->size();
    }
 
    [[nodiscard]] const T & get_curr_ne() const noexcept
    {
      return mat_ptr->read_array_entry(curr_idx);
    }
 
    [[nodiscard]] const T & get_curr() const
    {
      ah_overflow_error_unless(has_curr())
        << "DynMatrix::Iterator: no current element";
      return get_curr_ne();
    }
 
    void next_ne() noexcept { ++curr_idx; }
 
    void next()
    {
      ah_overflow_error_unless(has_curr())
        << "DynMatrix::Iterator: no more elements";
      next_ne();
    }
 
    [[nodiscard]] size_t get_row() const noexcept
    {
      return curr_idx / mat_ptr->m;
    }
 
    [[nodiscard]] size_t get_col() const noexcept
    {
      return curr_idx % mat_ptr->m;
    }
 
    void reset() noexcept { curr_idx = 0; }
  };
 
  [[nodiscard]] Iterator get_it() const { return Iterator(*this); }
 
  template <class Operation>
  bool traverse(Operation & operation) const
  {
    for (size_t i = 0; i < n * m; ++i)
      if (!operation(read_array_entry(i)))
        return false;
    return true;
  }
 
  template <class Operation>
  bool traverse(Operation & operation)
  {
    return const_cast<const DynMatrix*>(this)->traverse(operation);
  }
 
  template <class Operation>
  bool traverse(Operation && operation) const
  {
    return traverse<Operation>(operation);
  }
 
  template <class Operation>
  bool traverse(Operation && operation)
  {
    return traverse<Operation>(operation);
  }
 
  template <class Operation>
  bool traverse_allocated(Operation && operation)
  {
    if (array_ptr == nullptr)
      return true;
 
    const size_t total = n * m;
    for (size_t idx = 0; idx < total; ++idx)
      if (T *entry = array_ptr->test(idx))
        {
          if (!operation(*entry))
            return false;
        }
 
    return true;
  }
 
  template <class Operation>
  bool traverse_allocated(Operation && operation) const
  {
    if (array_ptr == nullptr)
      return true;
 
    const size_t total = n * m;
    for (size_t idx = 0; idx < total; ++idx)
      if (const T *entry = array_ptr->test(idx))
        {
          if (!operation(*entry))
            return false;
        }
 
    return true;
  }
};
 
} // end namespace Aleph
 
#endif // TPL_DYNMAT_H