comparison armadillo-2.4.4/include/armadillo_bits/subview_cube_bones.hpp @ 0:8b6102e2a9b0

Armadillo Library

+// Copyright (C) 2008-2011 NICTA (www.nicta.com.au)
+// Copyright (C) 2008-2011 Conrad Sanderson
+// 
+// This file is part of the Armadillo C++ library.
+// It is provided without any warranty of fitness
+// for any purpose. You can redistribute this file
+// and/or modify it under the terms of the GNU
+// Lesser General Public License (LGPL) as published
+// by the Free Software Foundation, either version 3
+// of the License or (at your option) any later version.
+// (see http://www.opensource.org/licenses for more info)
+
+
+//! \addtogroup subview_cube
+//! @{
+
+
+//! Class for storing data required to construct or apply operations to a subcube
+//! (i.e. where the subcube starts and ends as well as a reference/pointer to the original cube),
+template<typename eT>
+class subview_cube : public BaseCube<eT, subview_cube<eT> >
+  {
+  public:    arma_aligned const Cube<eT>& m;
+  protected: arma_aligned       Cube<eT>* m_ptr;
+  
+  public:
+  
+  typedef eT                                       elem_type;
+  typedef typename get_pod_type<elem_type>::result pod_type;
+  
+  const uword aux_row1;
+  const uword aux_col1;
+  const uword aux_slice1;
+  
+  const uword n_rows;
+  const uword n_cols;
+  const uword n_elem_slice;
+  const uword n_slices;
+  const uword n_elem;
+  
+  
+  protected:
+  
+  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);
+  arma_inline subview_cube(      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);
+  
+  
+  public:
+  
+  inline ~subview_cube();
+  
+  inline void operator+= (const eT val);
+  inline void operator-= (const eT val);
+  inline void operator*= (const eT val);
+  inline void operator/= (const eT val);
+  
+  // deliberately returning void
+  template<typename T1> inline void operator=  (const BaseCube<eT,T1>& x);
+  template<typename T1> inline void operator+= (const BaseCube<eT,T1>& x);
+  template<typename T1> inline void operator-= (const BaseCube<eT,T1>& x);
+  template<typename T1> inline void operator%= (const BaseCube<eT,T1>& x);
+  template<typename T1> inline void operator/= (const BaseCube<eT,T1>& x);
+  
+  inline void operator=  (const subview_cube& x);
+  inline void operator+= (const subview_cube& x);
+  inline void operator-= (const subview_cube& x);
+  inline void operator%= (const subview_cube& x);
+  inline void operator/= (const subview_cube& x);
+  
+  template<typename T1> inline void operator=  (const Base<eT,T1>& x);
+  template<typename T1> inline void operator+= (const Base<eT,T1>& x);
+  template<typename T1> inline void operator-= (const Base<eT,T1>& x);
+  template<typename T1> inline void operator%= (const Base<eT,T1>& x);
+  template<typename T1> inline void operator/= (const Base<eT,T1>& x);
+
+  inline static void       extract(Cube<eT>& out, const subview_cube& in);
+  inline static void  plus_inplace(Cube<eT>& out, const subview_cube& in);
+  inline static void minus_inplace(Cube<eT>& out, const subview_cube& in);
+  inline static void schur_inplace(Cube<eT>& out, const subview_cube& in);
+  inline static void   div_inplace(Cube<eT>& out, const subview_cube& in);
+  
+  inline static void       extract(Mat<eT>& out, const subview_cube& in);
+  inline static void  plus_inplace(Mat<eT>& out, const subview_cube& in);
+  inline static void minus_inplace(Mat<eT>& out, const subview_cube& in);
+  inline static void schur_inplace(Mat<eT>& out, const subview_cube& in);
+  inline static void   div_inplace(Mat<eT>& out, const subview_cube& in);
+
+  inline void fill(const eT val);
+  inline void zeros();
+  inline void ones();
+  
+  inline eT& operator[](const uword i);
+  inline eT  operator[](const uword i) const;
+  
+  inline eT& operator()(const uword i);
+  inline eT  operator()(const uword i) const;
+  
+  arma_inline eT& operator()(const uword in_row, const uword in_col, const uword in_slice);
+  arma_inline eT  operator()(const uword in_row, const uword in_col, const uword in_slice) const;
+  
+  arma_inline eT&         at(const uword in_row, const uword in_col, const uword in_slice);
+  arma_inline eT          at(const uword in_row, const uword in_col, const uword in_slice) const;
+  
+  arma_inline       eT* slice_colptr(const uword in_slice, const uword in_col);
+  arma_inline const eT* slice_colptr(const uword in_slice, const uword in_col) const;
+  
+  inline bool check_overlap(const subview_cube& x) const;
+  inline bool check_overlap(const Mat<eT>&      x) const;
+  
+  
+  private:
+  
+  friend class  Mat<eT>;
+  friend class Cube<eT>;
+  
+  subview_cube();
+  };
+
+
+
+//! @}