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

Armadillo Library

+// Copyright (C) 2008-2011 NICTA (www.nicta.com.au)
+// Copyright (C) 2008-2011 Conrad Sanderson
+// Copyright (C) 2009-2010 Ian Cullinan
+// 
+// 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 field
+//! @{
+
+
+
+struct field_prealloc_n_elem
+  {
+  static const uword val = 16;
+  };
+
+
+
+//! A lightweight 2D container for abitrary objects
+//! (the objects must have a copy constructor)
+
+template<typename oT>
+class field
+  {
+  public:
+  
+  typedef oT object_type;
+  
+  const uword n_rows;     //!< number of rows in the field (read-only)
+  const uword n_cols;     //!< number of columns in the field (read-only)
+  const uword n_elem;     //!< number of elements in the field (read-only)
+  
+  
+  private:
+  
+  arma_aligned oT** mem;             //!< pointer to memory used by the object
+  arma_aligned oT*  mem_local[ field_prealloc_n_elem::val ];
+  //!< Internal memory, to avoid calling the 'new' operator for small amounts of memory
+  
+  
+  public:
+  
+  inline ~field();
+  inline  field();
+  
+  inline                  field(const field& x);
+  inline const field& operator=(const field& x);
+  
+  inline                  field(const subview_field<oT>& x);
+  inline const field& operator=(const subview_field<oT>& x);
+  
+  inline explicit field(const uword n_elem_in);
+  inline          field(const uword n_rows_in, const uword n_cols_in);
+  
+  inline void  set_size(const uword n_obj_in);
+  inline void  set_size(const uword n_rows_in, const uword n_cols_in);
+  
+  template<typename oT2>
+  inline void copy_size(const field<oT2>& x);
+  
+  arma_inline       oT& operator[](const uword i);
+  arma_inline const oT& operator[](const uword i) const;
+  
+  arma_inline       oT&         at(const uword i);
+  arma_inline const oT&         at(const uword i) const;
+  
+  arma_inline       oT& operator()(const uword i);
+  arma_inline const oT& operator()(const uword i) const;
+  
+  arma_inline       oT&         at(const uword row, const uword col);
+  arma_inline const oT&         at(const uword row, const uword col) const;
+  
+  arma_inline       oT& operator()(const uword row, const uword col);
+  arma_inline const oT& operator()(const uword row, const uword col) const;
+  
+  inline field_injector<field> operator<<(const oT& val);
+  inline field_injector<field> operator<<(const injector_end_of_row& x);
+  
+  
+  inline       subview_field<oT> row(const uword row_num);
+  inline const subview_field<oT> row(const uword row_num) const;
+  
+  inline       subview_field<oT> col(const uword col_num);
+  inline const subview_field<oT> col(const uword col_num) const;
+  
+  inline       subview_field<oT> rows(const uword in_row1, const uword in_row2);
+  inline const subview_field<oT> rows(const uword in_row1, const uword in_row2) const;
+  
+  inline       subview_field<oT> cols(const uword in_col1, const uword in_col2);
+  inline const subview_field<oT> cols(const uword in_col1, const uword in_col2) const;
+  
+  inline       subview_field<oT> subfield(const uword in_row1, const uword in_col1, const uword in_row2, const uword in_col2);
+  inline const subview_field<oT> subfield(const uword in_row1, const uword in_col1, const uword in_row2, const uword in_col2) const;
+  
+  inline       subview_field<oT> subfield  (const span& row_span, const span& col_span);
+  inline const subview_field<oT> subfield  (const span& row_span, const span& col_span) const;
+  
+  inline       subview_field<oT> operator()(const span& row_span, const span& col_span);
+  inline const subview_field<oT> operator()(const span& row_span, const span& col_span) const;
+  
+  
+  inline void print(const std::string extra_text = "") const;
+  inline void print(std::ostream& user_stream, const std::string extra_text = "") const;
+  
+  inline void fill(const oT& x);
+  
+  inline void reset();
+  inline void reset_objects();
+  
+  arma_inline bool is_empty() const;
+  
+  arma_inline arma_warn_unused bool in_range(const uword   i) const;
+  arma_inline arma_warn_unused bool in_range(const span& x) const;
+  
+  arma_inline arma_warn_unused bool in_range(const uword   in_row,   const uword   in_col  ) const;
+  arma_inline arma_warn_unused bool in_range(const span& row_span, const uword   in_col  ) const;
+  arma_inline arma_warn_unused bool in_range(const uword   in_row,   const span& col_span) const;
+  arma_inline arma_warn_unused bool in_range(const span& row_span, const span& col_span) const;
+  
+  inline bool save(const std::string   name, const file_type type = arma_binary, const bool print_status = true) const;
+  inline bool save(      std::ostream& os,   const file_type type = arma_binary, const bool print_status = true) const;
+  
+  inline bool load(const std::string   name, const file_type type = auto_detect, const bool print_status = true);
+  inline bool load(      std::istream& is,   const file_type type = auto_detect, const bool print_status = true);
+  
+  
+  inline bool quiet_save(const std::string   name, const file_type type = arma_binary) const;
+  inline bool quiet_save(      std::ostream& os,   const file_type type = arma_binary) const;
+  
+  inline bool quiet_load(const std::string   name, const file_type type = auto_detect);
+  inline bool quiet_load(      std::istream& is,   const file_type type = auto_detect);
+  
+  
+  // iterators
+  
+  class iterator
+    {
+    public:
+    
+    inline iterator(field<oT>& in_M, const bool at_end = false);
+    
+    inline oT& operator* ();
+    
+    inline iterator& operator++();
+    inline void      operator++(int);
+    
+    inline iterator& operator--();
+    inline void      operator--(int);
+    
+    inline bool operator!=(const iterator& X) const;
+    inline bool operator==(const iterator& X) const;
+    
+    arma_aligned field<oT>& M;
+    arma_aligned uword        i;
+    };
+  
+  
+  class const_iterator
+    {
+    public:
+    
+    const_iterator(const field<oT>& in_M, const bool at_end = false);
+    const_iterator(const iterator& X);
+    
+    inline const oT& operator*() const;
+    
+    inline const_iterator& operator++();
+    inline void            operator++(int);
+    
+    inline const_iterator& operator--();
+    inline void            operator--(int);
+    
+    inline bool operator!=(const const_iterator& X) const;
+    inline bool operator==(const const_iterator& X) const;
+    
+    arma_aligned const field<oT>& M;
+    arma_aligned       uword        i;
+    };
+  
+  inline       iterator begin();
+  inline const_iterator begin() const;
+  
+  inline       iterator end();
+  inline const_iterator end()   const;
+  
+  
+  private:
+  
+  inline void init(const field<oT>& x);
+  inline void init(const uword n_rows_in, const uword n_cols_in);
+  
+  inline void delete_objects();
+  inline void create_objects();
+  
+  friend class field_aux;
+  friend class subview_field<oT>;
+  
+  
+  public:
+  
+  #ifdef ARMA_EXTRA_FIELD_PROTO
+    #include ARMA_INCFILE_WRAP(ARMA_EXTRA_FIELD_PROTO)
+  #endif
+  };
+
+
+
+class field_aux
+  {
+  public:
+  
+  template<typename oT> inline static void reset_objects(field< oT >& x);
+  template<typename eT> inline static void reset_objects(field< Mat<eT> >& x);
+  template<typename eT> inline static void reset_objects(field< Col<eT> >& x);
+  template<typename eT> inline static void reset_objects(field< Row<eT> >& x);
+  template<typename eT> inline static void reset_objects(field< Cube<eT> >& x);
+                        inline static void reset_objects(field< std::string >& x);
+  
+  
+  template<typename oT> inline static bool save(const field< oT >& x,       const std::string& name, const file_type type, std::string& err_msg);
+  template<typename oT> inline static bool save(const field< oT >& x,       std::ostream& os,        const file_type type, std::string& err_msg);
+  template<typename oT> inline static bool load(      field< oT >& x,       const std::string& name, const file_type type, std::string& err_msg);
+  template<typename oT> inline static bool load(      field< oT >& x,       std::istream& is,        const file_type type, std::string& err_msg);
+
+  template<typename eT> inline static bool save(const field< Mat<eT> >& x,  const std::string& name, const file_type type, std::string& err_msg);
+  template<typename eT> inline static bool save(const field< Mat<eT> >& x,  std::ostream& os,        const file_type type, std::string& err_msg);
+  template<typename eT> inline static bool load(      field< Mat<eT> >& x,  const std::string& name, const file_type type, std::string& err_msg);
+  template<typename eT> inline static bool load(      field< Mat<eT> >& x,  std::istream& is,        const file_type type, std::string& err_msg);
+  
+  template<typename eT> inline static bool save(const field< Col<eT> >& x,  const std::string& name, const file_type type, std::string& err_msg);
+  template<typename eT> inline static bool save(const field< Col<eT> >& x,  std::ostream& os,        const file_type type, std::string& err_msg);
+  template<typename eT> inline static bool load(      field< Col<eT> >& x,  const std::string& name, const file_type type, std::string& err_msg);
+  template<typename eT> inline static bool load(      field< Col<eT> >& x,  std::istream& is,        const file_type type, std::string& err_msg);
+  
+  template<typename eT> inline static bool save(const field< Row<eT> >& x,  const std::string& name, const file_type type, std::string& err_msg);
+  template<typename eT> inline static bool save(const field< Row<eT> >& x,  std::ostream& os,        const file_type type, std::string& err_msg);
+  template<typename eT> inline static bool load(      field< Row<eT> >& x,  const std::string& name, const file_type type, std::string& err_msg);
+  template<typename eT> inline static bool load(      field< Row<eT> >& x,  std::istream& is,        const file_type type, std::string& err_msg);
+
+  template<typename eT> inline static bool save(const field< Cube<eT> >& x, const std::string& name, const file_type type, std::string& err_msg);
+  template<typename eT> inline static bool save(const field< Cube<eT> >& x, std::ostream& os,        const file_type type, std::string& err_msg);
+  template<typename eT> inline static bool load(      field< Cube<eT> >& x, const std::string& name, const file_type type, std::string& err_msg);
+  template<typename eT> inline static bool load(      field< Cube<eT> >& x, std::istream& is,        const file_type type, std::string& err_msg);
+  
+  inline static bool save(const field< std::string >& x, const std::string& name, const file_type type, std::string& err_msg);
+  inline static bool save(const field< std::string >& x, std::ostream& os,        const file_type type, std::string& err_msg);
+  inline static bool load(      field< std::string >& x, const std::string& name, const file_type type, std::string& err_msg);
+  inline static bool load(      field< std::string >& x, std::istream& is,        const file_type type, std::string& err_msg);
+  
+  };
+
+
+//! @}