iterator.h

高效的c++科学算法库

/*                                                           -*- c++ -*-
 ***********************************************************************
 * Scientific Library (GNU Public Licence)
 *
 * dense 3D tensor structure
 *
 * Author: Pierre Aubert [e-mail]
 *
 * $Id: iterator.h,v 1.3 1998/11/16 17:22:14 paubert Exp $
 *
 * Suggestions: [e-mail]
 * Bugs:   [e-mail] 
 *
 * For more information, please see the sl++ Home Page:
 * http://wwwinfo.cern.ch/~ldeniau/sl.html 
 *
 ***********************************************************************
 */

#ifndef SL_MATRIX_STRUCTURES_TENSOR3_ITERATOR_H
#define SL_MATRIX_STRUCTURES_TENSOR3_ITERATOR_H

#ifndef SL_MATRIX_STRUCTURES_TENSOR3_H
#error <sl/matrix/structures/tensor3/iterator.h> must be included via <sl/matrix/structures/sss.h>
#endif

#ifdef HAVE_NAMESPACE
namespace sl 
{
#endif

      /** @memo Iterator related to Tensor3
       */
    
    class Tensor3Iterator : public GeneralIterator3D
    {
        
    public:
        
        typedef Tensor3 structure_t;
        
          /** @name Explanation
              
              Dense Rowmajor 3D Array
          */
          /**@name */
          //@{
          /// constructor
        Tensor3Iterator(structure_t const* structure,
                        Index const i =MinIndex,
                        Index const j =MinIndex,
                        Index const k =MinIndex );
          /// get to the next stored element in matrix
        void operator++();
          /// get to the first stored element in next row
        void incDepth();
          /// get to the first stored element in next row
        void incRow();
          /// get to the first stored element in next column
        void incCol();
          //@}
    private:
          /// map(i,j,k) return position
        Index map (Index const& i, Index const& j, Index const& k);
          /// same as map(i,j,k) but without any control
        inline Index map_fast (Index const& i, Index const& j, Index const& k);
    };
    
#ifdef HAVE_NAMESPACE
}
#endif

#endif
// end of SL_MATRIX_STRUCTURES_TENSOR3_ITERATOR_H definition(s)
// do not write anything after this line!