////////////////////////////////////////////////////////////////////////
//
// Copyright (C) 1998-2024 The Octave Project Developers
//
// See the file COPYRIGHT.md in the top-level directory of this
// distribution or <https://octave.org/copyright/>.
//
// This file is part of Octave.
//
// Octave is free software: you can redistribute it and/or modify it
// under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Octave is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Octave; see the file COPYING.  If not, see
// <https://www.gnu.org/licenses/>.
//
////////////////////////////////////////////////////////////////////////

#if ! defined (octave_ov_base_mat_h)
#define octave_ov_base_mat_h 1

#include "octave-config.h"

#include <cstdlib>

#include <iosfwd>
#include <string>

#include "mx-base.h"
#include "str-vec.h"
#include "MatrixType.h"

#include "error.h"
#include "ovl.h"
#include "ov-base.h"
#include "ov-typeinfo.h"

// Real matrix values.

template <typename MT>
class OCTINTERP_TEMPLATE_API octave_base_matrix : public octave_base_value
{
public:

  typedef MT object_type;

  OCTINTERP_OVERRIDABLE_FUNC_API
  octave_base_matrix ()
    : octave_base_value (), m_matrix (), m_typ (), m_idx_cache () { }

  OCTINTERP_OVERRIDABLE_FUNC_API
  octave_base_matrix (const MT& m, const MatrixType& t = MatrixType ())
    : octave_base_value (), m_matrix (m),
      m_typ (t.is_known () ? new MatrixType (t) : nullptr), m_idx_cache ()
  {
    if (m_matrix.ndims () == 0)
      m_matrix.resize (dim_vector (0, 0));
  }

  OCTINTERP_OVERRIDABLE_FUNC_API
  octave_base_matrix (const octave_base_matrix& m)
    : octave_base_value (), m_matrix (m.m_matrix),
      m_typ (m.m_typ ? new MatrixType (*m.m_typ) : nullptr),
      m_idx_cache (m.m_idx_cache ? new octave::idx_vector (*m.m_idx_cache)
                   : nullptr)
  { }

  OCTINTERP_OVERRIDABLE_FUNC_API
  ~octave_base_matrix () { clear_cached_info (); }

  OCTINTERP_OVERRIDABLE_FUNC_API
  std::size_t byte_size () const { return m_matrix.byte_size (); }

  OCTINTERP_OVERRIDABLE_FUNC_API
  octave_value squeeze () const { return MT (m_matrix.squeeze ()); }

  OCTINTERP_OVERRIDABLE_FUNC_API
  octave_value full_value () const { return m_matrix; }

  OCTINTERP_OVERRIDABLE_FUNC_API
  void maybe_economize () { m_matrix.maybe_economize (); }

  // We don't need to override all three forms of subsref.  The using
  // declaration will avoid warnings about partially-overloaded virtual
  // functions.
  using octave_base_value::subsref;

  OCTINTERP_API octave_value
  subsref (const std::string& type, const std::list<octave_value_list>& idx);

  OCTINTERP_API octave_value_list
  simple_subsref (char type, octave_value_list& idx, int nargout);

  OCTINTERP_OVERRIDABLE_FUNC_API octave_value_list
  subsref (const std::string& type, const std::list<octave_value_list>& idx, int)
  { return subsref (type, idx); }

  OCTINTERP_API octave_value
  subsasgn (const std::string& type, const std::list<octave_value_list>& idx,
            const octave_value& rhs);

  OCTINTERP_API octave_value
  do_index_op (const octave_value_list& idx,  bool resize_ok = false);

  // FIXME: should we import the functions from the base class and
  // overload them here, or should we use a different name so we don't
  // have to do this?  Without the using declaration or a name change,
  // the base class functions will be hidden.  That may be OK, but it
  // can also cause some confusion.
  using octave_base_value::assign;

  OCTINTERP_API void assign (const octave_value_list& idx, const MT& rhs);

  OCTINTERP_API void
  assign (const octave_value_list& idx, typename MT::element_type rhs);

  OCTINTERP_API void delete_elements (const octave_value_list& idx);

  OCTINTERP_OVERRIDABLE_FUNC_API dim_vector
  dims () const { return m_matrix.dims (); }

  OCTINTERP_OVERRIDABLE_FUNC_API octave_idx_type
  numel () const { return m_matrix.numel (); }

  OCTINTERP_OVERRIDABLE_FUNC_API int
  ndims () const { return m_matrix.ndims (); }

  OCTINTERP_OVERRIDABLE_FUNC_API octave_idx_type
  nnz () const { return m_matrix.nnz (); }

  OCTINTERP_OVERRIDABLE_FUNC_API octave_value
  reshape (const dim_vector& new_dims) const
  { return MT (m_matrix.reshape (new_dims)); }

