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 Col
Chris@49: //! @{
Chris@49: 
Chris@49: //! Class for column vectors (matrices with only one column)
Chris@49: 
Chris@49: template<typename eT>
Chris@49: class Col : public Mat<eT>
Chris@49:   {
Chris@49:   public:
Chris@49:   
Chris@49:   typedef eT                                elem_type;
Chris@49:   typedef typename get_pod_type<eT>::result pod_type;
Chris@49:   
Chris@49:   static const bool is_col = true;
Chris@49:   static const bool is_row = false;
Chris@49:   
Chris@49:   inline          Col();
Chris@49:   inline          Col(const Col<eT>& X);
Chris@49:   inline explicit Col(const uword n_elem);
Chris@49:   inline          Col(const uword in_rows, const uword in_cols);
Chris@49:   
Chris@49:   inline                  Col(const char*        text);
Chris@49:   inline const Col& operator=(const char*        text);
Chris@49:   
Chris@49:   inline                  Col(const std::string& text);
Chris@49:   inline const Col& operator=(const std::string& text);
Chris@49:   
Chris@49:   inline                  Col(const std::vector<eT>& x);
Chris@49:   inline const Col& operator=(const std::vector<eT>& x);
Chris@49:   
Chris@49:   #if defined(ARMA_USE_CXX11)
Chris@49:   inline                  Col(const std::initializer_list<eT>& list);
Chris@49:   inline const Col& operator=(const std::initializer_list<eT>& list);
Chris@49:   #endif
Chris@49:   
Chris@49:   inline explicit Col(const SpCol<eT>& X);
Chris@49:   
Chris@49:   inline const Col& operator=(const eT val);
Chris@49:     
Chris@49:   template<typename T1> inline                   Col(const Base<eT,T1>& X);
Chris@49:   template<typename T1> inline const Col&  operator=(const Base<eT,T1>& X);
Chris@49:   
Chris@49:   inline Col(      eT* aux_mem, const uword aux_length, const bool copy_aux_mem = true, const bool strict = true);
Chris@49:   inline Col(const eT* aux_mem, const uword aux_length);
Chris@49:   
Chris@49:   template<typename T1, typename T2>
Chris@49:   inline explicit Col(const Base<pod_type,T1>& A, const Base<pod_type,T2>& B);
Chris@49:   
Chris@49:   template<typename T1> inline                  Col(const BaseCube<eT,T1>& X);
Chris@49:   template<typename T1> inline const Col& operator=(const BaseCube<eT,T1>& X);
Chris@49:   
Chris@49:   inline                  Col(const subview_cube<eT>& X);
Chris@49:   inline const Col& operator=(const subview_cube<eT>& X);
Chris@49:   
Chris@49:   inline mat_injector<Col> operator<<(const eT val);
Chris@49:   
Chris@49:   arma_inline const Op<Col<eT>,op_htrans>  t() const;
Chris@49:   arma_inline const Op<Col<eT>,op_htrans> ht() const;
Chris@49:   arma_inline const Op<Col<eT>,op_strans> st() const;
Chris@49:   
Chris@49:   arma_inline eT& row(const uword row_num);
Chris@49:   arma_inline eT  row(const uword row_num) const;
Chris@49:   
Chris@49:   arma_inline       subview_col<eT> rows(const uword in_row1, const uword in_row2);
Chris@49:   arma_inline const subview_col<eT> rows(const uword in_row1, const uword in_row2) const;
Chris@49:   
Chris@49:   arma_inline       subview_col<eT> subvec(const uword in_row1, const uword in_row2);
Chris@49:   arma_inline const subview_col<eT> subvec(const uword in_row1, const uword in_row2) const;
Chris@49:   
Chris@49:   arma_inline       subview_col<eT> subvec(const span& row_span);
Chris@49:   arma_inline const subview_col<eT> subvec(const span& row_span) const;
Chris@49:   
Chris@49:   using Mat<eT>::operator();
Chris@49:   
Chris@49:   arma_inline       subview_col<eT> operator()(const span& row_span);
Chris@49:   arma_inline const subview_col<eT> operator()(const span& row_span) const;
Chris@49:   
Chris@49:   
Chris@49:   inline void shed_row (const uword row_num);
Chris@49:   inline void shed_rows(const uword in_row1, const uword in_row2);
Chris@49:   
Chris@49:                         inline void insert_rows(const uword row_num, const uword N, const bool set_to_zero = true);
Chris@49:   template<typename T1> inline void insert_rows(const uword row_num, const Base<eT,T1>& X);
Chris@49:   
Chris@49:   
Chris@49:   arma_inline arma_warn_unused       eT& at(const uword i);
Chris@49:   arma_inline arma_warn_unused const eT& at(const uword i) const;
Chris@49:   
Chris@49:   arma_inline arma_warn_unused       eT& at(const uword in_row, const uword in_col);
Chris@49:   arma_inline arma_warn_unused const eT& at(const uword in_row, const uword in_col) const;
Chris@49:   
Chris@49:   
Chris@49:   typedef       eT*       row_iterator;
Chris@49:   typedef const eT* const_row_iterator;
Chris@49:   
Chris@49:   inline       row_iterator begin_row(const uword row_num);
Chris@49:   inline const_row_iterator begin_row(const uword row_num) const;
Chris@49:   
Chris@49:   inline       row_iterator end_row  (const uword row_num);
Chris@49:   inline const_row_iterator end_row  (const uword row_num) const;
Chris@49:   
Chris@49:   
Chris@49:   template<uword fixed_n_elem> class fixed;
Chris@49:   
Chris@49:   
Chris@49:   protected:
Chris@49:   
Chris@49:   inline Col(const arma_fixed_indicator&, const uword in_n_elem, const eT* in_mem);
Chris@49:   
Chris@49:   
Chris@49:   public:
Chris@49:   
Chris@49:   #ifdef ARMA_EXTRA_COL_PROTO
Chris@49:     #include ARMA_INCFILE_WRAP(ARMA_EXTRA_COL_PROTO)
Chris@49:   #endif
Chris@49:   };
Chris@49: 
Chris@49: 
Chris@49: 
Chris@49: template<typename eT>
Chris@49: template<uword fixed_n_elem>
Chris@49: class Col<eT>::fixed : public Col<eT>
Chris@49:   {
Chris@49:   private:
Chris@49:   
Chris@49:   static const bool use_extra = (fixed_n_elem > arma_config::mat_prealloc);
Chris@49:   
Chris@49:   arma_align_mem eT mem_local_extra[ (use_extra) ? fixed_n_elem : 1 ];
Chris@49:   
Chris@49:   arma_inline void change_to_row();
Chris@49:   
Chris@49:   
Chris@49:   public:
Chris@49:   
Chris@49:   typedef fixed<fixed_n_elem>               Col_fixed_type;
Chris@49:   
Chris@49:   typedef eT                                elem_type;
Chris@49:   typedef typename get_pod_type<eT>::result pod_type;
Chris@49:   
Chris@49:   static const bool is_col = true;
Chris@49:   static const bool is_row = false;
Chris@49:   
Chris@49:   static const uword n_rows = fixed_n_elem;
Chris@49:   static const uword n_cols = 1;
Chris@49:   static const uword n_elem = fixed_n_elem;
Chris@49:   
Chris@49:   arma_inline fixed();
Chris@49:   arma_inline fixed(const fixed<fixed_n_elem>& X);
Chris@49:        inline fixed(const subview_cube<eT>& X);
Chris@49:   
Chris@49:   template<typename T1>              inline fixed(const Base<eT,T1>& A);
Chris@49:   template<typename T1, typename T2> inline fixed(const Base<pod_type,T1>& A, const Base<pod_type,T2>& B);
Chris@49:   
Chris@49:   inline fixed(const eT* aux_mem);
Chris@49:   
Chris@49:   inline fixed(const char*        text);
Chris@49:   inline fixed(const std::string& text);
Chris@49:   
Chris@49:   template<typename T1> inline const Col& operator=(const Base<eT,T1>& A);
Chris@49:   
Chris@49:   inline const Col& operator=(const eT val);
Chris@49:   inline const Col& operator=(const char*        text);
Chris@49:   inline const Col& operator=(const std::string& text);
Chris@49:   inline const Col& operator=(const subview_cube<eT>& X);
Chris@49:   
Chris@49:   using Col<eT>::operator();
Chris@49:   
Chris@49:   #if defined(ARMA_USE_CXX11)
Chris@49:     inline                fixed(const std::initializer_list<eT>& list);
Chris@49:     inline const Col& operator=(const std::initializer_list<eT>& list);
Chris@49:   #endif
Chris@49:   
Chris@49:   arma_inline const Op< Col_fixed_type, op_htrans >  t() const;
Chris@49:   arma_inline const Op< Col_fixed_type, op_htrans > ht() const;
Chris@49:   arma_inline const Op< Col_fixed_type, op_strans > st() const;
Chris@49:   
Chris@49:   arma_inline arma_warn_unused const eT& at_alt     (const uword i) const;
Chris@49:   
Chris@49:   arma_inline arma_warn_unused       eT& operator[] (const uword i);
Chris@49:   arma_inline arma_warn_unused const eT& operator[] (const uword i) const;
Chris@49:   arma_inline arma_warn_unused       eT& at         (const uword i);
Chris@49:   arma_inline arma_warn_unused const eT& at         (const uword i) const;
Chris@49:   arma_inline arma_warn_unused       eT& operator() (const uword i);
Chris@49:   arma_inline arma_warn_unused const eT& operator() (const uword i) const;
Chris@49:   
Chris@49:   arma_inline arma_warn_unused       eT& at         (const uword in_row, const uword in_col);
Chris@49:   arma_inline arma_warn_unused const eT& at         (const uword in_row, const uword in_col) const;
Chris@49:   arma_inline arma_warn_unused       eT& operator() (const uword in_row, const uword in_col);
Chris@49:   arma_inline arma_warn_unused const eT& operator() (const uword in_row, const uword in_col) const;
Chris@49:   
Chris@49:   arma_inline arma_warn_unused       eT* memptr();
Chris@49:   arma_inline arma_warn_unused const eT* memptr() const;
Chris@49:   
Chris@49:   arma_hot inline const Col<eT>& fill(const eT val);
Chris@49:   arma_hot inline const Col<eT>& zeros();
Chris@49:   arma_hot inline const Col<eT>& ones();
Chris@49:   };
Chris@49: 
Chris@49: 
Chris@49: 
Chris@49: //! @}