src/OpenFOAM/containers/Lists/PtrList/PtrListI.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2008 OpenCFD Ltd.
   6      \\/     M anipulation  |
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of OpenFOAM.
  10
  11     OpenFOAM is free software; you can redistribute it and/or modify it
  12     under the terms of the GNU General Public License as published by the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     option) any later version.
  15
  16     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
  17     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  18     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  19     for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with OpenFOAM; if not, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 \*---------------------------------------------------------------------------*/
  26
  27 #include "error.H"
  28
  29 #include "autoPtr.H"
  30 #include "tmp.H"
  31
  32 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  33
  34 namespace Foam
  35 {
  36
  37 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
  38
  39 template<class T>
  40 inline label PtrList<T>::size() const
  41 {
  42     return ptrs_.size();
  43 }
  44
  45
  46 template<class T>
  47 inline bool PtrList<T>::set(const label i) const
  48 {
  49     return ptrs_[i] != NULL;
  50 }
  51
  52
  53 template<class T>
  54 inline autoPtr<T> PtrList<T>::set(const label i, T* ptr)
  55 {
  56     autoPtr<T> old(ptrs_[i]);
  57
  58     ptrs_[i] = ptr;
  59
  60     return old;
  61 }
  62
  63
  64 template<class T>
  65 inline autoPtr<T> PtrList<T>::set(const label i, const autoPtr<T>& aptr)
  66 {
  67     return set(i, const_cast<autoPtr<T>&>(aptr).ptr());
  68 }
  69
  70
  71 template<class T>
  72 inline autoPtr<T> PtrList<T>::set(const label i, const tmp<T>& t)
  73 {
  74     return set(i, const_cast<tmp<T>&>(t).ptr());
  75 }
  76
  77
  78 // * * * * * * * * * * * * * * * Member Operators  * * * * * * * * * * * * * //
  79
  80 template<class T>
  81 const T& PtrList<T>::operator[](const label i) const
  82 {
  83     if (!ptrs_[i])
  84     {
  85         FatalErrorIn("PtrList::operator[] const")
  86             << "hanging pointer, cannot dereference"
  87             << abort(FatalError);
  88     }
  89
  90     return *(ptrs_[i]);
  91 }
  92
  93
  94 template<class T>
  95 T& PtrList<T>::operator[](const label i)
  96 {
  97     if (!ptrs_[i])
  98     {
  99         FatalErrorIn("PtrList::operator[]")
 100             << "hanging pointer, cannot dereference"
 101             << abort(FatalError);
 102     }
 103
 104     return *(ptrs_[i]);
 105 }
 106
 107
 108 template<class T>
 109 const T* PtrList<T>::operator()(const label i) const
 110 {
 111     return ptrs_[i];
 112 }
 113
 114
 115 // * * * * * * * * * * * * * * * * STL iterator  * * * * * * * * * * * * * * //
 116
 117 template<class T>
 118 inline PtrList<T>::iterator::iterator(T** ptr)
 119 :
 120     ptr_(ptr)
 121 {}
 122
 123 template<class T>
 124 inline bool PtrList<T>::iterator::operator==(const iterator& iter) const
 125 {
 126     return ptr_ == iter.ptr_;
 127 }
 128
 129 template<class T>
 130 inline bool PtrList<T>::iterator::operator!=(const iterator& iter) const
 131 {
 132     return ptr_ != iter.ptr_;
 133 }
 134
 135 template<class T>
 136 inline T& PtrList<T>::iterator::operator*()
 137 {
 138     return **ptr_;
 139 }
 140
 141 template<class T>
 142 inline T& PtrList<T>::iterator::operator()()
 143 {
 144     return operator*();
 145 }
 146
 147 template<class T>
 148 inline typename PtrList<T>::iterator
 149 PtrList<T>::iterator::operator++()
 150 {
 151     ++ptr_;
 152     return *this;
 153 }
 154
 155 template<class T>
 156 inline typename PtrList<T>::iterator
 157 PtrList<T>::iterator::operator++(int)
 158 {
 159     iterator tmp = *this;
 160     ++ptr_;
 161     return tmp;
 162 }
 163
 164 template<class T>
 165 inline typename PtrList<T>::iterator
 166 PtrList<T>::iterator::operator--()
 167 {
 168     --ptr_;
 169     return *this;
 170 }
 171
 172 template<class T>
 173 inline typename PtrList<T>::iterator
 174 PtrList<T>::iterator::operator--(int)
 175 {
 176     iterator tmp = *this;
 177     --ptr_;
 178     return tmp;
 179 }
 180
 181 template<class T>
 182 inline typename PtrList<T>::iterator
 183 PtrList<T>::iterator::operator+=(label n)
 184 {
 185     ptr_ += n;
 186     return *this;
 187 }
 188
 189 template<class T>
 190 inline typename PtrList<T>::iterator
 191 operator+(const typename PtrList<T>::iterator& iter, label n)
 192 {
 193     typename PtrList<T>::iterator tmp = iter;
 194     return tmp += n;
 195 }
 196
 197 template<class T>
 198 inline typename PtrList<T>::iterator
 199 operator+(label n, const typename PtrList<T>::iterator& iter)
 200 {
 201     typename PtrList<T>::iterator tmp = iter;
 202     return tmp += n;
 203 }
 204
 205 template<class T>
 206 inline typename PtrList<T>::iterator
 207 PtrList<T>::iterator::operator-=(label n)
 208 {
 209     ptr_ -= n;
 210     return *this;
 211 }
 212
 213 template<class T>
 214 inline typename PtrList<T>::iterator
 215 operator-(const typename PtrList<T>::iterator& iter, label n)
 216 {
 217     typename PtrList<T>::iterator tmp = iter;
 218     return tmp -= n;
 219 }
 220
 221 template<class T>
 222 inline label operator-
 223 (
 224     const typename PtrList<T>::iterator& iter1,
 225     const typename PtrList<T>::iterator& iter2
 226 )
 227 {
 228     return (iter1.ptr_ - iter2.ptr_)/sizeof(T*);
 229 }
 230
 231 template<class T>
 232 inline T& PtrList<T>::iterator::operator[](label n)
 233 {
 234     return *(*this + n);
 235 }
 236
 237 template<class T>
 238 inline bool PtrList<T>::iterator::operator<(const iterator& iter) const
 239 {
 240     return ptr_ < iter.ptr_;
 241 }
 242
 243 template<class T>
 244 inline bool PtrList<T>::iterator::operator>(const iterator& iter) const
 245 {
 246     return ptr_ > iter.ptr_;
 247 }
 248
 249 template<class T>
 250 inline bool PtrList<T>::iterator::operator<=(const iterator& iter) const
 251 {
 252     return ptr_ <= iter.ptr_;
 253 }
 254
 255 template<class T>
 256 inline bool PtrList<T>::iterator::operator>=(const iterator& iter) const
 257 {
 258     return ptr_ >= iter.ptr_;
 259 }
 260
 261 template<class T>
 262 inline typename PtrList<T>::iterator PtrList<T>::begin()
 263 {
 264     return ptrs_.begin();
 265 }
 266
 267 template<class T>
 268 inline typename PtrList<T>::iterator PtrList<T>::end()
 269 {
 270     return ptrs_.end();
 271 }
 272
 273
 274 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 275
 276 } // End namespace Foam
 277
 278 // ************************************************************************* //