1 //===-- lib/Evaluate/fold-logical.cpp -------------------------------------===// 2 // 3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. 4 // See https://llvm.org/LICENSE.txt for license information. 5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 6 // 7 //===----------------------------------------------------------------------===// 8 9 #include "fold-implementation.h" 10 #include "flang/Evaluate/check-expression.h" 11 12 namespace Fortran::evaluate { 13 14 template <int KIND> 15 Expr<Type<TypeCategory::Logical, KIND>> FoldIntrinsicFunction( 16 FoldingContext &context, 17 FunctionRef<Type<TypeCategory::Logical, KIND>> &&funcRef) { 18 using T = Type<TypeCategory::Logical, KIND>; 19 ActualArguments &args{funcRef.arguments()}; 20 auto *intrinsic{std::get_if<SpecificIntrinsic>(&funcRef.proc().u)}; 21 CHECK(intrinsic); 22 std::string name{intrinsic->name}; 23 if (name == "all") { 24 if (!args[1]) { // TODO: ALL(x,DIM=d) 25 if (const auto *constant{UnwrapConstantValue<T>(args[0])}) { 26 bool result{true}; 27 for (const auto &element : constant->values()) { 28 if (!element.IsTrue()) { 29 result = false; 30 break; 31 } 32 } 33 return Expr<T>{result}; 34 } 35 } 36 } else if (name == "any") { 37 if (!args[1]) { // TODO: ANY(x,DIM=d) 38 if (const auto *constant{UnwrapConstantValue<T>(args[0])}) { 39 bool result{false}; 40 for (const auto &element : constant->values()) { 41 if (element.IsTrue()) { 42 result = true; 43 break; 44 } 45 } 46 return Expr<T>{result}; 47 } 48 } 49 } else if (name == "associated") { 50 bool gotConstant{true}; 51 const Expr<SomeType> *firstArgExpr{args[0]->UnwrapExpr()}; 52 if (!firstArgExpr || !IsNullPointer(*firstArgExpr)) { 53 gotConstant = false; 54 } else if (args[1]) { // There's a second argument 55 const Expr<SomeType> *secondArgExpr{args[1]->UnwrapExpr()}; 56 if (!secondArgExpr || !IsNullPointer(*secondArgExpr)) { 57 gotConstant = false; 58 } 59 } 60 return gotConstant ? Expr<T>{false} : Expr<T>{std::move(funcRef)}; 61 } else if (name == "bge" || name == "bgt" || name == "ble" || name == "blt") { 62 using LargestInt = Type<TypeCategory::Integer, 16>; 63 static_assert(std::is_same_v<Scalar<LargestInt>, BOZLiteralConstant>); 64 // Arguments do not have to be of the same integer type. Convert all 65 // arguments to the biggest integer type before comparing them to 66 // simplify. 67 for (int i{0}; i <= 1; ++i) { 68 if (auto *x{UnwrapExpr<Expr<SomeInteger>>(args[i])}) { 69 *args[i] = AsGenericExpr( 70 Fold(context, ConvertToType<LargestInt>(std::move(*x)))); 71 } else if (auto *x{UnwrapExpr<BOZLiteralConstant>(args[i])}) { 72 *args[i] = AsGenericExpr(Constant<LargestInt>{std::move(*x)}); 73 } 74 } 75 auto fptr{&Scalar<LargestInt>::BGE}; 76 if (name == "bge") { // done in fptr declaration 77 } else if (name == "bgt") { 78 fptr = &Scalar<LargestInt>::BGT; 79 } else if (name == "ble") { 80 fptr = &Scalar<LargestInt>::BLE; 81 } else if (name == "blt") { 82 fptr = &Scalar<LargestInt>::BLT; 83 } else { 84 common::die("missing case to fold intrinsic function %s", name.c_str()); 85 } 86 return FoldElementalIntrinsic<T, LargestInt, LargestInt>(context, 87 std::move(funcRef), 88 ScalarFunc<T, LargestInt, LargestInt>( 89 [&fptr](const Scalar<LargestInt> &i, const Scalar<LargestInt> &j) { 90 return Scalar<T>{std::invoke(fptr, i, j)}; 91 })); 92 } else if (name == "isnan") { 93 // A warning about an invalid argument is discarded from converting 94 // the argument of isnan(). 95 auto restorer{context.messages().DiscardMessages()}; 96 using DefaultReal = Type<TypeCategory::Real, 4>; 97 return FoldElementalIntrinsic<T, DefaultReal>(context, std::move(funcRef), 98 ScalarFunc<T, DefaultReal>([](const Scalar<DefaultReal> &x) { 99 return Scalar<T>{x.IsNotANumber()}; 100 })); 101 } else if (name == "is_contiguous") { 102 if (args.at(0)) { 103 if (auto *expr{args[0]->UnwrapExpr()}) { 104 if (IsSimplyContiguous(*expr, context.intrinsics())) { 105 return Expr<T>{true}; 106 } 107 } 108 } 109 } else if (name == "merge") { 110 return FoldMerge<T>(context, std::move(funcRef)); 111 } 112 // TODO: btest, cshift, dot_product, eoshift, is_iostat_end, 113 // is_iostat_eor, lge, lgt, lle, llt, logical, matmul, out_of_range, 114 // pack, parity, reduce, spread, transfer, transpose, unpack, 115 // extends_type_of, same_type_as 116 return Expr<T>{std::move(funcRef)}; 117 } 118 119 template <typename T> 120 Expr<LogicalResult> FoldOperation( 121 FoldingContext &context, Relational<T> &&relation) { 122 if (auto array{ApplyElementwise(context, relation, 123 std::function<Expr<LogicalResult>(Expr<T> &&, Expr<T> &&)>{ 124 [=](Expr<T> &&x, Expr<T> &&y) { 125 return Expr<LogicalResult>{Relational<SomeType>{ 126 Relational<T>{relation.opr, std::move(x), std::move(y)}}}; 127 }})}) { 128 return *array; 129 } 130 if (auto folded{OperandsAreConstants(relation)}) { 131 bool result{}; 132 if constexpr (T::category == TypeCategory::Integer) { 133 result = 134 Satisfies(relation.opr, folded->first.CompareSigned(folded->second)); 135 } else if constexpr (T::category == TypeCategory::Real) { 136 result = Satisfies(relation.opr, folded->first.Compare(folded->second)); 137 } else if constexpr (T::category == TypeCategory::Character) { 138 result = Satisfies(relation.opr, Compare(folded->first, folded->second)); 139 } else { 140 static_assert(T::category != TypeCategory::Complex && 141 T::category != TypeCategory::Logical); 142 } 143 return Expr<LogicalResult>{Constant<LogicalResult>{result}}; 144 } 145 return Expr<LogicalResult>{Relational<SomeType>{std::move(relation)}}; 146 } 147 148 Expr<LogicalResult> FoldOperation( 149 FoldingContext &context, Relational<SomeType> &&relation) { 150 return std::visit( 151 [&](auto &&x) { 152 return Expr<LogicalResult>{FoldOperation(context, std::move(x))}; 153 }, 154 std::move(relation.u)); 155 } 156 157 template <int KIND> 158 Expr<Type<TypeCategory::Logical, KIND>> FoldOperation( 159 FoldingContext &context, Not<KIND> &&x) { 160 if (auto array{ApplyElementwise(context, x)}) { 161 return *array; 162 } 163 using Ty = Type<TypeCategory::Logical, KIND>; 164 auto &operand{x.left()}; 165 if (auto value{GetScalarConstantValue<Ty>(operand)}) { 166 return Expr<Ty>{Constant<Ty>{!value->IsTrue()}}; 167 } 168 return Expr<Ty>{x}; 169 } 170 171 template <int KIND> 172 Expr<Type<TypeCategory::Logical, KIND>> FoldOperation( 173 FoldingContext &context, LogicalOperation<KIND> &&operation) { 174 using LOGICAL = Type<TypeCategory::Logical, KIND>; 175 if (auto array{ApplyElementwise(context, operation, 176 std::function<Expr<LOGICAL>(Expr<LOGICAL> &&, Expr<LOGICAL> &&)>{ 177 [=](Expr<LOGICAL> &&x, Expr<LOGICAL> &&y) { 178 return Expr<LOGICAL>{LogicalOperation<KIND>{ 179 operation.logicalOperator, std::move(x), std::move(y)}}; 180 }})}) { 181 return *array; 182 } 183 if (auto folded{OperandsAreConstants(operation)}) { 184 bool xt{folded->first.IsTrue()}, yt{folded->second.IsTrue()}, result{}; 185 switch (operation.logicalOperator) { 186 case LogicalOperator::And: 187 result = xt && yt; 188 break; 189 case LogicalOperator::Or: 190 result = xt || yt; 191 break; 192 case LogicalOperator::Eqv: 193 result = xt == yt; 194 break; 195 case LogicalOperator::Neqv: 196 result = xt != yt; 197 break; 198 case LogicalOperator::Not: 199 DIE("not a binary operator"); 200 } 201 return Expr<LOGICAL>{Constant<LOGICAL>{result}}; 202 } 203 return Expr<LOGICAL>{std::move(operation)}; 204 } 205 206 FOR_EACH_LOGICAL_KIND(template class ExpressionBase, ) 207 template class ExpressionBase<SomeLogical>; 208 } // namespace Fortran::evaluate 209