songtianlun/openfoam
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

ENH: use combined &=, |=, ^= forms for bitAndEqOp, bitOrEqOp, bitXorEqOp

Browse Source 
- these also work for bitSet, HashSet with slightly lower overhead

ENH: locate FOAM_NODISCARD attribute macro in stdFoam.H
This commit is contained in:
Mark Olesen 2022-09-08 13:53:22 +02:00
parent 47e172e6ef
commit 968c1db1af
4 changed files with 29 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
applications/test/scalarOps/Test-scalarOps.C
View File

@ -126,6 +126,9 @@ int main(int argc, char *argv[])
testDivide<vector>(vectors);
//(void) compareOp<vector>()(vector::zero, vector::one);
Info<< "\nEnd\n" << endl;
return 0;

9
src/OpenFOAM/include/stdFoam.H
View File

@ -52,6 +52,15 @@ Description
# define FOAM_DEPRECATED_FOR(since, replacement)
#endif
// Compile-time warning about unused result
// FUTURE: check __has_cpp_attribute(nodiscard) and define with [[nodiscard]]
#if defined(__GNUC__)
# define FOAM_NODISCARD __attribute__((warn_unused_result))
#else
# define FOAM_NODISCARD
#endif
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
//- Namespace for OpenFOAM

4
src/OpenFOAM/primitives/Scalar/Scalar.H
View File

@ -38,12 +38,12 @@ Note
template<class T>
struct floorOp
{
T operator()(const T& x) const WARNRETURN
T operator()(const T& x) const
{
T ret;
for (direction cmpt=0; cmpt < pTraits<T>::nComponents; ++cmpt)
{
component(ret, cmpt) = std::floor(component(x, cmpt));
setComponent(ret, cmpt) = std::floor(component(x, cmpt));
}
return ret;
}

39
src/OpenFOAM/primitives/ops/ops.H
View File

@ -37,6 +37,8 @@ Description
#ifndef Foam_ops_H
#define Foam_ops_H
#include "stdFoam.H" // For FOAM_NODISCARD
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
@ -73,21 +75,21 @@ EqOp(plusEq, x += y)
EqOp(minusEq, x -= y)
EqOp(multiplyEq, x *= y)
EqOp(divideEq, x /= y)
EqOp(eqSqr, x = sqr(y))
EqOp(eqMag, x = mag(y))
EqOp(eqSqr, x = sqr(y))
EqOp(eqMagSqr, x = magSqr(y))
EqOp(plusEqMagSqr, x += magSqr(y))
EqOp(maxEq, x = max(x, y))
EqOp(minEq, x = min(x, y))
EqOp(maxEq, x = max(x, y))
EqOp(minMagSqrEq, x = (magSqr(x) <= magSqr(y) ? x : y))
EqOp(maxMagSqrEq, x = (magSqr(x) >= magSqr(y) ? x : y))
EqOp(andEq, x = (x && y))
EqOp(orEq, x = (x || y))
EqOp(xorEq, x = (x != y))
EqOp(bitAndEq, x = (x & y))
EqOp(bitOrEq, x = (x | y))
EqOp(bitXorEq, x = (x ^ y))
EqOp(bitAndEq, x &= y)
EqOp(bitOrEq, x |= y)
EqOp(bitXorEq, x ^= y)
EqOp(eqMinus, x = -y)
@ -98,13 +100,6 @@ EqOp(nopEq, (void)x)
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
// Warning about unused result
#if __GNUC__
#define WARNRETURN __attribute__((warn_unused_result))
#else
#define WARNRETURN
#endif
// Operation taking two parameters, returning the first type.
// Neither parameter is altered.
// Eg, plusOp for (x + y)
@ -114,7 +109,7 @@ EqOp(nopEq, (void)x)
template<class T, class T1, class T2> \
struct opName##Op3 \
{ \
T operator()(const T1& x, const T2& y) const WARNRETURN \
FOAM_NODISCARD T operator()(const T1& x, const T2& y) const \
{ \
return op; \
} \
@ -123,7 +118,7 @@ EqOp(nopEq, (void)x)
template<class T1, class T2> \
struct opName##Op2 \
{ \
T1 operator()(const T1& x, const T2& y) const WARNRETURN \
FOAM_NODISCARD T1 operator()(const T1& x, const T2& y) const \
{ \
return op; \
} \
@ -132,7 +127,7 @@ EqOp(nopEq, (void)x)
template<class T> \
struct opName##Op \
{ \
T operator()(const T& x, const T& y) const WARNRETURN \
FOAM_NODISCARD T operator()(const T& x, const T& y) const \
{ \
return op; \
} \
@ -146,7 +141,7 @@ EqOp(nopEq, (void)x)
template<class T1, class T2> \
struct opName##Op2 \
{ \
bool operator()(const T1& x, const T2& y) const WARNRETURN \
FOAM_NODISCARD bool operator()(const T1& x, const T2& y) const \
{ \
return op; \
} \
@ -155,7 +150,7 @@ EqOp(nopEq, (void)x)
template<class T> \
struct opName##Op \
{ \
bool operator()(const T& x, const T& y) const WARNRETURN \
FOAM_NODISCARD bool operator()(const T& x, const T& y) const \
{ \
return op; \
} \
@ -174,7 +169,7 @@ EqOp(nopEq, (void)x)
\
opName##Op1(const T& v) : value(v) {} \
\
bool operator()(const T& x) const WARNRETURN \
FOAM_NODISCARD bool operator()(const T& x) const \
{ \
return op; \
} \
@ -220,8 +215,8 @@ Op(cmptMultiply, cmptMultiply(x, y))
Op(cmptPow, cmptPow(x, y))
Op(cmptDivide, cmptDivide(x, y))
Op(stabilise, stabilise(x, y))
Op(max, max(x, y))
Op(min, min(x, y))
Op(max, max(x, y))
Op(minMagSqr, (magSqr(x) <= magSqr(y) ? x : y))
Op(maxMagSqr, (magSqr(x) >= magSqr(y) ? x : y))
Op(minMod, minMod(x, y))
@ -267,7 +262,7 @@ WeightedOp(multiply, (weight*y))
template<class T>
struct compareOp
{
int operator()(const T& a, const T& b) const WARNRETURN
FOAM_NODISCARD int operator()(const T& a, const T& b) const
{
return (a < b) ? -1 : (b < a) ? 1 : 0;
}
@ -283,10 +278,6 @@ template<class T> struct getNameOp : nameOp<T> {};
template<class T> struct getTypeOp : typeOp<T> {};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#undef WARNRETURN
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam