Chris@49: // Copyright (C) 2011-2012 Ryan Curtin Chris@49: // Copyright (C) 2011 Matthew Amidon Chris@49: // Copyright (C) 2012 Conrad Sanderson Chris@49: // Chris@49: // This Source Code Form is subject to the terms of the Mozilla Public Chris@49: // License, v. 2.0. If a copy of the MPL was not distributed with this Chris@49: // file, You can obtain one at http://mozilla.org/MPL/2.0/. Chris@49: Chris@49: //! \addtogroup SpSubview Chris@49: //! @{ Chris@49: Chris@49: template Chris@49: class SpSubview : public SpBase > Chris@49: { Chris@49: public: Chris@49: Chris@49: const SpMat& m; Chris@49: Chris@49: typedef eT elem_type; Chris@49: typedef typename get_pod_type::result pod_type; Chris@49: Chris@49: static const bool is_row = false; Chris@49: static const bool is_col = false; Chris@49: Chris@49: const uword aux_row1; Chris@49: const uword aux_col1; Chris@49: const uword n_rows; Chris@49: const uword n_cols; Chris@49: const uword n_elem; Chris@49: const uword n_nonzero; Chris@49: Chris@49: // So that SpValProxy can call add_element() and delete_element(). Chris@49: friend class SpValProxy >; Chris@49: Chris@49: protected: Chris@49: Chris@49: arma_inline SpSubview(const SpMat& in_m, const uword in_row1, const uword in_col1, const uword in_n_rows, const uword in_n_cols); Chris@49: arma_inline SpSubview( SpMat& in_m, const uword in_row1, const uword in_col1, const uword in_n_rows, const uword in_n_cols); Chris@49: Chris@49: public: Chris@49: Chris@49: inline ~SpSubview(); Chris@49: Chris@49: inline const SpSubview& operator+= (const eT val); Chris@49: inline const SpSubview& operator-= (const eT val); Chris@49: inline const SpSubview& operator*= (const eT val); Chris@49: inline const SpSubview& operator/= (const eT val); Chris@49: Chris@49: inline const SpSubview& operator=(const SpSubview& x); Chris@49: Chris@49: template inline const SpSubview& operator= (const Base& x); Chris@49: template inline const SpSubview& operator+=(const Base& x); Chris@49: template inline const SpSubview& operator-=(const Base& x); Chris@49: template inline const SpSubview& operator*=(const Base& x); Chris@49: template inline const SpSubview& operator%=(const Base& x); Chris@49: template inline const SpSubview& operator/=(const Base& x); Chris@49: Chris@49: template inline const SpSubview& operator= (const SpBase& x); Chris@49: template inline const SpSubview& operator+=(const SpBase& x); Chris@49: template inline const SpSubview& operator-=(const SpBase& x); Chris@49: template inline const SpSubview& operator*=(const SpBase& x); Chris@49: template inline const SpSubview& operator%=(const SpBase& x); Chris@49: template inline const SpSubview& operator/=(const SpBase& x); Chris@49: Chris@49: /* Chris@49: inline static void extract(SpMat& out, const SpSubview& in); Chris@49: Chris@49: inline static void plus_inplace(Mat& out, const subview& in); Chris@49: inline static void minus_inplace(Mat& out, const subview& in); Chris@49: inline static void schur_inplace(Mat& out, const subview& in); Chris@49: inline static void div_inplace(Mat& out, const subview& in); Chris@49: */ Chris@49: Chris@49: inline void fill(const eT val); Chris@49: inline void zeros(); Chris@49: inline void ones(); Chris@49: inline void eye(); Chris@49: Chris@49: arma_hot inline SpValProxy > operator[](const uword i); Chris@49: arma_hot inline eT operator[](const uword i) const; Chris@49: Chris@49: arma_hot inline SpValProxy > operator()(const uword i); Chris@49: arma_hot inline eT operator()(const uword i) const; Chris@49: Chris@49: arma_hot inline SpValProxy > operator()(const uword in_row, const uword in_col); Chris@49: arma_hot inline eT operator()(const uword in_row, const uword in_col) const; Chris@49: Chris@49: arma_hot inline SpValProxy > at(const uword i); Chris@49: arma_hot inline eT at(const uword i) const; Chris@49: Chris@49: arma_hot inline SpValProxy > at(const uword in_row, const uword in_col); Chris@49: arma_hot inline eT at(const uword in_row, const uword in_col) const; Chris@49: Chris@49: inline bool check_overlap(const SpSubview& x) const; Chris@49: Chris@49: inline bool is_vec() const; Chris@49: Chris@49: inline SpSubview row(const uword row_num); Chris@49: inline const SpSubview row(const uword row_num) const; Chris@49: Chris@49: inline SpSubview col(const uword col_num); Chris@49: inline const SpSubview col(const uword col_num) const; Chris@49: Chris@49: inline SpSubview rows(const uword in_row1, const uword in_row2); Chris@49: inline const SpSubview rows(const uword in_row1, const uword in_row2) const; Chris@49: Chris@49: inline SpSubview cols(const uword in_col1, const uword in_col2); Chris@49: inline const SpSubview cols(const uword in_col1, const uword in_col2) const; Chris@49: Chris@49: inline SpSubview submat(const uword in_row1, const uword in_col1, const uword in_row2, const uword in_col2); Chris@49: inline const SpSubview submat(const uword in_row1, const uword in_col1, const uword in_row2, const uword in_col2) const; Chris@49: Chris@49: inline SpSubview submat(const span& row_span, const span& col_span); Chris@49: inline const SpSubview submat(const span& row_span, const span& col_span) const; Chris@49: Chris@49: inline SpSubview operator()(const uword row_num, const span& col_span); Chris@49: inline const SpSubview operator()(const uword row_num, const span& col_span) const; Chris@49: Chris@49: inline SpSubview operator()(const span& row_span, const uword col_num); Chris@49: inline const SpSubview operator()(const span& row_span, const uword col_num) const; Chris@49: Chris@49: inline SpSubview operator()(const span& row_span, const span& col_span); Chris@49: inline const SpSubview operator()(const span& row_span, const span& col_span) const; Chris@49: Chris@49: /* not yet Chris@49: inline SpSubview_row row(const uword row_num); Chris@49: inline const SpSubview_row row(const uword row_num) const; Chris@49: Chris@49: inline SpSubview_row operator()(const uword row_num, const span& col_span); Chris@49: inline const SpSubview_row operator()(const uword row_num, const span& col_span) const; Chris@49: Chris@49: inline SpSubview_col col(const uword col_num); Chris@49: inline const SpSubview_col col(const uword col_num) const; Chris@49: Chris@49: inline SpSubview_col operator()(const span& row_span, const uword col_num); Chris@49: inline const SpSubview_col operator()(const span& row_span, const uword col_num) const; Chris@49: Chris@49: inline Col unsafe_col(const uword col_num); Chris@49: inline const Col unsafe_col(const uword col_num) const; Chris@49: Chris@49: inline SpSubview rows(const uword in_row1, const uword in_row2); Chris@49: inline const SpSubview rows(const uword in_row1, const uword in_row2) const; Chris@49: Chris@49: inline SpSubview cols(const uword in_col1, const uword in_col2); Chris@49: inline const SpSubview cols(const uword in_col1, const uword in_col2) const; Chris@49: Chris@49: inline SpSubview submat(const uword in_row1, const uword in_col1, const uword in_row2, const uword in_col2); Chris@49: inline const SpSubview submat(const uword in_row1, const uword in_col1, const uword in_row2, const uword in_col2) const; Chris@49: Chris@49: inline SpSubview submat (const span& row_span, const span& col_span); Chris@49: inline const SpSubview submat (const span& row_span, const span& col_span) const; Chris@49: Chris@49: inline SpSubview operator()(const span& row_span, const span& col_span); Chris@49: inline const SpSubview operator()(const span& row_span, const span& col_span) const; Chris@49: Chris@49: inline diagview diag(const s32 in_id = 0); Chris@49: inline const diagview diag(const s32 in_id = 0) const; Chris@49: */ Chris@49: Chris@49: inline void swap_rows(const uword in_row1, const uword in_row2); Chris@49: inline void swap_cols(const uword in_col1, const uword in_col2); Chris@49: Chris@49: // Forward declarations. Chris@49: class iterator_base; Chris@49: class const_iterator; Chris@49: class iterator; Chris@49: class const_row_iterator; Chris@49: class row_iterator; Chris@49: Chris@49: // Similar to SpMat iterators but automatically iterates past and ignores values not in the subview. Chris@49: class iterator_base Chris@49: { Chris@49: public: Chris@49: Chris@49: inline iterator_base(const SpSubview& in_M); Chris@49: inline iterator_base(const SpSubview& in_M, const uword col, const uword pos, const uword skip_pos); Chris@49: Chris@49: inline eT operator*() const; Chris@49: Chris@49: // Don't hold location internally; call "dummy" methods to get that information. Chris@49: arma_inline uword row() const { return M.m.row_indices[internal_pos + skip_pos] - M.aux_row1; } Chris@49: arma_inline uword col() const { return internal_col; } Chris@49: arma_inline uword pos() const { return internal_pos; } Chris@49: Chris@49: arma_aligned const SpSubview& M; Chris@49: arma_aligned uword internal_col; Chris@49: arma_aligned uword internal_pos; Chris@49: arma_aligned uword skip_pos; // not used in row_iterator or const_row_iterator Chris@49: Chris@49: // So that we satisfy the STL iterator types. Chris@49: typedef std::bidirectional_iterator_tag iterator_category; Chris@49: typedef eT value_type; Chris@49: typedef uword difference_type; // not certain on this one Chris@49: typedef const eT* pointer; Chris@49: typedef const eT& reference; Chris@49: }; Chris@49: Chris@49: class const_iterator : public iterator_base Chris@49: { Chris@49: public: Chris@49: Chris@49: inline const_iterator(const SpSubview& in_M, uword initial_pos = 0); Chris@49: inline const_iterator(const SpSubview& in_M, uword in_row, uword in_col); Chris@49: inline const_iterator(const SpSubview& in_M, uword in_row, uword in_col, uword in_pos, uword skip_pos); Chris@49: inline const_iterator(const const_iterator& other); Chris@49: Chris@49: inline const_iterator& operator++(); Chris@49: inline const_iterator operator++(int); Chris@49: Chris@49: inline const_iterator& operator--(); Chris@49: inline const_iterator operator--(int); Chris@49: Chris@49: inline bool operator!=(const const_iterator& rhs) const; Chris@49: inline bool operator==(const const_iterator& rhs) const; Chris@49: Chris@49: inline bool operator!=(const typename SpMat::const_iterator& rhs) const; Chris@49: inline bool operator==(const typename SpMat::const_iterator& rhs) const; Chris@49: Chris@49: inline bool operator!=(const const_row_iterator& rhs) const; Chris@49: inline bool operator==(const const_row_iterator& rhs) const; Chris@49: Chris@49: inline bool operator!=(const typename SpMat::const_row_iterator& rhs) const; Chris@49: inline bool operator==(const typename SpMat::const_row_iterator& rhs) const; Chris@49: }; Chris@49: Chris@49: class iterator : public const_iterator Chris@49: { Chris@49: public: Chris@49: Chris@49: inline iterator(SpSubview& in_M, const uword initial_pos = 0) : const_iterator(in_M, initial_pos) { } Chris@49: inline iterator(SpSubview& in_M, const uword in_row, const uword in_col) : const_iterator(in_M, in_row, in_col) { } Chris@49: inline iterator(SpSubview& in_M, const uword in_row, const uword in_col, const uword in_pos, const uword in_skip_pos) : const_iterator(in_M, in_row, in_col, in_pos, in_skip_pos) { } Chris@49: inline iterator(const iterator& other) : const_iterator(other) { } Chris@49: Chris@49: inline SpValProxy > operator*(); Chris@49: Chris@49: // overloads needed for return type correctness Chris@49: inline iterator& operator++(); Chris@49: inline iterator operator++(int); Chris@49: Chris@49: inline iterator& operator--(); Chris@49: inline iterator operator--(int); Chris@49: Chris@49: // This has a different value_type than iterator_base. Chris@49: typedef SpValProxy > value_type; Chris@49: typedef const SpValProxy >* pointer; Chris@49: typedef const SpValProxy >& reference; Chris@49: }; Chris@49: Chris@49: class const_row_iterator : public iterator_base Chris@49: { Chris@49: public: Chris@49: Chris@49: inline const_row_iterator(const SpSubview& in_M, uword initial_pos = 0); Chris@49: inline const_row_iterator(const SpSubview& in_M, uword in_row, uword in_col); Chris@49: inline const_row_iterator(const const_row_iterator& other); Chris@49: Chris@49: inline const_row_iterator& operator++(); Chris@49: inline const_row_iterator operator++(int); Chris@49: Chris@49: inline const_row_iterator& operator--(); Chris@49: inline const_row_iterator operator--(int); Chris@49: Chris@49: uword internal_row; // Hold row internally because we use internal_pos differently. Chris@49: uword actual_pos; // Actual position in subview's parent matrix. Chris@49: Chris@49: arma_inline eT operator*() const { return iterator_base::M.m.values[actual_pos]; } Chris@49: Chris@49: arma_inline uword row() const { return internal_row; } Chris@49: Chris@49: inline bool operator!=(const const_iterator& rhs) const; Chris@49: inline bool operator==(const const_iterator& rhs) const; Chris@49: Chris@49: inline bool operator!=(const typename SpMat::const_iterator& rhs) const; Chris@49: inline bool operator==(const typename SpMat::const_iterator& rhs) const; Chris@49: Chris@49: inline bool operator!=(const const_row_iterator& rhs) const; Chris@49: inline bool operator==(const const_row_iterator& rhs) const; Chris@49: Chris@49: inline bool operator!=(const typename SpMat::const_row_iterator& rhs) const; Chris@49: inline bool operator==(const typename SpMat::const_row_iterator& rhs) const; Chris@49: }; Chris@49: Chris@49: class row_iterator : public const_row_iterator Chris@49: { Chris@49: public: Chris@49: Chris@49: inline row_iterator(SpSubview& in_M, uword initial_pos = 0) : const_row_iterator(in_M, initial_pos) { } Chris@49: inline row_iterator(SpSubview& in_M, uword in_row, uword in_col) : const_row_iterator(in_M, in_row, in_col) { } Chris@49: inline row_iterator(const row_iterator& other) : const_row_iterator(other) { } Chris@49: Chris@49: inline SpValProxy > operator*(); Chris@49: Chris@49: // overloads needed for return type correctness Chris@49: inline row_iterator& operator++(); Chris@49: inline row_iterator operator++(int); Chris@49: Chris@49: inline row_iterator& operator--(); Chris@49: inline row_iterator operator--(int); Chris@49: Chris@49: // This has a different value_type than iterator_base. Chris@49: typedef SpValProxy > value_type; Chris@49: typedef const SpValProxy >* pointer; Chris@49: typedef const SpValProxy >& reference; Chris@49: }; Chris@49: Chris@49: inline iterator begin(); Chris@49: inline const_iterator begin() const; Chris@49: Chris@49: inline iterator begin_col(const uword col_num); Chris@49: inline const_iterator begin_col(const uword col_num) const; Chris@49: Chris@49: inline row_iterator begin_row(const uword row_num = 0); Chris@49: inline const_row_iterator begin_row(const uword row_num = 0) const; Chris@49: Chris@49: inline iterator end(); Chris@49: inline const_iterator end() const; Chris@49: Chris@49: inline row_iterator end_row(); Chris@49: inline const_row_iterator end_row() const; Chris@49: Chris@49: inline row_iterator end_row(const uword row_num = 0); Chris@49: inline const_row_iterator end_row(const uword row_num = 0) const; Chris@49: Chris@49: Chris@49: private: Chris@49: friend class SpMat; Chris@49: SpSubview(); Chris@49: Chris@49: // For use by SpValProxy. We just update n_nonzero and pass the call on to the matrix. Chris@49: inline arma_hot arma_warn_unused eT& add_element(const uword in_row, const uword in_col, const eT in_val = 0.0); Chris@49: inline arma_hot void delete_element(const uword in_row, const uword in_col); Chris@49: Chris@49: }; Chris@49: Chris@49: /* Chris@49: template Chris@49: class SpSubview_col : public SpSubview Chris@49: { Chris@49: public: Chris@49: Chris@49: typedef eT elem_type; Chris@49: typedef typename get_pod_type::result pod_type; Chris@49: Chris@49: inline void operator= (const SpSubview& x); Chris@49: inline void operator= (const SpSubview_col& x); Chris@49: Chris@49: template Chris@49: inline void operator= (const Base& x); Chris@49: Chris@49: inline SpSubview_col rows(const uword in_row1, const uword in_row2); Chris@49: inline const SpSubview_col rows(const uword in_row1, const uword in_row2) const; Chris@49: Chris@49: inline SpSubview_col subvec(const uword in_row1, const uword in_row2); Chris@49: inline const SpSubview_col subvec(const uword in_row1, const uword in_row2) const; Chris@49: Chris@49: Chris@49: protected: Chris@49: Chris@49: inline SpSubview_col(const Mat& in_m, const uword in_col); Chris@49: inline SpSubview_col( Mat& in_m, const uword in_col); Chris@49: Chris@49: inline SpSubview_col(const Mat& in_m, const uword in_col, const uword in_row1, const uword in_n_rows); Chris@49: inline SpSubview_col( Mat& in_m, const uword in_col, const uword in_row1, const uword in_n_rows); Chris@49: Chris@49: Chris@49: private: Chris@49: Chris@49: friend class Mat; Chris@49: friend class Col; Chris@49: friend class SpSubview; Chris@49: Chris@49: SpSubview_col(); Chris@49: }; Chris@49: Chris@49: template Chris@49: class SpSubview_row : public SpSubview Chris@49: { Chris@49: public: Chris@49: Chris@49: typedef eT elem_type; Chris@49: typedef typename get_pod_type::result pod_type; Chris@49: Chris@49: inline void operator= (const SpSubview& x); Chris@49: inline void operator= (const SpSubview_row& x); Chris@49: Chris@49: template Chris@49: inline void operator= (const Base& x); Chris@49: Chris@49: inline SpSubview_row cols(const uword in_col1, const uword in_col2); Chris@49: inline const SpSubview_row cols(const uword in_col1, const uword in_col2) const; Chris@49: Chris@49: inline SpSubview_row subvec(const uword in_col1, const uword in_col2); Chris@49: inline const SpSubview_row subvec(const uword in_col1, const uword in_col2) const; Chris@49: Chris@49: Chris@49: protected: Chris@49: Chris@49: inline SpSubview_row(const Mat& in_m, const uword in_row); Chris@49: inline SpSubview_row( Mat& in_m, const uword in_row); Chris@49: Chris@49: inline SpSubview_row(const Mat& in_m, const uword in_row, const uword in_col1, const uword in_n_cols); Chris@49: inline SpSubview_row( Mat& in_m, const uword in_row, const uword in_col1, const uword in_n_cols); Chris@49: Chris@49: Chris@49: private: Chris@49: Chris@49: friend class Mat; Chris@49: friend class Row; Chris@49: friend class SpSubview; Chris@49: Chris@49: SpSubview_row(); Chris@49: }; Chris@49: */ Chris@49: Chris@49: //! @}