Chris@49: // Copyright (C) 2008-2013 NICTA (www.nicta.com.au)
Chris@49: // Copyright (C) 2008-2013 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: 
Chris@49: //! \addtogroup subview_cube
Chris@49: //! @{
Chris@49: 
Chris@49: 
Chris@49: //! Class for storing data required to construct or apply operations to a subcube
Chris@49: //! (i.e. where the subcube starts and ends as well as a reference/pointer to the original cube),
Chris@49: template<typename eT>
Chris@49: class subview_cube : public BaseCube<eT, subview_cube<eT> >
Chris@49:   {
Chris@49:   public:    
Chris@49:   
Chris@49:   typedef eT                                       elem_type;
Chris@49:   typedef typename get_pod_type<elem_type>::result pod_type;
Chris@49:   
Chris@49:   arma_aligned const Cube<eT>& m;
Chris@49:   
Chris@49:   const uword aux_row1;
Chris@49:   const uword aux_col1;
Chris@49:   const uword aux_slice1;
Chris@49:   
Chris@49:   const uword n_rows;
Chris@49:   const uword n_cols;
Chris@49:   const uword n_elem_slice;
Chris@49:   const uword n_slices;
Chris@49:   const uword n_elem;
Chris@49:   
Chris@49:   
Chris@49:   protected:
Chris@49:   
Chris@49:   arma_inline subview_cube(const Cube<eT>& in_m, const uword in_row1, const uword in_col1, const uword in_slice1, const uword in_n_rows, const uword in_n_cols, const uword in_n_slices);
Chris@49:   
Chris@49:   
Chris@49:   public:
Chris@49:   
Chris@49:   inline ~subview_cube();
Chris@49:   
Chris@49:   inline void operator+= (const eT val);
Chris@49:   inline void operator-= (const eT val);
Chris@49:   inline void operator*= (const eT val);
Chris@49:   inline void operator/= (const eT val);
Chris@49:   
Chris@49:   // deliberately returning void
Chris@49:   template<typename T1> inline void operator=  (const BaseCube<eT,T1>& x);
Chris@49:   template<typename T1> inline void operator+= (const BaseCube<eT,T1>& x);
Chris@49:   template<typename T1> inline void operator-= (const BaseCube<eT,T1>& x);
Chris@49:   template<typename T1> inline void operator%= (const BaseCube<eT,T1>& x);
Chris@49:   template<typename T1> inline void operator/= (const BaseCube<eT,T1>& x);
Chris@49:   
Chris@49:   inline void operator=  (const subview_cube& x);
Chris@49:   inline void operator+= (const subview_cube& x);
Chris@49:   inline void operator-= (const subview_cube& x);
Chris@49:   inline void operator%= (const subview_cube& x);
Chris@49:   inline void operator/= (const subview_cube& x);
Chris@49:   
Chris@49:   template<typename T1> inline void operator=  (const Base<eT,T1>& x);
Chris@49:   template<typename T1> inline void operator+= (const Base<eT,T1>& x);
Chris@49:   template<typename T1> inline void operator-= (const Base<eT,T1>& x);
Chris@49:   template<typename T1> inline void operator%= (const Base<eT,T1>& x);
Chris@49:   template<typename T1> inline void operator/= (const Base<eT,T1>& x);
Chris@49: 
Chris@49:   inline static void       extract(Cube<eT>& out, const subview_cube& in);
Chris@49:   inline static void  plus_inplace(Cube<eT>& out, const subview_cube& in);
Chris@49:   inline static void minus_inplace(Cube<eT>& out, const subview_cube& in);
Chris@49:   inline static void schur_inplace(Cube<eT>& out, const subview_cube& in);
Chris@49:   inline static void   div_inplace(Cube<eT>& out, const subview_cube& in);
Chris@49:   
Chris@49:   inline static void       extract(Mat<eT>& out, const subview_cube& in);
Chris@49:   inline static void  plus_inplace(Mat<eT>& out, const subview_cube& in);
Chris@49:   inline static void minus_inplace(Mat<eT>& out, const subview_cube& in);
Chris@49:   inline static void schur_inplace(Mat<eT>& out, const subview_cube& in);
Chris@49:   inline static void   div_inplace(Mat<eT>& out, const subview_cube& in);
Chris@49:   
Chris@49:   template<typename functor> inline void transform(functor F);
Chris@49:   template<typename functor> inline void     imbue(functor F);
Chris@49:   
Chris@49:   inline void fill(const eT val);
Chris@49:   inline void zeros();
Chris@49:   inline void ones();
Chris@49:   
Chris@49:   inline eT  at_alt    (const uword i) const;
Chris@49:   
Chris@49:   inline eT& operator[](const uword i);
Chris@49:   inline eT  operator[](const uword i) const;
Chris@49:   
Chris@49:   inline eT& operator()(const uword i);
Chris@49:   inline eT  operator()(const uword i) const;
Chris@49:   
Chris@49:   arma_inline eT& operator()(const uword in_row, const uword in_col, const uword in_slice);
Chris@49:   arma_inline eT  operator()(const uword in_row, const uword in_col, const uword in_slice) const;
Chris@49:   
Chris@49:   arma_inline eT&         at(const uword in_row, const uword in_col, const uword in_slice);
Chris@49:   arma_inline eT          at(const uword in_row, const uword in_col, const uword in_slice) const;
Chris@49:   
Chris@49:   arma_inline       eT* slice_colptr(const uword in_slice, const uword in_col);
Chris@49:   arma_inline const eT* slice_colptr(const uword in_slice, const uword in_col) const;
Chris@49:   
Chris@49:   inline bool check_overlap(const subview_cube& x) const;
Chris@49:   inline bool check_overlap(const Mat<eT>&      x) const;
Chris@49:   
Chris@49:   
Chris@49:   private:
Chris@49:   
Chris@49:   friend class  Mat<eT>;
Chris@49:   friend class Cube<eT>;
Chris@49:   
Chris@49:   subview_cube();
Chris@49:   };
Chris@49: 
Chris@49: 
Chris@49: 
Chris@49: //! @}