File size: 6,160 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 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2023-2024 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/>.
Class
Foam::Tuple3
Description
A 3-tuple for storing three objects of different types.
\*---------------------------------------------------------------------------*/
#ifndef Tuple3_H
#define Tuple3_H
#include "Istream.H"
#include "Hash.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
// Forward declaration of friend functions and operators
template<class Type1, class Type2, class Type3>
class Tuple3;
template<class Type1, class Type2, class Type3>
inline Istream& operator>>(Istream&, Tuple3<Type1, Type2, Type3>&);
template<class Type1, class Type2, class Type3>
inline Ostream& operator<<(Ostream&, const Tuple3<Type1, Type2, Type3>&);
/*---------------------------------------------------------------------------*\
Class Tuple3 Declaration
\*---------------------------------------------------------------------------*/
template<class Type1, class Type2, class Type3>
class Tuple3
{
// Private Data
Type1 f_;
Type2 s_;
Type3 t_;
public:
//- Hashing function class
template
<
class HashT1=Hash<Type1>,
class HashT2=Hash<Type2>,
class HashT3=Hash<Type3>
>
class Hash
{
public:
Hash()
{}
inline unsigned operator()
(
const Tuple3<Type1, Type2, Type3>&,
unsigned seed = 0
) const;
};
// Static Data Members
static const char* const typeName;
// Constructors
//- Null constructor for lists
inline Tuple3()
{}
//- Construct from components
inline Tuple3(const Type1& f, const Type2& s, const Type3& t)
:
f_(f),
s_(s),
t_(t)
{}
//- Construct from Istream
inline Tuple3(Istream& is)
{
is >> *this;
}
// Member Functions
//- Return first
inline const Type1& first() const
{
return f_;
}
//- Return first
inline Type1& first()
{
return f_;
}
//- Return second
inline const Type2& second() const
{
return s_;
}
//- Return second
inline Type2& second()
{
return s_;
}
//- Return third
inline const Type3& third() const
{
return t_;
}
//- Return third
inline Type3& third()
{
return t_;
}
// IOstream Operators
//- Read Tuple3 from Istream, discarding contents of existing Tuple3.
friend Istream& operator>> <Type1, Type2, Type3>
(
Istream& is,
Tuple3<Type1, Type2, Type3>& t3
);
// Write Tuple3 to Ostream.
friend Ostream& operator<< <Type1, Type2, Type3>
(
Ostream& os,
const Tuple3<Type1, Type2, Type3>& t3
);
};
template<class Type1, class Type2, class Type3>
template<class HashT1, class HashT2, class HashT3>
inline unsigned
Tuple3<Type1, Type2, Type3>::Hash<HashT1, HashT2, HashT3>::operator()
(
const Tuple3<Type1, Type2, Type3>& t,
unsigned seed
) const
{
// Hash incrementally
unsigned val = seed;
val = HashT1()(t.first(), val);
val = HashT2()(t.second(), val);
val = HashT3()(t.third(), val);
return val;
}
//- Return reverse of a tuple3
template<class Type1, class Type2, class Type3>
inline Tuple3<Type3, Type2, Type1> reverse
(
const Tuple3<Type1, Type2, Type3>& t
)
{
return Tuple3<Type3, Type2, Type1>(t.third(), t.second(), t.first());
}
template<class Type1, class Type2, class Type3>
inline bool operator==
(
const Tuple3<Type1, Type2, Type3>& a,
const Tuple3<Type1, Type2, Type3>& b
)
{
return
(
a.first() == b.first()
&& a.second() == b.second()
&& a.third() == b.third()
);
}
template<class Type1, class Type2, class Type3>
inline bool operator!=
(
const Tuple3<Type1, Type2, Type3>& a,
const Tuple3<Type1, Type2, Type3>& b
)
{
return !(a == b);
}
template<class Type1, class Type2, class Type3>
inline Istream& operator>>(Istream& is, Tuple3<Type1, Type2, Type3>& t3)
{
is.readBegin("Tuple3");
is >> t3.f_ >> t3.s_ >> t3.t_;
is.readEnd("Tuple3");
// Check state of Istream
is.check("operator>>(Istream&, Tuple3<Type1, Type2, Type3>&)");
return is;
}
template<class Type1, class Type2, class Type3>
inline Ostream& operator<<(Ostream& os, const Tuple3<Type1, Type2, Type3>& t2)
{
os << token::BEGIN_LIST
<< t2.f_ << token::SPACE << t2.s_ << token::SPACE << t2.t_
<< token::END_LIST;
return os;
}
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|