PLearn 0.1
TMatColRowsIterator_decl.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // PLearn (A C++ Machine Learning Library)
00004 // Copyright (C) 1998 Pascal Vincent
00005 // Copyright (C) 1999-2002 Pascal Vincent, Yoshua Bengio and University of Montreal
00006 //
00007 
00008 // Redistribution and use in source and binary forms, with or without
00009 // modification, are permitted provided that the following conditions are met:
00010 // 
00011 //  1. Redistributions of source code must retain the above copyright
00012 //     notice, this list of conditions and the following disclaimer.
00013 // 
00014 //  2. Redistributions in binary form must reproduce the above copyright
00015 //     notice, this list of conditions and the following disclaimer in the
00016 //     documentation and/or other materials provided with the distribution.
00017 // 
00018 //  3. The name of the authors may not be used to endorse or promote
00019 //     products derived from this software without specific prior written
00020 //     permission.
00021 // 
00022 // THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR
00023 // IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
00024 // OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN
00025 // NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
00026 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
00027 // TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00028 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00029 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00030 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00031 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00032 // 
00033 // This file is part of the PLearn library. For more information on the PLearn
00034 // library, go to the PLearn Web site at www.plearn.org
00035 
00036 
00037  
00038 
00039 /* *******************************************************      
00040  * $Id: TMatColRowsIterator_decl.h 8235 2007-11-07 21:32:01Z nouiz $
00041  * AUTHORS: Pascal Vincent & Yoshua Bengio
00042  * This file is part of the PLearn library.
00043  ******************************************************* */
00044 
00045 
00048 #ifndef TMatColRowsIterator_decl_INC
00049 #define TMatColRowsIterator_decl_INC
00050 
00051 namespace PLearn {
00052 using namespace std;
00053 
00058 template <class T>
00059 class TMatColRowsIterator
00060 {
00061 public:
00063     typedef random_access_iterator_tag iterator_category;
00064     typedef T                          value_type;
00065     typedef ptrdiff_t                  difference_type;
00066     typedef T*                         pointer;
00067     typedef T&                         reference;
00068   
00069 private:
00070     T* ptr;                                    
00071     int mod;                                   
00072 
00073 public:
00074     TMatColRowsIterator()
00075         : ptr(), mod() {}
00076 
00078     TMatColRowsIterator(T* p, int m)
00079         : ptr(p), mod(m) {}
00080 
00081     // Implement trivial iterator functions
00082     bool operator==(const TMatColRowsIterator& other) const {
00083         return ptr == other.ptr && mod == other.mod;
00084     }
00085 
00086     reference operator*() {
00087         return *ptr;
00088     }
00089 
00090     reference operator->() {                   
00091         return *ptr;                             
00092     }
00093   
00094     // Implement forward iterator functions
00095     TMatColRowsIterator<T>& operator++() {
00096         ptr += mod;
00097         return *this;
00098     }
00099 
00100     TMatColRowsIterator<T> operator++(int) {
00101         TMatColRowsIterator<T> r(*this);
00102         ptr += mod;
00103         return r;
00104     }
00105 
00106     // Implement bidirectional iterator functions
00107     TMatColRowsIterator<T>& operator--() {
00108         ptr -= mod;
00109         return *this;
00110     }
00111 
00112     TMatColRowsIterator<T> operator--(int) {
00113         TMatColRowsIterator<T> r(*this);
00114         ptr -= mod;
00115         return r;
00116     }
00117 
00118     // Implement random access iterator functions
00119     TMatColRowsIterator<T>& operator+=(difference_type n) {
00120         ptr += n*mod;
00121         return *this;
00122     }
00123 
00124     TMatColRowsIterator<T> operator+(difference_type n) {
00125         TMatColRowsIterator<T> r(*this);
00126         r += n;
00127         return r;
00128     }
00129   
00130     TMatColRowsIterator<T>& operator-=(difference_type n) {
00131         ptr -= n*mod;
00132         return *this;
00133     }
00134 
00135     TMatColRowsIterator<T> operator-(difference_type n) {
00136         TMatColRowsIterator<T> r(*this);
00137         r -= n;
00138         return r;
00139     }
00140 
00141     difference_type operator-(const TMatColRowsIterator<T>& y) {
00142         return (ptr - y.ptr) / mod;
00143     }
00144   
00145     reference operator[](difference_type n) {
00146         return *(ptr + n*mod);
00147     }
00148 
00149     bool operator<(const TMatColRowsIterator<T>& y) {
00150         return ptr < y.ptr;
00151     }
00152 };
00153 
00154 } // end of namespace PLearn
00155 
00156 #endif
00157 
00158 
00159 /*
00160   Local Variables:
00161   mode:c++
00162   c-basic-offset:4
00163   c-file-style:"stroustrup"
00164   c-file-offsets:((innamespace . 0)(inline-open . 0))
00165   indent-tabs-mode:nil
00166   fill-column:79
00167   End:
00168 */
00169 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=79 :
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines