File size: 6,388 Bytes
5a600cf | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2026 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
This file is part of OpenFOAM.
OpenFOAM is free software: you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
for more details.
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Classes
Foam::expression::IteratorBase
Foam::expression::Iterator
Foam::expression::IteratorNew
Description
Iterator class which facilitates iteration through an expression
\*---------------------------------------------------------------------------*/
#ifndef expressionIterator_H
#define expressionIterator_H
#include "expressionOperate.H"
#include "expressionBound.H"
#include "expressionSelect.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
namespace expression
{
/*---------------------------------------------------------------------------*\
Class IteratorBase Declaration
\*---------------------------------------------------------------------------*/
template<template<class> class Iterator, class Expression>
struct IteratorBase
{
protected:
const Expression& e_;
using eiType = typename Operate<Expression, Arguments<Bound<false>>>::type;
eiType ei_;
public:
template<bool Index>
inline IteratorBase
(
const Expression& e,
const Bound<Index>&
)
:
e_(e),
ei_
(
Operate<Expression, Arguments<Bound<Index>>>::access
(
e,
Bound<Index>()
)
)
{}
inline Iterator<Expression>& operator++()
{
advance(e_, ei_);
return static_cast<Iterator<Expression>&>(*this);
}
inline Iterator<Expression> operator++(int)
{
Iterator<Expression> ei0(e_, ei_);
advance(e_, ei_);
return ei0;
}
inline bool operator==(const IteratorBase<Iterator, Expression>& iter) const
{
return compare(e_, ei_, iter.ei_);
}
inline bool operator!=(const IteratorBase<Iterator, Expression>& iter) const
{
return !compare(e_, ei_, iter.ei_);
}
};
/*---------------------------------------------------------------------------*\
Class Iterator Declaration
\*---------------------------------------------------------------------------*/
template<class Expression>
struct Iterator
:
public IteratorBase<Iterator, Expression>
{
using IteratorBase<Iterator, Expression>::IteratorBase;
typedef typename Operate
<
Expression,
Arguments<typename IteratorBase<Iterator, Expression>::eiType>
>::type value_type;
value_type operator*() const
{
return access(this->e_, this->ei_);
}
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
//- Return an iterator pointing to the start of the expression
template<class Expression>
Iterator<Expression> begin(const Expression& e)
{
return Iterator<Expression>(e, Bound<false>());
}
//- Return an iterator pointing to the end of the expression
template<class Expression>
Iterator<Expression> end(const Expression& e)
{
return Iterator<Expression>(e, Bound<true>());
}
/*---------------------------------------------------------------------------*\
Class IteratorNew Declaration
\*---------------------------------------------------------------------------*/
template<class Type, bool Ptr, class Expression>
struct IteratorNew
:
public IteratorBase<Iterator, Expression>
{
using IteratorBase<Iterator, Expression>::IteratorBase;
typedef typename Select<Type, Ptr>::type value_type;
typename Select<Type, Ptr>::type operator*() const
{
return New<Type, Ptr>(access(this->e_, this->ei_));
}
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
//- Return an iterator pointing to the start of the expression
template<class Type, bool Ptr, class Expression>
IteratorNew<Type, Ptr, Expression> beginNew(const Expression& e)
{
return IteratorNew<Type, Ptr, Expression>(e, Bound<false>());
}
//- Return an iterator pointing to the end of the expression
template<class Type, bool Ptr, class Expression>
IteratorNew<Type, Ptr, Expression> endNew(const Expression& e)
{
return IteratorNew<Type, Ptr, Expression>(e, Bound<true>());
}
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace expression
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
template<class Expression>
struct std::iterator_traits
<
Foam::expression::Iterator<Expression>
>
{
typedef Foam::label difference_type;
typedef typename
Foam::expression::Iterator<Expression>::value_type
value_type;
typedef void pointer_type;
typedef void reference;
typedef std::forward_iterator_tag iterator_category;
};
template<class Type, bool Ptr, class Expression>
struct std::iterator_traits
<
Foam::expression::IteratorNew<Type, Ptr, Expression>
>
{
typedef Foam::label difference_type;
typedef typename
Foam::expression::IteratorNew<Type, Ptr, Expression>::value_type
value_type;
typedef void pointer_type;
typedef void reference;
typedef std::forward_iterator_tag iterator_category;
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|