Chris@49: // Copyright (C) 2011-2012 Ryan Curtin
Chris@49: // Copyright (C) 2011 Matthew Amidon
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 SpCol
Chris@49: //! @{
Chris@49: 
Chris@49: //! Class for sparse column vectors (matrices with only one column)
Chris@49: 
Chris@49: template<typename eT>
Chris@49: class SpCol : public SpMat<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_row = false;
Chris@49:   static const bool is_col = true;
Chris@49:   
Chris@49:   
Chris@49:   inline          SpCol();
Chris@49:   inline explicit SpCol(const uword n_elem);
Chris@49:   inline          SpCol(const uword in_rows, const uword in_cols);
Chris@49: 
Chris@49:   inline                  SpCol(const char*        text);
Chris@49:   inline const SpCol& operator=(const char*        text);
Chris@49: 
Chris@49:   inline                  SpCol(const std::string& text);
Chris@49:   inline const SpCol& operator=(const std::string& text);
Chris@49: 
Chris@49:   inline const SpCol& operator=(const eT val);
Chris@49: 
Chris@49:   template<typename T1> inline                  SpCol(const Base<eT,T1>& X);
Chris@49:   template<typename T1> inline const SpCol& operator=(const Base<eT,T1>& X);
Chris@49: 
Chris@49:   template<typename T1> inline                  SpCol(const SpBase<eT,T1>& X);
Chris@49:   template<typename T1> inline const SpCol& operator=(const SpBase<eT,T1>& X);
Chris@49: 
Chris@49:   template<typename T1, typename T2>
Chris@49:   inline explicit SpCol(const SpBase<pod_type,T1>& A, const SpBase<pod_type,T2>& B);
Chris@49: 
Chris@49:   inline SpValProxy<SpMat<eT> > row(const uword row_num);
Chris@49:   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:   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:   typedef typename SpMat<eT>::iterator       row_iterator;
Chris@49:   typedef typename SpMat<eT>::const_iterator const_row_iterator;
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       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:   #ifdef ARMA_EXTRA_SPCOL_PROTO
Chris@49:     #include ARMA_INCFILE_WRAP(ARMA_EXTRA_SPCOL_PROTO)
Chris@49:   #endif
Chris@49:   };