Mercurial > octave
view libinterp/octave-value/ov-base-mat.h @ 31138:b3ca7f891750
maint: use "m_" prefix for member variables in class octave_base_matrix.
* ov-base-int.cc, ov-base-mat.cc, ov-base-mat.h, ov-base.h, ov-bool-mat.cc,
ov-bool-mat.h, ov-cell.cc, ov-cell.h, ov-ch-mat.cc, ov-ch-mat.h, ov-cx-mat.cc,
ov-cx-mat.h, ov-flt-cx-mat.cc, ov-flt-cx-mat.h, ov-flt-re-mat.cc,
ov-flt-re-mat.h, ov-intx.h, ov-re-mat.cc, ov-re-mat.h, ov-str-mat.cc,
ov-str-mat.h:
use "m_" prefix for member variables in class octave_base_matrix.
author | Rik <rik@octave.org> |
---|---|
date | Sun, 10 Jul 2022 18:26:24 -0700 |
parents | 796f54d4ddbf |
children | aac27ad79be6 |
line wrap: on
line source
//////////////////////////////////////////////////////////////////////// // // Copyright (C) 1998-2022 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_API octave_base_matrix : public octave_base_value { public: typedef MT object_type; octave_base_matrix (void) : octave_base_value (), m_matrix (), m_typ (), m_idx_cache () { } 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)); } 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) { } ~octave_base_matrix (void) { clear_cached_info (); } std::size_t byte_size (void) const { return m_matrix.byte_size (); } octave_value squeeze (void) const { return MT (m_matrix.squeeze ()); } octave_value full_value (void) const { return m_matrix; } void maybe_economize (void) { 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); 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); dim_vector dims (void) const { return m_matrix.dims (); } octave_idx_type numel (void) const { return m_matrix.numel (); } int ndims (void) const { return m_matrix.ndims (); } octave_idx_type nnz (void) const { return m_matrix.nnz (); } octave_value reshape (const dim_vector& new_dims) const { return MT (m_matrix.reshape (new_dims)); } octave_value permute (const Array<int>& vec, bool inv = false) const { return MT (m_matrix.permute (vec, inv)); } octave_value resize (const dim_vector& dv, bool fill = false) const; octave_value all (int dim = 0) const { return m_matrix.all (dim); } octave_value any (int dim = 0) const { return m_matrix.any (dim); } MatrixType matrix_type (void) const { return m_typ ? *m_typ : MatrixType (); } MatrixType matrix_type (const MatrixType& _typ) const; octave_value diag (octave_idx_type k = 0) const { return octave_value (m_matrix.diag (k)); } octave_value diag (octave_idx_type m, octave_idx_type n) const { return octave_value (m_matrix.diag (m, n)); } octave_value sort (octave_idx_type dim = 0, sortmode mode = ASCENDING) const { return octave_value (m_matrix.sort (dim, mode)); } 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)); } sortmode issorted (sortmode mode = UNSORTED) const { return m_matrix.issorted (mode); } Array<octave_idx_type> sort_rows_idx (sortmode mode = ASCENDING) const { return m_matrix.sort_rows_idx (mode); } sortmode is_sorted_rows (sortmode mode = UNSORTED) const { return m_matrix.is_sorted_rows (mode); } bool is_matrix_type (void) const { return true; } bool isnumeric (void) const { return true; } bool is_defined (void) const { return true; } bool is_constant (void) const { return true; } OCTINTERP_API bool is_true (void) const; OCTINTERP_API bool print_as_scalar (void) 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 (void) const; OCTINTERP_API std::string edit_display (const float_display_format& fmt, octave_idx_type i, octave_idx_type j) const; MT& matrix_ref (void) { clear_cached_info (); return m_matrix; } const MT& matrix_ref (void) 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. const void * mex_get_data (void) const { return m_matrix.data (); } protected: MT m_matrix; octave::idx_vector set_idx_cache (const octave::idx_vector& idx) const { delete m_idx_cache; m_idx_cache = (idx ? new octave::idx_vector (idx) : nullptr); return idx; } void clear_cached_info (void) 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