Chris@49: // Copyright (C) 2010-2013 NICTA (www.nicta.com.au)
Chris@49: // Copyright (C) 2010-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 ProxyCube
Chris@49: //! @{
Chris@49: 
Chris@49: 
Chris@49: 
Chris@49: template<typename T1>
Chris@49: class ProxyCube
Chris@49:   {
Chris@49:   public:
Chris@49:   inline ProxyCube(const T1&)
Chris@49:     {
Chris@49:     arma_type_check(( is_arma_cube_type<T1>::value == false ));
Chris@49:     }
Chris@49:   };
Chris@49: 
Chris@49: 
Chris@49: 
Chris@49: // ea_type is the "element accessor" type,
Chris@49: // which can provide access to elements via operator[]
Chris@49: 
Chris@49: template<typename eT>
Chris@49: class ProxyCube< 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:   typedef Cube<eT>                                 stored_type;
Chris@49:   typedef const eT*                                ea_type;
Chris@49:   typedef const Cube<eT>&                          aligned_ea_type;
Chris@49:   
Chris@49:   static const bool prefer_at_accessor = false;
Chris@49:   static const bool has_subview        = false;
Chris@49:   
Chris@49:   arma_aligned const Cube<eT>& Q;
Chris@49:   
Chris@49:   inline explicit ProxyCube(const Cube<eT>& A)
Chris@49:     : Q(A)
Chris@49:     {
Chris@49:     arma_extra_debug_sigprint();
Chris@49:     }
Chris@49:   
Chris@49:   arma_inline uword get_n_rows()       const { return Q.n_rows;       }
Chris@49:   arma_inline uword get_n_cols()       const { return Q.n_cols;       }
Chris@49:   arma_inline uword get_n_elem_slice() const { return Q.n_elem_slice; }
Chris@49:   arma_inline uword get_n_slices()     const { return Q.n_slices;     }
Chris@49:   arma_inline uword get_n_elem()       const { return Q.n_elem;       }
Chris@49:   
Chris@49:   arma_inline elem_type operator[] (const uword i)                                       const { return Q[i];                  }
Chris@49:   arma_inline elem_type at         (const uword row, const uword col, const uword slice) const { return Q.at(row, col, slice); }
Chris@49:   arma_inline elem_type at_alt     (const uword i)                                       const { return Q.at_alt(i);           }
Chris@49:   
Chris@49:   arma_inline         ea_type         get_ea() const { return Q.memptr(); }
Chris@49:   arma_inline aligned_ea_type get_aligned_ea() const { return Q;          }
Chris@49:   
Chris@49:   template<typename eT2>
Chris@49:   arma_inline bool is_alias(const Cube<eT2>& X) const { return (void_ptr(&Q) == void_ptr(&X)); }
Chris@49:   
Chris@49:   arma_inline bool is_aligned() const { return memory::is_aligned(Q.memptr()); }
Chris@49:   };
Chris@49: 
Chris@49: 
Chris@49: 
Chris@49: template<typename eT, typename gen_type>
Chris@49: class ProxyCube< GenCube<eT, gen_type > >
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:   typedef GenCube<eT, gen_type>                    stored_type;
Chris@49:   typedef const GenCube<eT, gen_type>&             ea_type;
Chris@49:   typedef const GenCube<eT, gen_type>&             aligned_ea_type;
Chris@49:   
Chris@49:   static const bool prefer_at_accessor = false;
Chris@49:   static const bool has_subview        = false;
Chris@49:   
Chris@49:   arma_aligned const GenCube<eT, gen_type>& Q;
Chris@49:   
Chris@49:   inline explicit ProxyCube(const GenCube<eT, gen_type>& A)
Chris@49:     : Q(A)
Chris@49:     {
Chris@49:     arma_extra_debug_sigprint();
Chris@49:     }
Chris@49:   
Chris@49:   arma_inline uword get_n_rows()       const { return Q.n_rows;                     }
Chris@49:   arma_inline uword get_n_cols()       const { return Q.n_cols;                     }
Chris@49:   arma_inline uword get_n_elem_slice() const { return Q.n_rows*Q.n_cols;            }
Chris@49:   arma_inline uword get_n_slices()     const { return Q.n_slices;                   }
Chris@49:   arma_inline uword get_n_elem()       const { return Q.n_rows*Q.n_cols*Q.n_slices; }
Chris@49:   
Chris@49:   arma_inline elem_type operator[] (const uword i)                                       const { return Q[i];                  }
Chris@49:   arma_inline elem_type at         (const uword row, const uword col, const uword slice) const { return Q.at(row, col, slice); }
Chris@49:   arma_inline elem_type at_alt     (const uword i)                                       const { return Q[i];                  }
Chris@49:   
Chris@49:   arma_inline         ea_type         get_ea() const { return Q; }
Chris@49:   arma_inline aligned_ea_type get_aligned_ea() const { return Q; }
Chris@49:   
Chris@49:   template<typename eT2>
Chris@49:   arma_inline bool is_alias(const Cube<eT2>&) const { return false; }
Chris@49:   
Chris@49:   arma_inline bool is_aligned() const { return GenCube<eT, gen_type>::is_simple; }
Chris@49:   };
Chris@49: 
Chris@49: 
Chris@49: 
Chris@49: template<typename T1, typename op_type>
Chris@49: class ProxyCube< OpCube<T1, op_type> >
Chris@49:   {
Chris@49:   public:
Chris@49:   
Chris@49:   typedef typename T1::elem_type                   elem_type;
Chris@49:   typedef typename get_pod_type<elem_type>::result pod_type;
Chris@49:   typedef Cube<elem_type>                          stored_type;
Chris@49:   typedef const elem_type*                         ea_type;
Chris@49:   typedef const Cube<elem_type>&                   aligned_ea_type;
Chris@49:   
Chris@49:   static const bool prefer_at_accessor = false;
Chris@49:   static const bool has_subview        = false;
Chris@49:   
Chris@49:   arma_aligned const Cube<elem_type> Q;
Chris@49:   
Chris@49:   inline explicit ProxyCube(const OpCube<T1, op_type>& A)
Chris@49:     : Q(A)
Chris@49:     {
Chris@49:     arma_extra_debug_sigprint();
Chris@49:     }
Chris@49:   
Chris@49:   arma_inline uword get_n_rows()       const { return Q.n_rows;       }
Chris@49:   arma_inline uword get_n_cols()       const { return Q.n_cols;       }
Chris@49:   arma_inline uword get_n_elem_slice() const { return Q.n_elem_slice; }
Chris@49:   arma_inline uword get_n_slices()     const { return Q.n_slices;     }
Chris@49:   arma_inline uword get_n_elem()       const { return Q.n_elem;       }
Chris@49:   
Chris@49:   arma_inline elem_type operator[] (const uword i)                                       const { return Q[i];                  }
Chris@49:   arma_inline elem_type at         (const uword row, const uword col, const uword slice) const { return Q.at(row, col, slice); }
Chris@49:   arma_inline elem_type at_alt     (const uword i)                                       const { return Q.at_alt(i);           }
Chris@49:   
Chris@49:   arma_inline         ea_type         get_ea() const { return Q.memptr(); }
Chris@49:   arma_inline aligned_ea_type get_aligned_ea() const { return Q;          }
Chris@49:   
Chris@49:   template<typename eT2>
Chris@49:   arma_inline bool is_alias(const Cube<eT2>&) const { return false; }
Chris@49:   
Chris@49:   arma_inline bool is_aligned() const { return memory::is_aligned(Q.memptr()); }
Chris@49:   };
Chris@49: 
Chris@49: 
Chris@49: 
Chris@49: template<typename T1, typename T2, typename glue_type>
Chris@49: class ProxyCube< GlueCube<T1, T2, glue_type> >
Chris@49:   {
Chris@49:   public:
Chris@49:   
Chris@49:   typedef typename T1::elem_type                   elem_type;
Chris@49:   typedef typename get_pod_type<elem_type>::result pod_type;
Chris@49:   typedef Cube<elem_type>                          stored_type;
Chris@49:   typedef const elem_type*                         ea_type;
Chris@49:   typedef const Cube<elem_type>&                   aligned_ea_type;
Chris@49:   
Chris@49:   static const bool prefer_at_accessor = false;
Chris@49:   static const bool has_subview        = false;
Chris@49:   
Chris@49:   arma_aligned const Cube<elem_type> Q;
Chris@49:   
Chris@49:   inline explicit ProxyCube(const GlueCube<T1, T2, glue_type>& A)
Chris@49:     : Q(A)
Chris@49:     {
Chris@49:     arma_extra_debug_sigprint();
Chris@49:     }
Chris@49: 
Chris@49:   arma_inline uword get_n_rows()       const { return Q.n_rows;       }
Chris@49:   arma_inline uword get_n_cols()       const { return Q.n_cols;       }
Chris@49:   arma_inline uword get_n_elem_slice() const { return Q.n_elem_slice; }
Chris@49:   arma_inline uword get_n_slices()     const { return Q.n_slices;     }
Chris@49:   arma_inline uword get_n_elem()       const { return Q.n_elem;       }
Chris@49:   
Chris@49:   arma_inline elem_type operator[] (const uword i)                                       const { return Q[i];                  }
Chris@49:   arma_inline elem_type at         (const uword row, const uword col, const uword slice) const { return Q.at(row, col, slice); }
Chris@49:   arma_inline elem_type at_alt     (const uword i)                                       const { return Q.at_alt(i);           }
Chris@49:   
Chris@49:   arma_inline         ea_type         get_ea() const { return Q.memptr(); }
Chris@49:   arma_inline aligned_ea_type get_aligned_ea() const { return Q;          }
Chris@49:   
Chris@49:   template<typename eT2>
Chris@49:   arma_inline bool is_alias(const Cube<eT2>&) const { return false; }
Chris@49:   
Chris@49:   arma_inline bool is_aligned() const { return memory::is_aligned(Q.memptr()); }
Chris@49:   };
Chris@49: 
Chris@49: 
Chris@49: 
Chris@49: template<typename eT>
Chris@49: class ProxyCube< 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:   typedef subview_cube<eT>                         stored_type;
Chris@49:   typedef const subview_cube<eT>&                  ea_type;
Chris@49:   typedef const subview_cube<eT>&                  aligned_ea_type;
Chris@49:   
Chris@49:   static const bool prefer_at_accessor = true;
Chris@49:   static const bool has_subview        = true;
Chris@49:   
Chris@49:   arma_aligned const subview_cube<eT>& Q;
Chris@49:   
Chris@49:   inline explicit ProxyCube(const subview_cube<eT>& A)
Chris@49:     : Q(A)
Chris@49:     {
Chris@49:     arma_extra_debug_sigprint();
Chris@49:     }
Chris@49:   
Chris@49:   arma_inline uword get_n_rows()       const { return Q.n_rows;       }
Chris@49:   arma_inline uword get_n_cols()       const { return Q.n_cols;       }
Chris@49:   arma_inline uword get_n_elem_slice() const { return Q.n_elem_slice; }
Chris@49:   arma_inline uword get_n_slices()     const { return Q.n_slices;     }
Chris@49:   arma_inline uword get_n_elem()       const { return Q.n_elem;       }
Chris@49:   
Chris@49:   arma_inline elem_type operator[] (const uword i)                                       const { return Q[i];                  }
Chris@49:   arma_inline elem_type at         (const uword row, const uword col, const uword slice) const { return Q.at(row, col, slice); }
Chris@49:   arma_inline elem_type at_alt     (const uword i)                                       const { return Q.at_alt(i);           }
Chris@49:   
Chris@49:   arma_inline         ea_type         get_ea() const { return Q; }
Chris@49:   arma_inline aligned_ea_type get_aligned_ea() const { return Q; }
Chris@49:   
Chris@49:   template<typename eT2>
Chris@49:   arma_inline bool is_alias(const Cube<eT2>& X) const { return (void_ptr(&(Q.m)) == void_ptr(&X)); }
Chris@49:   
Chris@49:   arma_inline bool is_aligned() const { return false; }
Chris@49:   };
Chris@49: 
Chris@49: 
Chris@49: 
Chris@49: template<typename T1, typename eop_type>
Chris@49: class ProxyCube< eOpCube<T1, eop_type > >
Chris@49:   {
Chris@49:   public:
Chris@49:   
Chris@49:   typedef typename T1::elem_type                   elem_type;
Chris@49:   typedef typename get_pod_type<elem_type>::result pod_type;
Chris@49:   typedef eOpCube<T1, eop_type>                    stored_type;
Chris@49:   typedef const eOpCube<T1, eop_type>&             ea_type;
Chris@49:   typedef const eOpCube<T1, eop_type>&             aligned_ea_type;
Chris@49:   
Chris@49:   static const bool prefer_at_accessor = eOpCube<T1, eop_type>::prefer_at_accessor;
Chris@49:   static const bool has_subview        = eOpCube<T1, eop_type>::has_subview;
Chris@49:   
Chris@49:   arma_aligned const eOpCube<T1, eop_type>& Q;
Chris@49:   
Chris@49:   inline explicit ProxyCube(const eOpCube<T1, eop_type>& A)
Chris@49:     : Q(A)
Chris@49:     {
Chris@49:     arma_extra_debug_sigprint();
Chris@49:     }
Chris@49:   
Chris@49:   arma_inline uword get_n_rows()       const { return Q.get_n_rows();       }
Chris@49:   arma_inline uword get_n_cols()       const { return Q.get_n_cols();       }
Chris@49:   arma_inline uword get_n_elem_slice() const { return Q.get_n_elem_slice(); }
Chris@49:   arma_inline uword get_n_slices()     const { return Q.get_n_slices();     }
Chris@49:   arma_inline uword get_n_elem()       const { return Q.get_n_elem();       }
Chris@49:   
Chris@49:   arma_inline elem_type operator[] (const uword i)                                       const { return Q[i];                  }
Chris@49:   arma_inline elem_type at         (const uword row, const uword col, const uword slice) const { return Q.at(row, col, slice); }
Chris@49:   arma_inline elem_type at_alt     (const uword i)                                       const { return Q.at_alt(i);           }
Chris@49:   
Chris@49:   arma_inline         ea_type         get_ea() const { return Q; }
Chris@49:   arma_inline aligned_ea_type get_aligned_ea() const { return Q; }
Chris@49:   
Chris@49:   template<typename eT2>
Chris@49:   arma_inline bool is_alias(const Cube<eT2>& X) const { return Q.P.is_alias(X); }
Chris@49:   
Chris@49:   arma_inline bool is_aligned() const { return Q.P.is_aligned(); }
Chris@49:   };
Chris@49: 
Chris@49: 
Chris@49: 
Chris@49: template<typename T1, typename T2, typename eglue_type>
Chris@49: class ProxyCube< eGlueCube<T1, T2, eglue_type > >
Chris@49:   {
Chris@49:   public:
Chris@49:   
Chris@49:   typedef typename T1::elem_type                   elem_type;
Chris@49:   typedef typename get_pod_type<elem_type>::result pod_type;
Chris@49:   typedef eGlueCube<T1, T2, eglue_type>            stored_type;
Chris@49:   typedef const eGlueCube<T1, T2, eglue_type>&     ea_type;
Chris@49:   typedef const eGlueCube<T1, T2, eglue_type>&     aligned_ea_type;
Chris@49:   
Chris@49:   static const bool prefer_at_accessor = eGlueCube<T1, T2, eglue_type>::prefer_at_accessor;
Chris@49:   static const bool has_subview        = eGlueCube<T1, T2, eglue_type>::has_subview;
Chris@49:   
Chris@49:   arma_aligned const eGlueCube<T1, T2, eglue_type>& Q;
Chris@49:   
Chris@49:   inline explicit ProxyCube(const eGlueCube<T1, T2, eglue_type>& A)
Chris@49:     : Q(A)
Chris@49:     {
Chris@49:     arma_extra_debug_sigprint();
Chris@49:     }
Chris@49:   
Chris@49:   arma_inline uword get_n_rows()       const { return Q.get_n_rows();       }
Chris@49:   arma_inline uword get_n_cols()       const { return Q.get_n_cols();       }
Chris@49:   arma_inline uword get_n_elem_slice() const { return Q.get_n_elem_slice(); }
Chris@49:   arma_inline uword get_n_slices()     const { return Q.get_n_slices();     }
Chris@49:   arma_inline uword get_n_elem()       const { return Q.get_n_elem();       }
Chris@49:   
Chris@49:   arma_inline elem_type operator[] (const uword i)                                       const { return Q[i];                  }
Chris@49:   arma_inline elem_type at         (const uword row, const uword col, const uword slice) const { return Q.at(row, col, slice); }
Chris@49:   arma_inline elem_type at_alt     (const uword i)                                       const { return Q.at_alt(i);           }
Chris@49:   
Chris@49:   arma_inline         ea_type         get_ea() const { return Q; }
Chris@49:   arma_inline aligned_ea_type get_aligned_ea() const { return Q; }
Chris@49:   
Chris@49:   template<typename eT2>
Chris@49:   arma_inline bool is_alias(const Cube<eT2>& X) const { return (Q.P1.is_alias(X) || Q.P2.is_alias(X)); }
Chris@49:   
Chris@49:   arma_inline bool is_aligned() const { return Q.P1.is_aligned() && Q.P2.is_aligned(); }
Chris@49:   };
Chris@49: 
Chris@49: 
Chris@49: 
Chris@49: template<typename out_eT, typename T1, typename op_type>
Chris@49: class ProxyCube< mtOpCube<out_eT, T1, op_type> >
Chris@49:   {
Chris@49:   public:
Chris@49:   
Chris@49:   typedef          out_eT                       elem_type;
Chris@49:   typedef typename get_pod_type<out_eT>::result pod_type;
Chris@49:   typedef          Cube<out_eT>                 stored_type;
Chris@49:   typedef          const elem_type*             ea_type;
Chris@49:   typedef          const Cube<out_eT>&          aligned_ea_type;
Chris@49:   
Chris@49:   static const bool prefer_at_accessor = false;
Chris@49:   static const bool has_subview        = false;
Chris@49:   
Chris@49:   arma_aligned const Cube<out_eT> Q;
Chris@49:   
Chris@49:   inline explicit ProxyCube(const mtOpCube<out_eT, T1, op_type>& A)
Chris@49:     : Q(A)
Chris@49:     {
Chris@49:     arma_extra_debug_sigprint();
Chris@49:     }
Chris@49:   
Chris@49:   arma_inline uword get_n_rows()       const { return Q.n_rows;       }
Chris@49:   arma_inline uword get_n_cols()       const { return Q.n_cols;       }
Chris@49:   arma_inline uword get_n_elem_slice() const { return Q.n_elem_slice; }
Chris@49:   arma_inline uword get_n_slices()     const { return Q.n_slices;     }
Chris@49:   arma_inline uword get_n_elem()       const { return Q.n_elem;       }
Chris@49:   
Chris@49:   arma_inline elem_type operator[] (const uword i)                                       const { return Q[i];                  }
Chris@49:   arma_inline elem_type at         (const uword row, const uword col, const uword slice) const { return Q.at(row, col, slice); }
Chris@49:   arma_inline elem_type at_alt     (const uword i)                                       const { return Q.at_alt(i);           }
Chris@49:   
Chris@49:   arma_inline         ea_type         get_ea() const { return Q.memptr(); }
Chris@49:   arma_inline aligned_ea_type get_aligned_ea() const { return Q;          }
Chris@49:   
Chris@49:   template<typename eT2>
Chris@49:   arma_inline bool is_alias(const Cube<eT2>&) const { return false; }
Chris@49:   
Chris@49:   arma_inline bool is_aligned() const { return memory::is_aligned(Q.memptr()); }
Chris@49:   };
Chris@49: 
Chris@49: 
Chris@49: 
Chris@49: template<typename out_eT, typename T1, typename T2, typename glue_type>
Chris@49: class ProxyCube< mtGlueCube<out_eT, T1, T2, glue_type > >
Chris@49:   {
Chris@49:   public:
Chris@49:   
Chris@49:   typedef          out_eT                       elem_type;
Chris@49:   typedef typename get_pod_type<out_eT>::result pod_type;
Chris@49:   typedef          Cube<out_eT>                 stored_type;
Chris@49:   typedef          const elem_type*             ea_type;
Chris@49:   typedef          const Cube<out_eT>&          aligned_ea_type;
Chris@49:   
Chris@49:   static const bool prefer_at_accessor = false;
Chris@49:   static const bool has_subview        = false;
Chris@49:   
Chris@49:   arma_aligned const Cube<out_eT> Q;
Chris@49:   
Chris@49:   inline explicit ProxyCube(const mtGlueCube<out_eT, T1, T2, glue_type>& A)
Chris@49:     : Q(A)
Chris@49:     {
Chris@49:     arma_extra_debug_sigprint();
Chris@49:     }
Chris@49:   
Chris@49:   arma_inline uword get_n_rows()       const { return Q.n_rows;       }
Chris@49:   arma_inline uword get_n_cols()       const { return Q.n_cols;       }
Chris@49:   arma_inline uword get_n_elem_slice() const { return Q.n_elem_slice; }
Chris@49:   arma_inline uword get_n_slices()     const { return Q.n_slices;     }
Chris@49:   arma_inline uword get_n_elem()       const { return Q.n_elem;       }
Chris@49:   
Chris@49:   arma_inline elem_type operator[] (const uword i)                                       const { return Q[i];                  }
Chris@49:   arma_inline elem_type at         (const uword row, const uword col, const uword slice) const { return Q.at(row, col, slice); }
Chris@49:   arma_inline elem_type at_alt     (const uword i)                                       const { return Q.at_alt(i);           }
Chris@49:   
Chris@49:   arma_inline         ea_type         get_ea() const { return Q.memptr(); }
Chris@49:   arma_inline aligned_ea_type get_aligned_ea() const { return Q;          }
Chris@49:   
Chris@49:   template<typename eT2>
Chris@49:   arma_inline bool is_alias(const Cube<eT2>&) const { return false; }
Chris@49:   
Chris@49:   arma_inline bool is_aligned() const { return memory::is_aligned(Q.memptr()); }
Chris@49:   };
Chris@49: 
Chris@49: 
Chris@49: 
Chris@49: //! @}