src/OpenFOAM/containers/Lists/UPtrList/UPtrListI.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 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  30
  31 namespace Foam
  32 {
  33
  34 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
  35
  36 template<class T>
  37 inline label UPtrList<T>::size() const
  38 {
  39     return ptrs_.size();
  40 }
  41
  42
  43 template<class T>
  44 inline bool UPtrList<T>::set(const label i) const
  45 {
  46     return ptrs_[i] != NULL;
  47 }
  48
  49
  50 template<class T>
  51 inline T* UPtrList<T>::set(const label i, T* ptr)
  52 {
  53     T* old = ptrs_[i];
  54     ptrs_[i] = ptr;
  55     return old;
  56 }
  57
  58
  59 // * * * * * * * * * * * * * * * Member Operators  * * * * * * * * * * * * * //
  60
  61 template<class T>
  62 const T& UPtrList<T>::operator[](const label i) const
  63 {
  64     if (!ptrs_[i])
  65     {
  66         FatalErrorIn("UPtrList::operator[] const")
  67             << "hanging pointer, cannot dereference"
  68             << abort(FatalError);
  69     }
  70
  71     return *(ptrs_[i]);
  72 }
  73
  74
  75 template<class T>
  76 T& UPtrList<T>::operator[](const label i)
  77 {
  78     if (!ptrs_[i])
  79     {
  80         FatalErrorIn("UPtrList::operator[]")
  81             << "hanging pointer, cannot dereference"
  82             << abort(FatalError);
  83     }
  84
  85     return *(ptrs_[i]);
  86 }
  87
  88
  89 template<class T>
  90 const T* UPtrList<T>::operator()(const label i) const
  91 {
  92     return ptrs_[i];
  93 }
  94
  95
  96 // * * * * * * * * * * * * * * * * STL iterator  * * * * * * * * * * * * * * //
  97
  98 template<class T>
  99 inline UPtrList<T>::iterator::iterator(T** ptr)
 100 :
 101     ptr_(ptr)
 102 {}
 103
 104 template<class T>
 105 inline bool UPtrList<T>::iterator::operator==(const iterator& iter) const
 106 {
 107     return ptr_ == iter.ptr_;
 108 }
 109
 110 template<class T>
 111 inline bool UPtrList<T>::iterator::operator!=(const iterator& iter) const
 112 {
 113     return ptr_ != iter.ptr_;
 114 }
 115
 116 template<class T>
 117 inline T& UPtrList<T>::iterator::operator*()
 118 {
 119     return **ptr_;
 120 }
 121
 122 template<class T>
 123 inline T& UPtrList<T>::iterator::operator()()
 124 {
 125     return operator*();
 126 }
 127
 128 template<class T>
 129 inline typename UPtrList<T>::iterator
 130 UPtrList<T>::iterator::operator++()
 131 {
 132     ++ptr_;
 133     return *this;
 134 }
 135
 136 template<class T>
 137 inline typename UPtrList<T>::iterator
 138 UPtrList<T>::iterator::operator++(int)
 139 {
 140     iterator tmp = *this;
 141     ++ptr_;
 142     return tmp;
 143 }
 144
 145 template<class T>
 146 inline typename UPtrList<T>::iterator
 147 UPtrList<T>::iterator::operator--()
 148 {
 149     --ptr_;
 150     return *this;
 151 }
 152
 153 template<class T>
 154 inline typename UPtrList<T>::iterator
 155 UPtrList<T>::iterator::operator--(int)
 156 {
 157     iterator tmp = *this;
 158     --ptr_;
 159     return tmp;
 160 }
 161
 162 template<class T>
 163 inline typename UPtrList<T>::iterator
 164 UPtrList<T>::iterator::operator+=(label n)
 165 {
 166     ptr_ += n;
 167     return *this;
 168 }
 169
 170 template<class T>
 171 inline typename UPtrList<T>::iterator
 172 operator+(const typename UPtrList<T>::iterator& iter, label n)
 173 {
 174     typename UPtrList<T>::iterator tmp = iter;
 175     return tmp += n;
 176 }
 177
 178 template<class T>
 179 inline typename UPtrList<T>::iterator
 180 operator+(label n, const typename UPtrList<T>::iterator& iter)
 181 {
 182     typename UPtrList<T>::iterator tmp = iter;
 183     return tmp += n;
 184 }
 185
 186 template<class T>
 187 inline typename UPtrList<T>::iterator
 188 UPtrList<T>::iterator::operator-=(label n)
 189 {
 190     ptr_ -= n;
 191     return *this;
 192 }
 193
 194 template<class T>
 195 inline typename UPtrList<T>::iterator
 196 operator-(const typename UPtrList<T>::iterator& iter, label n)
 197 {
 198     typename UPtrList<T>::iterator tmp = iter;
 199     return tmp -= n;
 200 }
 201
 202 template<class T>
 203 inline label operator-
 204 (
 205     const typename UPtrList<T>::iterator& iter1,
 206     const typename UPtrList<T>::iterator& iter2
 207 )
 208 {
 209     return (iter1.ptr_ - iter2.ptr_)/sizeof(T*);
 210 }
 211
 212 template<class T>
 213 inline T& UPtrList<T>::iterator::operator[](label n)
 214 {
 215     return *(*this + n);
 216 }
 217
 218 template<class T>
 219 inline bool UPtrList<T>::iterator::operator<(const iterator& iter) const
 220 {
 221     return ptr_ < iter.ptr_;
 222 }
 223
 224 template<class T>
 225 inline bool UPtrList<T>::iterator::operator>(const iterator& iter) const
 226 {
 227     return ptr_ > iter.ptr_;
 228 }
 229
 230 template<class T>
 231 inline bool UPtrList<T>::iterator::operator<=(const iterator& iter) const
 232 {
 233     return ptr_ <= iter.ptr_;
 234 }
 235
 236 template<class T>
 237 inline bool UPtrList<T>::iterator::operator>=(const iterator& iter) const
 238 {
 239     return ptr_ >= iter.ptr_;
 240 }
 241
 242 template<class T>
 243 inline typename UPtrList<T>::iterator UPtrList<T>::begin()
 244 {
 245     return ptrs_.begin();
 246 }
 247
 248 template<class T>
 249 inline typename UPtrList<T>::iterator UPtrList<T>::end()
 250 {
 251     return ptrs_.end();
 252 }
 253
 254
 255 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 256
 257 } // End namespace Foam
 258
 259 // ************************************************************************* //