/* Copyright (C) 1998-2015 John W. Eaton Copyright (C) 2009-2010 VZLU Prague 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 <http://www.gnu.org/licenses/>. */ #if !defined (octave_ov_base_mat_h) #define octave_ov_base_mat_h 1 #include <cstdlib> #include <iosfwd> #include <string> #include "mx-base.h" #include "str-vec.h" #include "MatrixType.h" #include "error.h" #include "oct-obj.h" #include "ov-base.h" #include "ov-typeinfo.h" class tree_walker; // Real matrix values. template <class MT> class octave_base_matrix : public octave_base_value { public: octave_base_matrix (void) : octave_base_value (), matrix (), typ (), idx_cache () { } octave_base_matrix (const MT& m, const MatrixType& t = MatrixType ()) : octave_base_value (), matrix (m), typ (t.is_known () ? new MatrixType (t) : 0), idx_cache () { if (matrix.ndims () == 0) matrix.resize (dim_vector (0, 0)); } octave_base_matrix (const octave_base_matrix& m) : octave_base_value (), matrix (m.matrix), typ (m.typ ? new MatrixType (*m.typ) : 0), idx_cache (m.idx_cache ? new idx_vector (*m.idx_cache) : 0) { } ~octave_base_matrix (void) { clear_cached_info (); } size_t byte_size (void) const { return matrix.byte_size (); } octave_value squeeze (void) const { return MT (matrix.squeeze ()); } octave_value full_value (void) const { return matrix; } void maybe_economize (void) { matrix.maybe_economize (); } 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); } octave_value subsasgn (const std::string& type, const std::list<octave_value_list>& idx, const octave_value& rhs); octave_value do_index_op (const octave_value_list& idx, bool resize_ok = false); octave_value_list do_multi_index_op (int, const octave_value_list& idx) { return do_index_op (idx); } void assign (const octave_value_list& idx, const MT& rhs); void assign (const octave_value_list& idx, typename MT::element_type rhs); void delete_elements (const octave_value_list& idx); dim_vector dims (void) const { return matrix.dims (); } octave_idx_type numel (void) const { return matrix.numel (); } int ndims (void) const { return matrix.ndims (); } octave_idx_type nnz (void) const { return matrix.nnz (); } octave_value reshape (const dim_vector& new_dims) const { return MT (matrix.reshape (new_dims)); } octave_value permute (const Array<int>& vec, bool inv = false) const { return MT (matrix.permute (vec, inv)); } octave_value resize (const dim_vector& dv, bool fill = false) const; octave_value all (int dim = 0) const { return matrix.all (dim); } octave_value any (int dim = 0) const { return matrix.any (dim); } MatrixType matrix_type (void) const { return typ ? *typ : MatrixType (); } MatrixType matrix_type (const MatrixType& _typ) const; octave_value diag (octave_idx_type k = 0) const { return octave_value (matrix.diag (k)); } octave_value diag (octave_idx_type m, octave_idx_type n) const { return octave_value (matrix.diag (m, n)); } octave_value sort (octave_idx_type dim = 0, sortmode mode = ASCENDING) const { return octave_value (matrix.sort (dim, mode)); } octave_value sort (Array<octave_idx_type> &sidx, octave_idx_type dim = 0, sortmode mode = ASCENDING) const { return octave_value (matrix.sort (sidx, dim, mode)); } sortmode is_sorted (sortmode mode = UNSORTED) const { return matrix.is_sorted (mode); } Array<octave_idx_type> sort_rows_idx (sortmode mode = ASCENDING) const { return matrix.sort_rows_idx (mode); } sortmode is_sorted_rows (sortmode mode = UNSORTED) const { return matrix.is_sorted_rows (mode); } bool is_matrix_type (void) const { return true; } bool is_numeric_type (void) const { return true; } bool is_defined (void) const { return true; } bool is_constant (void) const { return true; } bool is_true (void) const; bool print_as_scalar (void) const; void print (std::ostream& os, bool pr_as_read_syntax = false); void print_info (std::ostream& os, const std::string& prefix) const; void short_disp (std::ostream& os) const; MT& matrix_ref (void) { clear_cached_info (); return matrix; } const MT& matrix_ref (void) const { return matrix; } octave_value fast_elem_extract (octave_idx_type n) const; bool fast_elem_insert (octave_idx_type n, const octave_value& x); protected: MT matrix; idx_vector set_idx_cache (const idx_vector& idx) const { delete idx_cache; idx_cache = idx ? new idx_vector (idx) : 0; return idx; } void clear_cached_info (void) const { delete typ; typ = 0; delete idx_cache; idx_cache = 0; } mutable MatrixType *typ; mutable idx_vector *idx_cache; private: // No assignment. octave_base_matrix& operator = (const octave_base_matrix&); }; #endif