  OCTINTERP_OVERRIDABLE_FUNC_API octave_value
  permute (const Array<int>& vec, bool inv = false) const
  { return MT (m_matrix.permute (vec, inv)); }

  OCTINTERP_API octave_value
  resize (const dim_vector& dv, bool fill = false) const;

  OCTINTERP_OVERRIDABLE_FUNC_API octave_value all (int dim = 0) const
  { return m_matrix.all (dim); }
  OCTINTERP_OVERRIDABLE_FUNC_API octave_value any (int dim = 0) const
  { return m_matrix.any (dim); }

  OCTINTERP_OVERRIDABLE_FUNC_API MatrixType matrix_type () const
  { return m_typ ? *m_typ : MatrixType (); }
  OCTINTERP_API MatrixType matrix_type (const MatrixType& _typ) const;

  OCTINTERP_OVERRIDABLE_FUNC_API octave_value
  diag (octave_idx_type k = 0) const
  { return octave_value (m_matrix.diag (k)); }

  OCTINTERP_OVERRIDABLE_FUNC_API octave_value
  diag (octave_idx_type m, octave_idx_type n) const
  { return octave_value (m_matrix.diag (m, n)); }

  OCTINTERP_OVERRIDABLE_FUNC_API octave_value
  sort (octave_idx_type dim = 0, sortmode mode = ASCENDING) const
  { return octave_value (m_matrix.sort (dim, mode)); }
  OCTINTERP_OVERRIDABLE_FUNC_API octave_value
  sort (Array<octave_idx_type>& sidx, octave_idx_type dim = 0,
        sortmode mode = ASCENDING) const
  { return octave_value (m_matrix.sort (sidx, dim, mode)); }

  OCTINTERP_OVERRIDABLE_FUNC_API sortmode issorted (sortmode mode = UNSORTED) const
  { return m_matrix.issorted (mode); }

  OCTINTERP_OVERRIDABLE_FUNC_API Array<octave_idx_type>
  sort_rows_idx (sortmode mode = ASCENDING) const
  { return m_matrix.sort_rows_idx (mode); }

  OCTINTERP_OVERRIDABLE_FUNC_API sortmode
  is_sorted_rows (sortmode mode = UNSORTED) const
  { return m_matrix.is_sorted_rows (mode); }

  OCTINTERP_OVERRIDABLE_FUNC_API bool
  is_matrix_type () const { return true; }

  OCTINTERP_OVERRIDABLE_FUNC_API bool
  is_full_num_matrix () const { return true; }

  OCTINTERP_OVERRIDABLE_FUNC_API bool isnumeric () const { return true; }

  OCTINTERP_OVERRIDABLE_FUNC_API bool is_defined () const { return true; }

  OCTINTERP_OVERRIDABLE_FUNC_API bool is_constant () const { return true; }

  OCTINTERP_API bool is_true () const;

  OCTINTERP_API bool print_as_scalar () const;

  OCTINTERP_API void print (std::ostream& os, bool pr_as_read_syntax = false);

  OCTINTERP_API void
  print_info (std::ostream& os, const std::string& prefix) const;

  OCTINTERP_API void short_disp (std::ostream& os) const;

  OCTINTERP_API float_display_format get_edit_display_format () const;

  OCTINTERP_API std::string
  edit_display (const float_display_format& fmt,
                octave_idx_type i, octave_idx_type j) const;

  OCTINTERP_OVERRIDABLE_FUNC_API MT& matrix_ref ()
  {
    clear_cached_info ();
    return m_matrix;
  }

  OCTINTERP_OVERRIDABLE_FUNC_API const MT& matrix_ref () const
  {
    return m_matrix;
  }

  OCTINTERP_API octave_value
  fast_elem_extract (octave_idx_type n) const;

  OCTINTERP_API bool
  fast_elem_insert (octave_idx_type n, const octave_value& x);

  // This function exists to support the MEX interface.
  // You should not use it anywhere else.
  OCTINTERP_OVERRIDABLE_FUNC_API const void *
  mex_get_data () const { return m_matrix.data (); }

protected:

  MT m_matrix;

  OCTINTERP_OVERRIDABLE_FUNC_API octave::idx_vector
  set_idx_cache (const octave::idx_vector& idx) const
  {
    delete m_idx_cache;
    m_idx_cache = new octave::idx_vector (idx);
    return idx;
  }

  OCTINTERP_OVERRIDABLE_FUNC_API void clear_cached_info () const
  {
    delete m_typ; m_typ = nullptr;
    delete m_idx_cache; m_idx_cache = nullptr;
  }

  mutable MatrixType *m_typ;
  mutable octave::idx_vector *m_idx_cache;

private:

  // No assignment.

  OCTINTERP_API octave_base_matrix& operator = (const octave_base_matrix&);
};

#endif