ov-re-mat.h

Go to the documentation of this file.

////////////////////////////////////////////////////////////////////////
//
// Copyright (C) 1996-2025 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_re_mat_h)
#define octave_ov_re_mat_h 1
 
#include "octave-config.h"
 
#include <cstdlib>
 
#include <iosfwd>
#include <string>
 
#include "mx-base.h"
#include "str-vec.h"
 
#include "error.h"
#include "oct-stream.h"
#include "ov-base.h"
#include "ov-base-mat.h"
#include "ov-typeinfo.h"
 
#include "MatrixType.h"
 
class octave_value_list;
 
// Real matrix values.
 
extern template class OCTINTERP_EXTERN_TEMPLATE_API octave_base_matrix<NDArray>;
 
class OCTINTERP_API octave_matrix : public octave_base_matrix<NDArray>
{
public:
 
  octave_matrix ()
    : octave_base_matrix<NDArray> () { }
 
  octave_matrix (const Matrix& m)
    : octave_base_matrix<NDArray> (m) { }
 
  octave_matrix (const Matrix& m, const MatrixType& t)
    : octave_base_matrix<NDArray> (m, t) { }
 
  octave_matrix (const NDArray& nda)
    : octave_base_matrix<NDArray> (nda) { }
 
  octave_matrix (const Array<double>& m)
    : octave_base_matrix<NDArray> (NDArray (m)) { }
 
  octave_matrix (const DiagMatrix& d)
    : octave_base_matrix<NDArray> (Matrix (d)) { }
 
  octave_matrix (const RowVector& v)
    : octave_base_matrix<NDArray> (Matrix (v)) { }
 
  octave_matrix (const ColumnVector& v)
    : octave_base_matrix<NDArray> (Matrix (v)) { }
 
  octave_matrix (const octave_matrix& m)
    : octave_base_matrix<NDArray> (m) { }
 
  octave_matrix (const Array<octave_idx_type>& idx,
                 bool zero_based = false, bool cache_index = false)
    : octave_base_matrix<NDArray> (NDArray (idx, zero_based))
  {
    // Auto-create cache to speed up subsequent indexing.
    if (zero_based && cache_index)
      set_idx_cache (octave::idx_vector (idx));
  }
 
  octave_matrix (const NDArray& nda, const octave::idx_vector& cache)
    : octave_base_matrix<NDArray> (nda)
  {
    set_idx_cache (cache);
  }
 
  ~octave_matrix () = default;
 
  octave_base_value * clone () const { return new octave_matrix (*this); }
  octave_base_value * empty_clone () const { return new octave_matrix (); }
 
  type_conv_info numeric_demotion_function () const;
 
  octave_base_value * try_narrowing_conversion ();
 
  octave::idx_vector index_vector (bool /* require_integers */ = false) const
  {
    return m_idx_cache ? *m_idx_cache
           : set_idx_cache (octave::idx_vector (m_matrix));
  }
 
  builtin_type_t builtin_type () const { return btyp_double; }
 
  bool is_real_matrix () const { return true; }
 
  bool isreal () const { return true; }
 
  bool is_double_type () const { return true; }
 
  bool isfloat () const { return true; }
 
  int8NDArray
  int8_array_value () const { return int8NDArray (m_matrix); }
 
  int16NDArray
  int16_array_value () const { return int16NDArray (m_matrix); }
 
  int32NDArray
  int32_array_value () const { return int32NDArray (m_matrix); }
 
  int64NDArray
  int64_array_value () const { return int64NDArray (m_matrix); }
 
  uint8NDArray
  uint8_array_value () const { return uint8NDArray (m_matrix); }
 
  uint16NDArray
  uint16_array_value () const { return uint16NDArray (m_matrix); }
 
  uint32NDArray
  uint32_array_value () const { return uint32NDArray (m_matrix); }
 
  uint64NDArray
  uint64_array_value () const { return uint64NDArray (m_matrix); }
 
  double double_value (bool = false) const;
 
  float float_value (bool = false) const;
 
  double scalar_value (bool frc_str_conv = false) const
  { return double_value (frc_str_conv); }
 
  Matrix matrix_value (bool = false) const;
 
  FloatMatrix float_matrix_value (bool = false) const;
 
  Complex complex_value (bool = false) const;
 
  FloatComplex float_complex_value (bool = false) const;
 
  ComplexMatrix complex_matrix_value (bool = false) const;
 
  FloatComplexMatrix float_complex_matrix_value (bool = false) const;
 
  ComplexNDArray complex_array_value (bool = false) const;
 
  FloatComplexNDArray float_complex_array_value (bool = false) const;
 
  boolNDArray bool_array_value (bool warn = false) const;
 
  charNDArray char_array_value (bool = false) const;
 
  NDArray array_value (bool = false) const { return m_matrix; }
 
  FloatNDArray float_array_value (bool = false) const { return m_matrix; }
 
  SparseMatrix sparse_matrix_value (bool = false) const;
 
  SparseComplexMatrix sparse_complex_matrix_value (bool = false) const;
 
  octave_value as_double () const;
  octave_value as_single () const;
 
  octave_value as_int8 () const;
  octave_value as_int16 () const;
  octave_value as_int32 () const;
  octave_value as_int64 () const;
 
  octave_value as_uint8 () const;
  octave_value as_uint16 () const;
  octave_value as_uint32 () const;
  octave_value as_uint64 () const;
 
  octave_value diag (octave_idx_type k = 0) const;
 
  octave_value diag (octave_idx_type m, octave_idx_type n) const;
 
  octave_value reshape (const dim_vector& new_dims) const;
 
  octave_value squeeze () const;
 
  octave_value sort (octave_idx_type dim = 0, sortmode mode = ASCENDING) const;
  octave_value sort (Array<octave_idx_type>& sidx, octave_idx_type dim = 0,
                     sortmode mode = ASCENDING) const;
 
  sortmode issorted (sortmode mode = UNSORTED) const;
 
  Array<octave_idx_type> sort_rows_idx (sortmode mode = ASCENDING) const;
 
  sortmode is_sorted_rows (sortmode mode = UNSORTED) const;
 
  // Use matrix_ref here to clear index cache.
  void increment () { matrix_ref () += 1.0; }
 
  void decrement () { matrix_ref () -= 1.0; }
 
  void changesign () { matrix_ref ().changesign (); }
 
  octave_value convert_to_str_internal (bool pad, bool force, char type) const;
 
  void print_raw (std::ostream& os, bool pr_as_read_syntax = false) const;
 
  bool save_ascii (std::ostream& os);
 
  bool load_ascii (std::istream& is);
 
  bool save_binary (std::ostream& os, bool save_as_floats);
 
  bool load_binary (std::istream& is, bool swap,
                    octave::mach_info::float_format fmt);
 
  bool save_hdf5 (octave_hdf5_id loc_id, const char *name, bool save_as_floats);
 
  bool load_hdf5 (octave_hdf5_id loc_id, const char *name);
 
  int write (octave::stream& os, int block_size,
             oct_data_conv::data_type output_type, int skip,
             octave::mach_info::float_format flt_fmt) const
  { return os.write (m_matrix, block_size, output_type, skip, flt_fmt); }
 
  mxArray * as_mxArray (bool interleaved) const;
 
  octave_value map (unary_mapper_t umap) const;
 
private:
 
  DECLARE_OV_TYPEID_FUNCTIONS_AND_DATA_API (OCTINTERP_API)
};
 
#endif