FLANG
fold-implementation.h
1//===-- lib/Evaluate/fold-implementation.h --------------------------------===//
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#ifndef FORTRAN_EVALUATE_FOLD_IMPLEMENTATION_H_
10#define FORTRAN_EVALUATE_FOLD_IMPLEMENTATION_H_
11
12#include "character.h"
13#include "host.h"
14#include "int-power.h"
15#include "flang/Common/indirection.h"
16#include "flang/Common/template.h"
17#include "flang/Common/unwrap.h"
18#include "flang/Evaluate/characteristics.h"
19#include "flang/Evaluate/common.h"
20#include "flang/Evaluate/constant.h"
21#include "flang/Evaluate/expression.h"
22#include "flang/Evaluate/fold.h"
23#include "flang/Evaluate/intrinsics-library.h"
24#include "flang/Evaluate/intrinsics.h"
25#include "flang/Evaluate/shape.h"
26#include "flang/Evaluate/tools.h"
27#include "flang/Evaluate/traverse.h"
28#include "flang/Evaluate/type.h"
29#include "flang/Parser/message.h"
30#include "flang/Semantics/scope.h"
31#include "flang/Semantics/symbol.h"
32#include "flang/Semantics/tools.h"
33#include <algorithm>
34#include <cmath>
35#include <cstdio>
36#include <optional>
37#include <type_traits>
38#include <variant>
39
40// Some environments, viz. glibc 2.17 and *BSD, allow the macro HUGE
41// to leak out of <math.h>.
42#undef HUGE
43
44namespace Fortran::evaluate {
45
46// Don't use Kahan extended precision summation any more when folding
47// transformational intrinsic functions other than SUM, since it is
48// not used in the runtime implementations of those functions and we
49// want results to match.
50static constexpr bool useKahanSummation{false};
51
52// Utilities
53template <typename T> class Folder {
54public:
55 explicit Folder(FoldingContext &c, bool forOptionalArgument = false)
56 : context_{c}, forOptionalArgument_{forOptionalArgument} {}
57 std::optional<Constant<T>> GetNamedConstant(const Symbol &);
58 std::optional<Constant<T>> ApplySubscripts(const Constant<T> &array,
59 const std::vector<Constant<SubscriptInteger>> &subscripts);
60 std::optional<Constant<T>> ApplyComponent(Constant<SomeDerived> &&,
61 const Symbol &component,
62 const std::vector<Constant<SubscriptInteger>> * = nullptr);
63 std::optional<Constant<T>> GetConstantComponent(
64 Component &, const std::vector<Constant<SubscriptInteger>> * = nullptr);
65 std::optional<Constant<T>> Folding(ArrayRef &);
66 std::optional<Constant<T>> Folding(DataRef &);
67 Expr<T> Folding(Designator<T> &&);
68 Constant<T> *Folding(std::optional<ActualArgument> &);
69
70 Expr<T> CSHIFT(FunctionRef<T> &&);
71 Expr<T> EOSHIFT(FunctionRef<T> &&);
72 Expr<T> MERGE(FunctionRef<T> &&);
73 Expr<T> PACK(FunctionRef<T> &&);
74 Expr<T> RESHAPE(FunctionRef<T> &&);
75 Expr<T> SPREAD(FunctionRef<T> &&);
76 Expr<T> TRANSPOSE(FunctionRef<T> &&);
77 Expr<T> UNPACK(FunctionRef<T> &&);
78
79 Expr<T> TRANSFER(FunctionRef<T> &&);
80
81private:
82 FoldingContext &context_;
83 bool forOptionalArgument_{false};
84};
85
86std::optional<Constant<SubscriptInteger>> GetConstantSubscript(
87 FoldingContext &, Subscript &, const NamedEntity &, int dim);
88
89// Helper to use host runtime on scalars for folding.
90template <typename TR, typename... TA>
91std::optional<std::function<Scalar<TR>(FoldingContext &, Scalar<TA>...)>>
92GetHostRuntimeWrapper(const std::string &name) {
93 std::vector<DynamicType> argTypes{TA{}.GetType()...};
94 if (auto hostWrapper{GetHostRuntimeWrapper(name, TR{}.GetType(), argTypes)}) {
95 return [hostWrapper](
96 FoldingContext &context, Scalar<TA>... args) -> Scalar<TR> {
97 std::vector<Expr<SomeType>> genericArgs{
98 AsGenericExpr(Constant<TA>{args})...};
99 return GetScalarConstantValue<TR>(
100 (*hostWrapper)(context, std::move(genericArgs)))
101 .value();
102 };
103 }
104 return std::nullopt;
105}
106
107// FoldOperation() rewrites expression tree nodes.
108// If there is any possibility that the rewritten node will
109// not have the same representation type, the result of
110// FoldOperation() will be packaged in an Expr<> of the same
111// specific type.
112
113// no-op base case
114template <typename A>
115common::IfNoLvalue<Expr<ResultType<A>>, A> FoldOperation(
116 FoldingContext &, A &&x) {
117 static_assert(!std::is_same_v<A, Expr<ResultType<A>>>,
118 "call Fold() instead for Expr<>");
119 return Expr<ResultType<A>>{std::move(x)};
120}
121
122Component FoldOperation(FoldingContext &, Component &&);
123NamedEntity FoldOperation(FoldingContext &, NamedEntity &&);
124Triplet FoldOperation(FoldingContext &, Triplet &&);
125Subscript FoldOperation(FoldingContext &, Subscript &&);
126ArrayRef FoldOperation(FoldingContext &, ArrayRef &&);
127CoarrayRef FoldOperation(FoldingContext &, CoarrayRef &&);
128DataRef FoldOperation(FoldingContext &, DataRef &&);
129Substring FoldOperation(FoldingContext &, Substring &&);
130ComplexPart FoldOperation(FoldingContext &, ComplexPart &&);
131template <typename T>
132Expr<T> FoldOperation(FoldingContext &, FunctionRef<T> &&);
133template <typename T>
134Expr<T> FoldOperation(FoldingContext &context, Designator<T> &&designator) {
135 return Folder<T>{context}.Folding(std::move(designator));
136}
139Expr<ImpliedDoIndex::Result> FoldOperation(
140 FoldingContext &context, ImpliedDoIndex &&);
141template <typename T>
142Expr<T> FoldOperation(FoldingContext &, ArrayConstructor<T> &&);
144template <typename T>
145Expr<T> FoldOperation(FoldingContext &, ConditionalExpr<T> &&);
146
147template <typename T>
148std::optional<Constant<T>> Folder<T>::GetNamedConstant(const Symbol &symbol0) {
149 const Symbol &symbol{ResolveAssociations(symbol0)};
150 if (IsNamedConstant(symbol)) {
151 if (const auto *object{
152 symbol.detailsIf<semantics::ObjectEntityDetails>()}) {
153 if (const auto *constant{UnwrapConstantValue<T>(object->init())}) {
154 return *constant;
155 }
156 }
157 }
158 return std::nullopt;
159}
160
161template <typename T>
162std::optional<Constant<T>> Folder<T>::Folding(ArrayRef &aRef) {
163 std::vector<Constant<SubscriptInteger>> subscripts;
164 int dim{0};
165 for (Subscript &ss : aRef.subscript()) {
166 if (auto constant{GetConstantSubscript(context_, ss, aRef.base(), dim++)}) {
167 subscripts.emplace_back(std::move(*constant));
168 } else {
169 return std::nullopt;
170 }
171 }
172 if (Component * component{aRef.base().UnwrapComponent()}) {
173 return GetConstantComponent(*component, &subscripts);
174 } else if (std::optional<Constant<T>> array{
175 GetNamedConstant(aRef.base().GetLastSymbol())}) {
176 return ApplySubscripts(*array, subscripts);
177 } else {
178 return std::nullopt;
179 }
180}
181
182template <typename T>
183std::optional<Constant<T>> Folder<T>::Folding(DataRef &ref) {
184 return common::visit(
185 common::visitors{
186 [this](SymbolRef &sym) { return GetNamedConstant(*sym); },
187 [this](Component &comp) {
188 comp = FoldOperation(context_, std::move(comp));
189 return GetConstantComponent(comp);
190 },
191 [this](ArrayRef &aRef) {
192 aRef = FoldOperation(context_, std::move(aRef));
193 return Folding(aRef);
194 },
195 [](CoarrayRef &) { return std::optional<Constant<T>>{}; },
196 },
197 ref.u);
198}
199
200// TODO: This would be more natural as a member function of Constant<T>.
201template <typename T>
202std::optional<Constant<T>> Folder<T>::ApplySubscripts(const Constant<T> &array,
203 const std::vector<Constant<SubscriptInteger>> &subscripts) {
204 const auto &shape{array.shape()};
205 const auto &lbounds{array.lbounds()};
206 int rank{GetRank(shape)};
207 CHECK(rank == static_cast<int>(subscripts.size()));
208 std::size_t elements{1};
209 ConstantSubscripts resultShape;
210 ConstantSubscripts ssLB;
211 for (const auto &ss : subscripts) {
212 if (ss.Rank() == 1) {
213 resultShape.push_back(static_cast<ConstantSubscript>(ss.size()));
214 elements *= ss.size();
215 ssLB.push_back(ss.lbounds().front());
216 } else if (ss.Rank() > 1) {
217 return std::nullopt; // error recovery
218 }
219 }
220 ConstantSubscripts ssAt(rank, 0), at(rank, 0), tmp(1, 0);
221 std::vector<Scalar<T>> values;
222 while (elements-- > 0) {
223 bool increment{true};
224 int k{0};
225 for (int j{0}; j < rank; ++j) {
226 if (subscripts[j].Rank() == 0) {
227 at[j] = subscripts[j].GetScalarValue().value().ToInt64();
228 } else {
229 CHECK(k < GetRank(resultShape));
230 tmp[0] = ssLB.at(k) + ssAt.at(k);
231 at[j] = subscripts[j].At(tmp).ToInt64();
232 if (increment) {
233 if (++ssAt[k] == resultShape[k]) {
234 ssAt[k] = 0;
235 } else {
236 increment = false;
237 }
238 }
239 ++k;
240 }
241 if (at[j] < lbounds[j] || at[j] >= lbounds[j] + shape[j]) {
242 context_.messages().Say(
243 "Subscript value (%jd) is out of range on dimension %d in reference to a constant array value"_err_en_US,
244 at[j], j + 1);
245 return std::nullopt;
246 }
247 }
248 values.emplace_back(array.At(at));
249 CHECK(!increment || elements == 0);
250 CHECK(k == GetRank(resultShape));
251 }
252 if constexpr (T::category == TypeCategory::Character) {
253 return Constant<T>{array.LEN(), std::move(values), std::move(resultShape)};
254 } else if constexpr (std::is_same_v<T, SomeDerived>) {
255 return Constant<T>{array.result().derivedTypeSpec(), std::move(values),
256 std::move(resultShape)};
257 } else {
258 return Constant<T>{std::move(values), std::move(resultShape)};
259 }
260}
261
262template <typename T>
263std::optional<Constant<T>> Folder<T>::ApplyComponent(
264 Constant<SomeDerived> &&structures, const Symbol &component,
265 const std::vector<Constant<SubscriptInteger>> *subscripts) {
266 if (auto scalar{structures.GetScalarValue()}) {
267 if (std::optional<Expr<SomeType>> expr{scalar->Find(component)}) {
268 if (const Constant<T> *value{UnwrapConstantValue<T>(*expr)}) {
269 if (subscripts) {
270 return ApplySubscripts(*value, *subscripts);
271 } else {
272 return *value;
273 }
274 }
275 }
276 } else {
277 // A(:)%scalar_component & A(:)%array_component(subscripts)
278 std::unique_ptr<ArrayConstructor<T>> array;
279 if (structures.empty()) {
280 return std::nullopt;
281 }
282 ConstantSubscripts at{structures.lbounds()};
283 do {
284 StructureConstructor scalar{structures.At(at)};
285 if (std::optional<Expr<SomeType>> expr{scalar.Find(component)}) {
286 if (const Constant<T> *value{UnwrapConstantValue<T>(expr.value())}) {
287 if (!array.get()) {
288 // This technique ensures that character length or derived type
289 // information is propagated to the array constructor.
290 auto *typedExpr{UnwrapExpr<Expr<T>>(expr.value())};
291 CHECK(typedExpr);
292 array = std::make_unique<ArrayConstructor<T>>(*typedExpr);
293 if constexpr (T::category == TypeCategory::Character) {
294 array->set_LEN(Expr<SubscriptInteger>{value->LEN()});
295 }
296 }
297 if (subscripts) {
298 if (auto element{ApplySubscripts(*value, *subscripts)}) {
299 CHECK(element->Rank() == 0);
300 array->Push(Expr<T>{std::move(*element)});
301 } else {
302 return std::nullopt;
303 }
304 } else {
305 CHECK(value->Rank() == 0);
306 array->Push(Expr<T>{*value});
307 }
308 } else {
309 return std::nullopt;
310 }
311 }
312 } while (structures.IncrementSubscripts(at));
313 // Fold the ArrayConstructor<> into a Constant<>.
314 CHECK(array);
315 Expr<T> result{Fold(context_, Expr<T>{std::move(*array)})};
316 if (auto *constant{UnwrapConstantValue<T>(result)}) {
317 return constant->Reshape(common::Clone(structures.shape()));
318 }
319 }
320 return std::nullopt;
321}
322
323template <typename T>
324std::optional<Constant<T>> Folder<T>::GetConstantComponent(Component &component,
325 const std::vector<Constant<SubscriptInteger>> *subscripts) {
326 if (std::optional<Constant<SomeDerived>> structures{common::visit(
327 common::visitors{
328 [&](const Symbol &symbol) {
329 return Folder<SomeDerived>{context_}.GetNamedConstant(symbol);
330 },
331 [&](ArrayRef &aRef) {
332 return Folder<SomeDerived>{context_}.Folding(aRef);
333 },
334 [&](Component &base) {
335 return Folder<SomeDerived>{context_}.GetConstantComponent(base);
336 },
337 [&](CoarrayRef &) {
338 return std::optional<Constant<SomeDerived>>{};
339 },
340 },
341 component.base().u)}) {
342 return ApplyComponent(
343 std::move(*structures), component.GetLastSymbol(), subscripts);
344 } else {
345 return std::nullopt;
346 }
347}
348
349template <typename T> Expr<T> Folder<T>::Folding(Designator<T> &&designator) {
350 if constexpr (T::category == TypeCategory::Character) {
351 if (auto *substring{common::Unwrap<Substring>(designator.u)}) {
352 if (std::optional<Expr<SomeCharacter>> folded{
353 substring->Fold(context_)}) {
354 if (const auto *specific{std::get_if<Expr<T>>(&folded->u)}) {
355 return std::move(*specific);
356 }
357 }
358 // We used to fold zero-length substrings into zero-length
359 // constants here, but that led to problems in variable
360 // definition contexts.
361 }
362 } else if constexpr (T::category == TypeCategory::Real) {
363 if (auto *zPart{std::get_if<ComplexPart>(&designator.u)}) {
364 *zPart = FoldOperation(context_, std::move(*zPart));
366 if (auto zConst{Folder<ComplexT>{context_}.Folding(zPart->complex())}) {
367 return Fold(context_,
369 zPart->part() == ComplexPart::Part::IM,
370 Expr<ComplexT>{std::move(*zConst)}}});
371 } else {
372 return Expr<T>{Designator<T>{std::move(*zPart)}};
373 }
374 }
375 }
376 return common::visit(
377 common::visitors{
378 [&](SymbolRef &&symbol) {
379 if (auto constant{GetNamedConstant(*symbol)}) {
380 return Expr<T>{std::move(*constant)};
381 }
382 return Expr<T>{std::move(designator)};
383 },
384 [&](ArrayRef &&aRef) {
385 aRef = FoldOperation(context_, std::move(aRef));
386 if (auto c{Folding(aRef)}) {
387 return Expr<T>{std::move(*c)};
388 } else {
389 return Expr<T>{Designator<T>{std::move(aRef)}};
390 }
391 },
392 [&](Component &&component) {
393 component = FoldOperation(context_, std::move(component));
394 if (auto c{GetConstantComponent(component)}) {
395 return Expr<T>{std::move(*c)};
396 } else {
397 return Expr<T>{Designator<T>{std::move(component)}};
398 }
399 },
400 [&](auto &&x) {
401 return Expr<T>{
402 Designator<T>{FoldOperation(context_, std::move(x))}};
403 },
404 },
405 std::move(designator.u));
406}
407
408// Apply type conversion and re-folding if necessary.
409// This is where BOZ arguments are converted.
410template <typename T>
411Constant<T> *Folder<T>::Folding(std::optional<ActualArgument> &arg) {
412 if (auto *expr{UnwrapExpr<Expr<SomeType>>(arg)}) {
413 *expr = Fold(context_, std::move(*expr));
414 if constexpr (T::category != TypeCategory::Derived) {
415 if (!UnwrapExpr<Expr<T>>(*expr)) {
416 if (const Symbol *
417 var{forOptionalArgument_
418 ? UnwrapWholeSymbolOrComponentDataRef(*expr)
419 : nullptr};
420 var && (IsOptional(*var) || IsAllocatableOrObjectPointer(var))) {
421 // can't safely convert item that may not be present
422 } else if (auto converted{
423 ConvertToType(T::GetType(), std::move(*expr))}) {
424 *expr = Fold(context_, std::move(*converted));
425 }
426 }
427 }
428 return UnwrapConstantValue<T>(*expr);
429 }
430 return nullptr;
431}
432
433template <typename... A, std::size_t... I>
434std::optional<std::tuple<const Constant<A> *...>> GetConstantArgumentsHelper(
435 FoldingContext &context, ActualArguments &arguments,
436 bool hasOptionalArgument, std::index_sequence<I...>) {
437 static_assert(sizeof...(A) > 0);
438 std::tuple<const Constant<A> *...> args{
439 Folder<A>{context, hasOptionalArgument}.Folding(arguments.at(I))...};
440 if ((... && (std::get<I>(args)))) {
441 return args;
442 } else {
443 return std::nullopt;
444 }
445}
446
447template <typename... A>
448std::optional<std::tuple<const Constant<A> *...>> GetConstantArguments(
449 FoldingContext &context, ActualArguments &args, bool hasOptionalArgument) {
450 return GetConstantArgumentsHelper<A...>(
451 context, args, hasOptionalArgument, std::index_sequence_for<A...>{});
452}
453
454template <typename... A, std::size_t... I>
455std::optional<std::tuple<Scalar<A>...>> GetScalarConstantArgumentsHelper(
456 FoldingContext &context, ActualArguments &args, bool hasOptionalArgument,
457 std::index_sequence<I...>) {
458 if (auto constArgs{
459 GetConstantArguments<A...>(context, args, hasOptionalArgument)}) {
460 return std::tuple<Scalar<A>...>{
461 std::get<I>(*constArgs)->GetScalarValue().value()...};
462 } else {
463 return std::nullopt;
464 }
465}
466
467template <typename... A>
468std::optional<std::tuple<Scalar<A>...>> GetScalarConstantArguments(
469 FoldingContext &context, ActualArguments &args, bool hasOptionalArgument) {
470 return GetScalarConstantArgumentsHelper<A...>(
471 context, args, hasOptionalArgument, std::index_sequence_for<A...>{});
472}
473
474// helpers to fold intrinsic function references
475// Define callable types used in a common utility that
476// takes care of array and cast/conversion aspects for elemental intrinsics
477
478template <typename TR, typename... TArgs>
479using ScalarFunc = std::function<Scalar<TR>(const Scalar<TArgs> &...)>;
480template <typename TR, typename... TArgs>
481using ScalarFuncWithContext =
482 std::function<Scalar<TR>(FoldingContext &, const Scalar<TArgs> &...)>;
483
484template <template <typename, typename...> typename WrapperType, typename TR,
485 typename... TA, std::size_t... I>
486Expr<TR> FoldElementalIntrinsicHelper(FoldingContext &context,
487 FunctionRef<TR> &&funcRef, WrapperType<TR, TA...> func,
488 bool hasOptionalArgument, std::index_sequence<I...>) {
489 if (std::optional<std::tuple<const Constant<TA> *...>> args{
490 GetConstantArguments<TA...>(
491 context, funcRef.arguments(), hasOptionalArgument)}) {
492 // Compute the shape of the result based on shapes of arguments
493 ConstantSubscripts shape;
494 int rank{0};
495 const ConstantSubscripts *shapes[]{&std::get<I>(*args)->shape()...};
496 const int ranks[]{std::get<I>(*args)->Rank()...};
497 for (unsigned int i{0}; i < sizeof...(TA); ++i) {
498 if (ranks[i] > 0) {
499 if (rank == 0) {
500 rank = ranks[i];
501 shape = *shapes[i];
502 } else {
503 if (shape != *shapes[i]) {
504 // TODO: Rank compatibility was already checked but it seems to be
505 // the first place where the actual shapes are checked to be the
506 // same. Shouldn't this be checked elsewhere so that this is also
507 // checked for non constexpr call to elemental intrinsics function?
508 context.messages().Say(
509 "Arguments in elemental intrinsic function are not conformable"_err_en_US);
510 return Expr<TR>{std::move(funcRef)};
511 }
512 }
513 }
514 }
515 CHECK(rank == GetRank(shape));
516 // Compute all the scalar values of the results
517 std::vector<Scalar<TR>> results;
518 std::optional<uint64_t> n{TotalElementCount(shape)};
519 if (!n) {
520 context.messages().Say(
521 "Too many elements in elemental intrinsic function result"_err_en_US);
522 return Expr<TR>{std::move(funcRef)};
523 }
524 if (*n > 0) {
525 ConstantBounds bounds{shape};
526 ConstantSubscripts resultIndex(rank, 1);
527 ConstantSubscripts argIndex[]{std::get<I>(*args)->lbounds()...};
528 do {
529 if constexpr (std::is_same_v<WrapperType<TR, TA...>,
530 ScalarFuncWithContext<TR, TA...>>) {
531 results.emplace_back(
532 func(context, std::get<I>(*args)->At(argIndex[I])...));
533 } else if constexpr (std::is_same_v<WrapperType<TR, TA...>,
534 ScalarFunc<TR, TA...>>) {
535 results.emplace_back(func(std::get<I>(*args)->At(argIndex[I])...));
536 }
537 (std::get<I>(*args)->IncrementSubscripts(argIndex[I]), ...);
538 } while (bounds.IncrementSubscripts(resultIndex));
539 }
540 // Build and return constant result
541 if constexpr (TR::category == TypeCategory::Character) {
542 auto len{static_cast<ConstantSubscript>(
543 results.empty() ? 0 : results[0].length())};
544 return Expr<TR>{Constant<TR>{len, std::move(results), std::move(shape)}};
545 } else if constexpr (TR::category == TypeCategory::Derived) {
546 if (!results.empty()) {
547 return Expr<TR>{rank == 0
548 ? Constant<TR>{results.front()}
549 : Constant<TR>{results.front().derivedTypeSpec(),
550 std::move(results), std::move(shape)}};
551 }
552 } else {
553 return Expr<TR>{Constant<TR>{std::move(results), std::move(shape)}};
554 }
555 }
556 return Expr<TR>{std::move(funcRef)};
557}
558
559template <typename TR, typename... TA>
560Expr<TR> FoldElementalIntrinsic(FoldingContext &context,
561 FunctionRef<TR> &&funcRef, ScalarFunc<TR, TA...> func,
562 bool hasOptionalArgument = false) {
563 return FoldElementalIntrinsicHelper<ScalarFunc, TR, TA...>(context,
564 std::move(funcRef), func, hasOptionalArgument,
565 std::index_sequence_for<TA...>{});
566}
567template <typename TR, typename... TA>
568Expr<TR> FoldElementalIntrinsic(FoldingContext &context,
569 FunctionRef<TR> &&funcRef, ScalarFuncWithContext<TR, TA...> func,
570 bool hasOptionalArgument = false) {
571 return FoldElementalIntrinsicHelper<ScalarFuncWithContext, TR, TA...>(context,
572 std::move(funcRef), func, hasOptionalArgument,
573 std::index_sequence_for<TA...>{});
574}
575
576std::optional<std::int64_t> GetInt64ArgOr(
577 const std::optional<ActualArgument> &, std::int64_t defaultValue);
578
579template <typename A, typename B>
580std::optional<std::vector<A>> GetIntegerVector(const B &x) {
581 static_assert(std::is_integral_v<A>);
582 if (const auto *someInteger{UnwrapExpr<Expr<SomeInteger>>(x)}) {
583 return common::visit(
584 [](const auto &typedExpr) -> std::optional<std::vector<A>> {
585 using T = ResultType<decltype(typedExpr)>;
586 if (const auto *constant{UnwrapConstantValue<T>(typedExpr)}) {
587 if (constant->Rank() == 1) {
588 std::vector<A> result;
589 for (const auto &value : constant->values()) {
590 result.push_back(static_cast<A>(value.ToInt64()));
591 }
592 return result;
593 }
594 }
595 return std::nullopt;
596 },
597 someInteger->u);
598 }
599 return std::nullopt;
600}
601
602// Transform an intrinsic function reference that contains user errors
603// into an intrinsic with the same characteristic but the "invalid" name.
604// This to prevent generating warnings over and over if the expression
605// gets re-folded.
606template <typename T> Expr<T> MakeInvalidIntrinsic(FunctionRef<T> &&funcRef) {
607 SpecificIntrinsic invalid{std::get<SpecificIntrinsic>(funcRef.proc().u)};
608 invalid.name = IntrinsicProcTable::InvalidName;
609 return Expr<T>{FunctionRef<T>{ProcedureDesignator{std::move(invalid)},
610 ActualArguments{std::move(funcRef.arguments())}}};
611}
612
613template <typename T> Expr<T> Folder<T>::CSHIFT(FunctionRef<T> &&funcRef) {
614 auto args{funcRef.arguments()};
615 CHECK(args.size() == 3);
616 const auto *array{UnwrapConstantValue<T>(args[0])};
617 const auto *shiftExpr{UnwrapExpr<Expr<SomeInteger>>(args[1])};
618 auto dim{GetInt64ArgOr(args[2], 1)};
619 if (!array || !shiftExpr || !dim) {
620 return Expr<T>{std::move(funcRef)};
621 }
622 auto convertedShift{Fold(context_,
623 ConvertToType<SubscriptInteger>(Expr<SomeInteger>{*shiftExpr}))};
624 const auto *shift{UnwrapConstantValue<SubscriptInteger>(convertedShift)};
625 if (!shift) {
626 return Expr<T>{std::move(funcRef)};
627 }
628 // Arguments are constant
629 if (*dim < 1 || *dim > array->Rank()) {
630 context_.messages().Say("Invalid 'dim=' argument (%jd) in CSHIFT"_err_en_US,
631 static_cast<std::intmax_t>(*dim));
632 } else if (shift->Rank() > 0 && shift->Rank() != array->Rank() - 1) {
633 // message already emitted from intrinsic look-up
634 } else {
635 int rank{array->Rank()};
636 int zbDim{static_cast<int>(*dim) - 1};
637 bool ok{true};
638 if (shift->Rank() > 0) {
639 int k{0};
640 for (int j{0}; j < rank; ++j) {
641 if (j != zbDim) {
642 if (array->shape()[j] != shift->shape()[k]) {
643 context_.messages().Say(
644 "Invalid 'shift=' argument in CSHIFT: extent on dimension %d is %jd but must be %jd"_err_en_US,
645 k + 1, static_cast<std::intmax_t>(shift->shape()[k]),
646 static_cast<std::intmax_t>(array->shape()[j]));
647 ok = false;
648 }
649 ++k;
650 }
651 }
652 }
653 if (ok) {
654 std::vector<Scalar<T>> resultElements;
655 ConstantSubscripts arrayLB{array->lbounds()};
656 ConstantSubscripts arrayAt{arrayLB};
657 ConstantSubscript &dimIndex{arrayAt[zbDim]};
658 ConstantSubscript dimLB{dimIndex}; // initial value
659 ConstantSubscript dimExtent{array->shape()[zbDim]};
660 ConstantSubscripts shiftLB{shift->lbounds()};
661 for (auto n{GetSize(array->shape())}; n > 0; --n) {
662 ConstantSubscript origDimIndex{dimIndex};
663 ConstantSubscripts shiftAt;
664 if (shift->Rank() > 0) {
665 int k{0};
666 for (int j{0}; j < rank; ++j) {
667 if (j != zbDim) {
668 shiftAt.emplace_back(shiftLB[k++] + arrayAt[j] - arrayLB[j]);
669 }
670 }
671 }
672 ConstantSubscript shiftCount{shift->At(shiftAt).ToInt64()};
673 dimIndex = dimLB + ((dimIndex - dimLB + shiftCount) % dimExtent);
674 if (dimIndex < dimLB) {
675 dimIndex += dimExtent;
676 } else if (dimIndex >= dimLB + dimExtent) {
677 dimIndex -= dimExtent;
678 }
679 resultElements.push_back(array->At(arrayAt));
680 dimIndex = origDimIndex;
681 array->IncrementSubscripts(arrayAt);
682 }
683 return Expr<T>{PackageConstant<T>(
684 std::move(resultElements), *array, array->shape())};
685 }
686 }
687 // Invalid, prevent re-folding
688 return MakeInvalidIntrinsic(std::move(funcRef));
689}
690
691template <typename T> Expr<T> Folder<T>::EOSHIFT(FunctionRef<T> &&funcRef) {
692 auto args{funcRef.arguments()};
693 CHECK(args.size() == 4);
694 const auto *array{UnwrapConstantValue<T>(args[0])};
695 const auto *shiftExpr{UnwrapExpr<Expr<SomeInteger>>(args[1])};
696 auto dim{GetInt64ArgOr(args[3], 1)};
697 if (!array || !shiftExpr || !dim) {
698 return Expr<T>{std::move(funcRef)};
699 }
700 // Apply type conversions to the shift= and boundary= arguments.
701 auto convertedShift{Fold(context_,
702 ConvertToType<SubscriptInteger>(Expr<SomeInteger>{*shiftExpr}))};
703 const auto *shift{UnwrapConstantValue<SubscriptInteger>(convertedShift)};
704 if (!shift) {
705 return Expr<T>{std::move(funcRef)};
706 }
707 const Constant<T> *boundary{nullptr};
708 std::optional<Expr<SomeType>> convertedBoundary;
709 if (const auto *boundaryExpr{UnwrapExpr<Expr<SomeType>>(args[2])}) {
710 convertedBoundary = Fold(context_,
711 ConvertToType(array->GetType(), Expr<SomeType>{*boundaryExpr}));
712 boundary = UnwrapExpr<Constant<T>>(convertedBoundary);
713 if (!boundary) {
714 return Expr<T>{std::move(funcRef)};
715 }
716 }
717 // Arguments are constant
718 if (*dim < 1 || *dim > array->Rank()) {
719 context_.messages().Say(
720 "Invalid 'dim=' argument (%jd) in EOSHIFT"_err_en_US,
721 static_cast<std::intmax_t>(*dim));
722 } else if (shift->Rank() > 0 && shift->Rank() != array->Rank() - 1) {
723 // message already emitted from intrinsic look-up
724 } else if (boundary && boundary->Rank() > 0 &&
725 boundary->Rank() != array->Rank() - 1) {
726 // ditto
727 } else {
728 int rank{array->Rank()};
729 int zbDim{static_cast<int>(*dim) - 1};
730 bool ok{true};
731 if (shift->Rank() > 0) {
732 int k{0};
733 for (int j{0}; j < rank; ++j) {
734 if (j != zbDim) {
735 if (array->shape()[j] != shift->shape()[k]) {
736 context_.messages().Say(
737 "Invalid 'shift=' argument in EOSHIFT: extent on dimension %d is %jd but must be %jd"_err_en_US,
738 k + 1, static_cast<std::intmax_t>(shift->shape()[k]),
739 static_cast<std::intmax_t>(array->shape()[j]));
740 ok = false;
741 }
742 ++k;
743 }
744 }
745 }
746 if (boundary && boundary->Rank() > 0) {
747 int k{0};
748 for (int j{0}; j < rank; ++j) {
749 if (j != zbDim) {
750 if (array->shape()[j] != boundary->shape()[k]) {
751 context_.messages().Say(
752 "Invalid 'boundary=' argument in EOSHIFT: extent on dimension %d is %jd but must be %jd"_err_en_US,
753 k + 1, static_cast<std::intmax_t>(boundary->shape()[k]),
754 static_cast<std::intmax_t>(array->shape()[j]));
755 ok = false;
756 }
757 ++k;
758 }
759 }
760 }
761 if (ok) {
762 std::vector<Scalar<T>> resultElements;
763 ConstantSubscripts arrayLB{array->lbounds()};
764 ConstantSubscripts arrayAt{arrayLB};
765 ConstantSubscript &dimIndex{arrayAt[zbDim]};
766 ConstantSubscript dimLB{dimIndex}; // initial value
767 ConstantSubscript dimExtent{array->shape()[zbDim]};
768 ConstantSubscripts shiftLB{shift->lbounds()};
769 ConstantSubscripts boundaryLB;
770 if (boundary) {
771 boundaryLB = boundary->lbounds();
772 }
773 for (auto n{GetSize(array->shape())}; n > 0; --n) {
774 ConstantSubscript origDimIndex{dimIndex};
775 ConstantSubscripts shiftAt;
776 if (shift->Rank() > 0) {
777 int k{0};
778 for (int j{0}; j < rank; ++j) {
779 if (j != zbDim) {
780 shiftAt.emplace_back(shiftLB[k++] + arrayAt[j] - arrayLB[j]);
781 }
782 }
783 }
784 ConstantSubscript shiftCount{shift->At(shiftAt).ToInt64()};
785 dimIndex += shiftCount;
786 if (dimIndex >= dimLB && dimIndex < dimLB + dimExtent) {
787 resultElements.push_back(array->At(arrayAt));
788 } else if (boundary) {
789 ConstantSubscripts boundaryAt;
790 if (boundary->Rank() > 0) {
791 for (int j{0}; j < rank; ++j) {
792 int k{0};
793 if (j != zbDim) {
794 boundaryAt.emplace_back(
795 boundaryLB[k++] + arrayAt[j] - arrayLB[j]);
796 }
797 }
798 }
799 resultElements.push_back(boundary->At(boundaryAt));
800 } else if constexpr (T::category == TypeCategory::Integer ||
801 T::category == TypeCategory::Unsigned ||
802 T::category == TypeCategory::Real ||
803 T::category == TypeCategory::Complex ||
804 T::category == TypeCategory::Logical) {
805 resultElements.emplace_back();
806 } else if constexpr (T::category == TypeCategory::Character) {
807 auto len{static_cast<std::size_t>(array->LEN())};
808 typename Scalar<T>::value_type space{' '};
809 resultElements.emplace_back(len, space);
810 } else {
811 DIE("no derived type boundary");
812 }
813 dimIndex = origDimIndex;
814 array->IncrementSubscripts(arrayAt);
815 }
816 return Expr<T>{PackageConstant<T>(
817 std::move(resultElements), *array, array->shape())};
818 }
819 }
820 // Invalid, prevent re-folding
821 return MakeInvalidIntrinsic(std::move(funcRef));
822}
823
824template <typename T> Expr<T> Folder<T>::MERGE(FunctionRef<T> &&funcRef) {
825 return FoldElementalIntrinsic<T, T, T, LogicalResult>(context_,
826 std::move(funcRef),
827 ScalarFunc<T, T, T, LogicalResult>(
828 [](const Scalar<T> &ifTrue, const Scalar<T> &ifFalse,
829 const Scalar<LogicalResult> &predicate) -> Scalar<T> {
830 return predicate.IsTrue() ? ifTrue : ifFalse;
831 }));
832}
833
834template <typename T> Expr<T> Folder<T>::PACK(FunctionRef<T> &&funcRef) {
835 auto args{funcRef.arguments()};
836 CHECK(args.size() == 3);
837 const auto *array{UnwrapConstantValue<T>(args[0])};
838 const auto *vector{UnwrapConstantValue<T>(args[2])};
839 auto convertedMask{Fold(context_,
840 ConvertToType<LogicalResult>(
841 Expr<SomeLogical>{DEREF(UnwrapExpr<Expr<SomeLogical>>(args[1]))}))};
842 const auto *mask{UnwrapConstantValue<LogicalResult>(convertedMask)};
843 if (!array || !mask || (args[2] && !vector)) {
844 return Expr<T>{std::move(funcRef)};
845 }
846 // Arguments are constant.
847 ConstantSubscript arrayElements{GetSize(array->shape())};
848 ConstantSubscript truths{0};
849 ConstantSubscripts maskAt{mask->lbounds()};
850 if (mask->Rank() == 0) {
851 if (mask->At(maskAt).IsTrue()) {
852 truths = arrayElements;
853 }
854 } else if (array->shape() != mask->shape()) {
855 // Error already emitted from intrinsic processing
856 return MakeInvalidIntrinsic(std::move(funcRef));
857 } else {
858 for (ConstantSubscript j{0}; j < arrayElements;
859 ++j, mask->IncrementSubscripts(maskAt)) {
860 if (mask->At(maskAt).IsTrue()) {
861 ++truths;
862 }
863 }
864 }
865 std::vector<Scalar<T>> resultElements;
866 ConstantSubscripts arrayAt{array->lbounds()};
867 ConstantSubscript resultSize{truths};
868 if (vector) {
869 resultSize = vector->shape().at(0);
870 if (resultSize < truths) {
871 context_.messages().Say(
872 "Invalid 'vector=' argument in PACK: the 'mask=' argument has %jd true elements, but the vector has only %jd elements"_err_en_US,
873 static_cast<std::intmax_t>(truths),
874 static_cast<std::intmax_t>(resultSize));
875 return MakeInvalidIntrinsic(std::move(funcRef));
876 }
877 }
878 for (ConstantSubscript j{0}; j < truths;) {
879 if (mask->At(maskAt).IsTrue()) {
880 resultElements.push_back(array->At(arrayAt));
881 ++j;
882 }
883 array->IncrementSubscripts(arrayAt);
884 mask->IncrementSubscripts(maskAt);
885 }
886 if (vector) {
887 ConstantSubscripts vectorAt{vector->lbounds()};
888 vectorAt.at(0) += truths;
889 for (ConstantSubscript j{truths}; j < resultSize; ++j) {
890 resultElements.push_back(vector->At(vectorAt));
891 ++vectorAt[0];
892 }
893 }
894 return Expr<T>{PackageConstant<T>(std::move(resultElements), *array,
895 ConstantSubscripts{static_cast<ConstantSubscript>(resultSize)})};
896}
897
898template <typename T> Expr<T> Folder<T>::RESHAPE(FunctionRef<T> &&funcRef) {
899 auto args{funcRef.arguments()};
900 CHECK(args.size() == 4);
901 const auto *source{UnwrapConstantValue<T>(args[0])};
902 const auto *pad{UnwrapConstantValue<T>(args[2])};
903 std::optional<std::vector<ConstantSubscript>> shape{
904 GetIntegerVector<ConstantSubscript>(args[1])};
905 std::optional<std::vector<int>> order{GetIntegerVector<int>(args[3])};
906 std::optional<uint64_t> optResultElement;
907 std::optional<std::vector<int>> dimOrder;
908 bool ok{true};
909 if (shape) {
910 if (shape->size() > common::maxRank) {
911 context_.messages().Say(
912 "Size of 'shape=' argument (%zd) must not be greater than %d"_err_en_US,
913 shape->size(), common::maxRank);
914 ok = false;
915 } else if (HasNegativeExtent(*shape)) {
916 context_.messages().Say(
917 "'shape=' argument (%s) must not have a negative extent"_err_en_US,
918 DEREF(args[1]->UnwrapExpr()).AsFortran());
919 ok = false;
920 } else {
921 optResultElement = TotalElementCount(*shape);
922 if (!optResultElement) {
923 context_.messages().Say(
924 "'shape=' argument (%s) specifies an array with too many elements"_err_en_US,
925 DEREF(args[1]->UnwrapExpr()).AsFortran());
926 ok = false;
927 }
928 }
929 if (order) {
930 dimOrder = ValidateDimensionOrder(GetRank(*shape), *order);
931 if (!dimOrder) {
932 context_.messages().Say(
933 "Invalid 'order=' argument (%s) in RESHAPE"_err_en_US,
934 DEREF(args[3]->UnwrapExpr()).AsFortran());
935 ok = false;
936 }
937 }
938 }
939 if (!ok) {
940 // convert into an invalid intrinsic procedure call below
941 } else if (!source || !shape || (args[2] && !pad) || (args[3] && !order)) {
942 return Expr<T>{std::move(funcRef)}; // Non-constant arguments
943 } else {
944 uint64_t resultElements{*optResultElement};
945 std::vector<int> *dimOrderPtr{dimOrder ? &dimOrder.value() : nullptr};
946 if (resultElements > source->size() && (!pad || pad->empty())) {
947 context_.messages().Say(
948 "Too few elements in 'source=' argument and 'pad=' "
949 "argument is not present or has null size"_err_en_US);
950 ok = false;
951 } else {
952 Constant<T> result{!source->empty() || !pad
953 ? source->Reshape(std::move(shape.value()))
954 : pad->Reshape(std::move(shape.value()))};
955 ConstantSubscripts subscripts{result.lbounds()};
956 auto copied{result.CopyFrom(*source,
957 std::min(static_cast<uint64_t>(source->size()), resultElements),
958 subscripts, dimOrderPtr)};
959 if (copied < resultElements) {
960 CHECK(pad);
961 copied += result.CopyFrom(
962 *pad, resultElements - copied, subscripts, dimOrderPtr);
963 }
964 CHECK(copied == resultElements);
965 return Expr<T>{std::move(result)};
966 }
967 }
968 // Invalid, prevent re-folding
969 return MakeInvalidIntrinsic(std::move(funcRef));
970}
971
972template <typename T> Expr<T> Folder<T>::SPREAD(FunctionRef<T> &&funcRef) {
973 auto args{funcRef.arguments()};
974 CHECK(args.size() == 3);
975 const Constant<T> *source{UnwrapConstantValue<T>(args[0])};
976 auto dim{ToInt64(args[1])};
977 auto ncopies{ToInt64(args[2])};
978 if (!source || !dim) {
979 return Expr<T>{std::move(funcRef)};
980 }
981 int sourceRank{source->Rank()};
982 if (sourceRank >= common::maxRank) {
983 context_.messages().Say(
984 "SOURCE= argument to SPREAD has rank %d but must have rank less than %d"_err_en_US,
985 sourceRank, common::maxRank);
986 } else if (*dim < 1 || *dim > sourceRank + 1) {
987 context_.messages().Say(
988 "DIM=%d argument to SPREAD must be between 1 and %d"_err_en_US, *dim,
989 sourceRank + 1);
990 } else if (!ncopies) {
991 return Expr<T>{std::move(funcRef)};
992 } else {
993 if (*ncopies < 0) {
994 ncopies = 0;
995 }
996 // TODO: Consider moving this implementation (after the user error
997 // checks), along with other transformational intrinsics, into
998 // constant.h (or a new header) so that the transformationals
999 // are available for all Constant<>s without needing to be packaged
1000 // as references to intrinsic functions for folding.
1001 ConstantSubscripts shape{source->shape()};
1002 shape.insert(shape.begin() + *dim - 1, *ncopies);
1003 Constant<T> spread{source->Reshape(std::move(shape))};
1004 std::optional<uint64_t> n{TotalElementCount(spread.shape())};
1005 if (!n) {
1006 context_.messages().Say("Too many elements in SPREAD result"_err_en_US);
1007 } else {
1008 std::vector<int> dimOrder;
1009 for (int j{0}; j < sourceRank; ++j) {
1010 dimOrder.push_back(j < *dim - 1 ? j : j + 1);
1011 }
1012 dimOrder.push_back(*dim - 1);
1013 ConstantSubscripts at{spread.lbounds()}; // all 1
1014 spread.CopyFrom(*source, *n, at, &dimOrder);
1015 return Expr<T>{std::move(spread)};
1016 }
1017 }
1018 // Invalid, prevent re-folding
1019 return MakeInvalidIntrinsic(std::move(funcRef));
1020}
1021
1022template <typename T> Expr<T> Folder<T>::TRANSPOSE(FunctionRef<T> &&funcRef) {
1023 auto args{funcRef.arguments()};
1024 CHECK(args.size() == 1);
1025 const auto *matrix{UnwrapConstantValue<T>(args[0])};
1026 if (!matrix) {
1027 return Expr<T>{std::move(funcRef)};
1028 }
1029 // Argument is constant. Traverse its elements in transposed order.
1030 std::vector<Scalar<T>> resultElements;
1031 ConstantSubscripts at(2);
1032 for (ConstantSubscript j{0}; j < matrix->shape()[0]; ++j) {
1033 at[0] = matrix->lbounds()[0] + j;
1034 for (ConstantSubscript k{0}; k < matrix->shape()[1]; ++k) {
1035 at[1] = matrix->lbounds()[1] + k;
1036 resultElements.push_back(matrix->At(at));
1037 }
1038 }
1039 at = matrix->shape();
1040 std::swap(at[0], at[1]);
1041 return Expr<T>{PackageConstant<T>(std::move(resultElements), *matrix, at)};
1042}
1043
1044template <typename T> Expr<T> Folder<T>::UNPACK(FunctionRef<T> &&funcRef) {
1045 auto args{funcRef.arguments()};
1046 CHECK(args.size() == 3);
1047 const auto *vector{UnwrapConstantValue<T>(args[0])};
1048 auto convertedMask{Fold(context_,
1049 ConvertToType<LogicalResult>(
1050 Expr<SomeLogical>{DEREF(UnwrapExpr<Expr<SomeLogical>>(args[1]))}))};
1051 const auto *mask{UnwrapConstantValue<LogicalResult>(convertedMask)};
1052 const auto *field{UnwrapConstantValue<T>(args[2])};
1053 if (!vector || !mask || !field) {
1054 return Expr<T>{std::move(funcRef)};
1055 }
1056 // Arguments are constant.
1057 if (field->Rank() > 0 && field->shape() != mask->shape()) {
1058 // Error already emitted from intrinsic processing
1059 return MakeInvalidIntrinsic(std::move(funcRef));
1060 }
1061 ConstantSubscript maskElements{GetSize(mask->shape())};
1062 ConstantSubscript truths{0};
1063 ConstantSubscripts maskAt{mask->lbounds()};
1064 for (ConstantSubscript j{0}; j < maskElements;
1065 ++j, mask->IncrementSubscripts(maskAt)) {
1066 if (mask->At(maskAt).IsTrue()) {
1067 ++truths;
1068 }
1069 }
1070 if (truths > GetSize(vector->shape())) {
1071 context_.messages().Say(
1072 "Invalid 'vector=' argument in UNPACK: the 'mask=' argument has %jd true elements, but the vector has only %jd elements"_err_en_US,
1073 static_cast<std::intmax_t>(truths),
1074 static_cast<std::intmax_t>(GetSize(vector->shape())));
1075 return MakeInvalidIntrinsic(std::move(funcRef));
1076 }
1077 std::vector<Scalar<T>> resultElements;
1078 ConstantSubscripts vectorAt{vector->lbounds()};
1079 ConstantSubscripts fieldAt{field->lbounds()};
1080 for (ConstantSubscript j{0}; j < maskElements; ++j) {
1081 if (mask->At(maskAt).IsTrue()) {
1082 resultElements.push_back(vector->At(vectorAt));
1083 vector->IncrementSubscripts(vectorAt);
1084 } else {
1085 resultElements.push_back(field->At(fieldAt));
1086 }
1087 mask->IncrementSubscripts(maskAt);
1088 field->IncrementSubscripts(fieldAt);
1089 }
1090 return Expr<T>{
1091 PackageConstant<T>(std::move(resultElements), *vector, mask->shape())};
1092}
1093
1094std::optional<Expr<SomeType>> FoldTransfer(
1095 FoldingContext &, const ActualArguments &);
1096
1097template <typename T> Expr<T> Folder<T>::TRANSFER(FunctionRef<T> &&funcRef) {
1098 if (auto folded{FoldTransfer(context_, funcRef.arguments())}) {
1099 return DEREF(UnwrapExpr<Expr<T>>(*folded));
1100 } else {
1101 return Expr<T>{std::move(funcRef)};
1102 }
1103}
1104
1105// TODO: Once the backend supports character extremums we could support
1106// min/max with non-optional arguments to trees of extremum operations.
1107template <typename T>
1108Expr<T> FoldMINorMAX(
1109 FoldingContext &context, FunctionRef<T> &&funcRef, Ordering order) {
1110 static_assert(T::category == TypeCategory::Integer ||
1111 T::category == TypeCategory::Unsigned ||
1112 T::category == TypeCategory::Real ||
1113 T::category == TypeCategory::Character);
1114
1115 // Lots of constraints:
1116 // - We want Extremum<T> generated by semantics to compare equal to
1117 // Extremum<T> written out to module files as max or min calls.
1118 // - Users can also write min/max calls that must also compare equal
1119 // to min/max calls that wind up being written to module files.
1120 // - Extremeum<T> is binary and can't currently handle processing
1121 // optional arguments that may show up in 3rd + argument.
1122 // - The code below only accepts more than 2 arguments if all the
1123 // arguments are constant (and hence known to be present).
1124 // - ConvertExprToHLFIR can't currently handle Extremum<Character>
1125 // - Semantics doesn't currently generate Extremum<Character>
1126 // The original code did the folding of arguments and the overall extremum
1127 // operation in a single pass. This was shorter code-wise, but took me
1128 // a while to tease out all the logic and was doing redundant work.
1129 // So I split it into two passes:
1130 // 1) fold the arguments and check if they are constant,
1131 // 2) Decide if we:
1132 // - can constant-fold the min/max operation, or
1133 // - need to generate an extremum anyway,
1134 // and do it if so.
1135 // Otherwise, return the original call.
1136 auto &args{funcRef.arguments()};
1137 std::size_t nargs{args.size()};
1138 bool allArgsConstant{true};
1139 bool extremumAnyway{nargs == 2 && T::category != TypeCategory::Character};
1140 // 1a)Fold the first two arguments.
1141 {
1142 Folder<T> folder{context, /*forOptionalArgument=*/false};
1143 if (!folder.Folding(args[0])) {
1144 allArgsConstant = false;
1145 }
1146 if (!folder.Folding(args[1])) {
1147 allArgsConstant = false;
1148 }
1149 }
1150 // 1b) Fold any optional arguments.
1151 if (nargs > 2) {
1152 Folder<T> folder{context, /*forOptionalArgument=*/true};
1153 for (std::size_t i{2}; i < nargs; ++i) {
1154 if (args[i]) {
1155 if (!folder.Folding(args[i])) {
1156 allArgsConstant = false;
1157 }
1158 }
1159 }
1160 }
1161 // 2) If we can fold the result or the call to min/max may compare equal to
1162 // an extremum generated by semantics go ahead and convert to an extremum,
1163 // and try to fold the result.
1164 if (allArgsConstant || extremumAnyway) {
1165 // Folding updates the argument expressions in place, no need to call
1166 // Fold() on each argument again.
1167 if (const auto *resultp{UnwrapExpr<Expr<T>>(args[0])}) {
1168 Expr<T> result{*resultp};
1169 for (std::size_t i{1}; i < nargs; ++i) {
1170 if (const auto *tExpr{UnwrapExpr<Expr<T>>(args[i])}) {
1171 result = FoldOperation(
1172 context, Extremum<T>{order, std::move(result), *tExpr});
1173 } else {
1174 // This should never happen, but here is a value to return.
1175 return Expr<T>{std::move(funcRef)};
1176 }
1177 }
1178 return result;
1179 }
1180 }
1181 // If we decided to not generate an extremum just return the original call,
1182 // with the arguments folded.
1183 return Expr<T>{std::move(funcRef)};
1184}
1185
1186// For AMAX0, AMIN0, AMAX1, AMIN1, DMAX1, DMIN1, MAX0, MIN0, MAX1, and MIN1
1187// a special care has to be taken to insert the conversion on the result
1188// of the MIN/MAX. This is made slightly more complex by the extension
1189// supported by f18 that arguments may have different kinds. This implies
1190// that the created MIN/MAX result type cannot be deduced from the standard but
1191// has to be deduced from the arguments.
1192// e.g. AMAX0(int8, int4) is rewritten to REAL(MAX(int8, INT(int4, 8)))).
1193template <typename T>
1194Expr<T> RewriteSpecificMINorMAX(
1195 FoldingContext &context, FunctionRef<T> &&funcRef) {
1196 ActualArguments &args{funcRef.arguments()};
1197 auto &intrinsic{DEREF(std::get_if<SpecificIntrinsic>(&funcRef.proc().u))};
1198 // Rewrite MAX1(args) to INT(MAX(args)) and fold. Same logic for MIN1.
1199 // Find result type for max/min based on the arguments.
1200 std::optional<DynamicType> resultType;
1201 ActualArgument *resultTypeArg{nullptr};
1202 for (auto j{args.size()}; j-- > 0;) {
1203 if (args[j]) {
1204 DynamicType type{args[j]->GetType().value()};
1205 // Handle mixed real/integer arguments: all the previous arguments were
1206 // integers and this one is real. The type of the MAX/MIN result will
1207 // be the one of the real argument.
1208 if (!resultType ||
1209 (type.category() == resultType->category() &&
1210 type.kind() > resultType->kind()) ||
1211 resultType->category() == TypeCategory::Integer) {
1212 resultType = type;
1213 resultTypeArg = &*args[j];
1214 }
1215 }
1216 }
1217 if (!resultType) { // error recovery
1218 return Expr<T>{std::move(funcRef)};
1219 }
1220 intrinsic.name =
1221 intrinsic.name.find("max") != std::string::npos ? "max"s : "min"s;
1222 intrinsic.characteristics.value().functionResult.value().SetType(*resultType);
1223 auto insertConversion{[&](const auto &x) -> Expr<T> {
1224 using TR = ResultType<decltype(x)>;
1225 FunctionRef<TR> maxRef{
1226 ProcedureDesignator{funcRef.proc()}, ActualArguments{args}};
1227 return Fold(context, ConvertToType<T>(AsCategoryExpr(std::move(maxRef))));
1228 }};
1229 if (auto *sx{UnwrapExpr<Expr<SomeReal>>(*resultTypeArg)}) {
1230 return common::visit(insertConversion, sx->u);
1231 } else if (auto *sx{UnwrapExpr<Expr<SomeInteger>>(*resultTypeArg)}) {
1232 return common::visit(insertConversion, sx->u);
1233 } else {
1234 return Expr<T>{std::move(funcRef)}; // error recovery
1235 }
1236}
1237
1238// FoldIntrinsicFunction()
1239template <int KIND>
1240Expr<Type<TypeCategory::Integer, KIND>> FoldIntrinsicFunction(
1242template <int KIND>
1243Expr<Type<TypeCategory::Unsigned, KIND>> FoldIntrinsicFunction(
1244 FoldingContext &context,
1246template <int KIND>
1247Expr<Type<TypeCategory::Real, KIND>> FoldIntrinsicFunction(
1249template <int KIND>
1250Expr<Type<TypeCategory::Complex, KIND>> FoldIntrinsicFunction(
1252template <int KIND>
1253Expr<Type<TypeCategory::Logical, KIND>> FoldIntrinsicFunction(
1255
1256template <typename T>
1257Expr<T> FoldOperation(FoldingContext &context, FunctionRef<T> &&funcRef) {
1258 ActualArguments &args{funcRef.arguments()};
1259 const auto *intrinsic{std::get_if<SpecificIntrinsic>(&funcRef.proc().u)};
1260 if (!intrinsic || intrinsic->name != "kind") {
1261 // Don't fold the argument to KIND(); it might be a TypeParamInquiry
1262 // with a forced result type that doesn't match the parameter.
1263 for (std::optional<ActualArgument> &arg : args) {
1264 if (arg && arg->GetConditionalArg()) {
1265 FoldConditionalArg(context, arg);
1266 } else if (auto *expr{UnwrapExpr<Expr<SomeType>>(arg)}) {
1267 *expr = Fold(context, std::move(*expr));
1268 }
1269 }
1270 }
1271 if (intrinsic) {
1272 // Skip intrinsic folding if any argument is still a conditional arg
1273 // (i.e. its condition was not a compile-time constant). When the
1274 // condition is a compile-time constant, FoldConditionalArg already resolved
1275 // it to a plain Expr above, and intrinsic folding proceeds normally.
1276 //
1277 // TODO:
1278 // For elemental/pure intrinsics, distribute the call over each
1279 // consequent of the conditional arg and fold each branch independently:
1280 // abs((c1 ? a : c2 ? b : c))
1281 // → (c1 ? abs(a) : c2 ? abs(b) : abs(c))
1282 // Use ForEachConsequent to walk the chain, clone the call per
1283 // consequent, fold each clone, and reassemble into a new ConditionalArg.
1284 // When multiple arguments are conditional args, distribute one at a
1285 // time to avoid a combinatorial cross-product expansion.
1286 // This is NOT valid for non-elemental intrinsics like RESHAPE or
1287 // TRANSFER whose results depend on seeing all arguments together.
1288 //
1289 // TODO (conformance):
1290 // Type-inquiry intrinsics whose result depends only on the argument's
1291 // declared type/rank (e.g. KIND, BIT_SIZE, DIGITS, HUGE, TINY, EPSILON,
1292 // PRECISION, RANGE, RADIX, MAXEXPONENT, MINEXPONENT, STORAGE_SIZE, RANK)
1293 // are foldable even when the condition is not constant, because C1538/C1539
1294 // guarantee every consequent has the same type and rank. Because they are
1295 // not folded here, a reference such as
1296 // integer, parameter :: k = kind((flag ? a : b))
1297 // is wrongly rejected ("cannot be computed as a constant value") even
1298 // though it is a valid F2023 constant expression.
1299 // Fix:
1300 // For such a curated allow-list of type-only inquiries, before the bailout
1301 // below, a curated allow-list of type-only inquiries, before the bailout
1302 // below, replace the conditional-arg argument with its first non-.NIL.
1303 // consequent (a representative) and fold normally. This must NOT be
1304 // applied to shape/value inquiries (SIZE, SHAPE, LBOUND/UBOUND, LEN of
1305 // deferred length, ALLOCATED, ASSOCIATED, PRESENT, IS_CONTIGUOUS), whose
1306 // results can differ between consequents.
1307 for (const std::optional<ActualArgument> &arg : args) {
1308 if (arg && arg->isConditionalArg()) {
1309 return Expr<T>{std::move(funcRef)};
1310 }
1311 }
1312 const std::string name{intrinsic->name};
1313 if (name == "cshift") {
1314 return Folder<T>{context}.CSHIFT(std::move(funcRef));
1315 } else if (name == "eoshift") {
1316 return Folder<T>{context}.EOSHIFT(std::move(funcRef));
1317 } else if (name == "merge") {
1318 return Folder<T>{context}.MERGE(std::move(funcRef));
1319 } else if (name == "pack") {
1320 return Folder<T>{context}.PACK(std::move(funcRef));
1321 } else if (name == "reshape") {
1322 return Folder<T>{context}.RESHAPE(std::move(funcRef));
1323 } else if (name == "spread") {
1324 return Folder<T>{context}.SPREAD(std::move(funcRef));
1325 } else if (name == "transfer") {
1326 return Folder<T>{context}.TRANSFER(std::move(funcRef));
1327 } else if (name == "transpose") {
1328 return Folder<T>{context}.TRANSPOSE(std::move(funcRef));
1329 } else if (name == "unpack") {
1330 return Folder<T>{context}.UNPACK(std::move(funcRef));
1331 }
1332 // TODO: extends_type_of, same_type_as
1333 if constexpr (!std::is_same_v<T, SomeDerived>) {
1334 return FoldIntrinsicFunction(context, std::move(funcRef));
1335 }
1336 }
1337 return Expr<T>{std::move(funcRef)};
1338}
1339
1340// Array constructor folding
1341template <typename T> class ArrayConstructorFolder {
1342public:
1343 explicit ArrayConstructorFolder(FoldingContext &c) : context_{c} {}
1344
1345 Expr<T> FoldArray(ArrayConstructor<T> &&array) {
1346 if constexpr (T::category == TypeCategory::Character) {
1347 if (const auto *len{array.LEN()}) {
1348 charLength_ = ToInt64(Fold(context_, common::Clone(*len)));
1349 knownCharLength_ = charLength_.has_value();
1350 }
1351 }
1352 // Calls FoldArray(const ArrayConstructorValues<T> &) below
1353 if (FoldArray(array)) {
1354 auto n{static_cast<ConstantSubscript>(elements_.size())};
1355 if constexpr (std::is_same_v<T, SomeDerived>) {
1356 return Expr<T>{Constant<T>{array.GetType().GetDerivedTypeSpec(),
1357 std::move(elements_), ConstantSubscripts{n}}};
1358 } else if constexpr (T::category == TypeCategory::Character) {
1359 if (charLength_) {
1360 return Expr<T>{Constant<T>{
1361 *charLength_, std::move(elements_), ConstantSubscripts{n}}};
1362 }
1363 } else {
1364 return Expr<T>{Constant<T>{
1365 std::move(elements_), ConstantSubscripts{n}, resultInfo_}};
1366 }
1367 }
1368 return Expr<T>{std::move(array)};
1369 }
1370
1371private:
1372 bool FoldArray(const Expr<T> &expr) {
1373 Expr<T> folded{Fold(context_, common::Clone(expr))};
1374 if (const auto *c{UnwrapConstantValue<T>(folded)}) {
1375 // Copy elements in Fortran array element order
1376 if (!c->empty()) {
1377 ConstantSubscripts index{c->lbounds()};
1378 do {
1379 elements_.emplace_back(c->At(index));
1380 } while (c->IncrementSubscripts(index));
1381 }
1382 if constexpr (T::category == TypeCategory::Character) {
1383 if (!knownCharLength_) {
1384 charLength_ = std::max(c->LEN(), charLength_.value_or(-1));
1385 }
1386 } else if constexpr (T::category == TypeCategory::Real ||
1387 T::category == TypeCategory::Complex) {
1388 if (c->result().isFromInexactLiteralConversion()) {
1389 resultInfo_.set_isFromInexactLiteralConversion();
1390 }
1391 }
1392 return true;
1393 } else {
1394 return false;
1395 }
1396 }
1397 bool FoldArray(const common::CopyableIndirection<Expr<T>> &expr) {
1398 return FoldArray(expr.value());
1399 }
1400 bool FoldArray(const ImpliedDo<T> &iDo) {
1402 Fold(context_, Expr<SubscriptInteger>{iDo.lower()})};
1404 Fold(context_, Expr<SubscriptInteger>{iDo.upper()})};
1406 Fold(context_, Expr<SubscriptInteger>{iDo.stride()})};
1407 std::optional<ConstantSubscript> start{ToInt64(lower)}, end{ToInt64(upper)},
1408 step{ToInt64(stride)};
1409 if (start && end && step && *step != 0) {
1410 bool result{true};
1411 ConstantSubscript &j{context_.StartImpliedDo(iDo.name(), *start)};
1412 if (*step > 0) {
1413 for (; j <= *end; j += *step) {
1414 result &= FoldArray(iDo.values());
1415 }
1416 } else {
1417 for (; j >= *end; j += *step) {
1418 result &= FoldArray(iDo.values());
1419 }
1420 }
1421 context_.EndImpliedDo(iDo.name());
1422 return result;
1423 } else {
1424 return false;
1425 }
1426 }
1427 bool FoldArray(const ArrayConstructorValue<T> &x) {
1428 return common::visit([&](const auto &y) { return FoldArray(y); }, x.u);
1429 }
1430 bool FoldArray(const ArrayConstructorValues<T> &xs) {
1431 for (const auto &x : xs) {
1432 if (!FoldArray(x)) {
1433 return false;
1434 }
1435 }
1436 return true;
1437 }
1438
1439 FoldingContext &context_;
1440 std::vector<Scalar<T>> elements_;
1441 std::optional<ConstantSubscript> charLength_;
1442 bool knownCharLength_{false};
1443 typename Constant<T>::Result resultInfo_;
1444};
1445
1446template <typename T>
1447Expr<T> FoldOperation(FoldingContext &context, ArrayConstructor<T> &&array) {
1448 return ArrayConstructorFolder<T>{context}.FoldArray(std::move(array));
1449}
1450
1451// Array operation elemental application: When all operands to an operation
1452// are constant arrays, array constructors without any implied DO loops,
1453// &/or expanded scalars, pull the operation "into" the array result by
1454// applying it in an elementwise fashion. For example, [A,1]+[B,2]
1455// is rewritten into [A+B,1+2] and then partially folded to [A+B,3].
1456
1457// If possible, restructures an array expression into an array constructor
1458// that comprises a "flat" ArrayConstructorValues with no implied DO loops.
1459template <typename T>
1460bool ArrayConstructorIsFlat(const ArrayConstructorValues<T> &values) {
1461 for (const ArrayConstructorValue<T> &x : values) {
1462 if (!std::holds_alternative<Expr<T>>(x.u)) {
1463 return false;
1464 }
1465 }
1466 return true;
1467}
1468
1469template <typename T>
1470std::optional<Expr<T>> AsFlatArrayConstructor(const Expr<T> &expr) {
1471 if (const auto *c{UnwrapConstantValue<T>(expr)}) {
1472 ArrayConstructor<T> result{expr};
1473 if (!c->empty()) {
1474 ConstantSubscripts at{c->lbounds()};
1475 do {
1476 result.Push(Expr<T>{Constant<T>{c->At(at)}});
1477 } while (c->IncrementSubscripts(at));
1478 }
1479 return std::make_optional<Expr<T>>(std::move(result));
1480 } else if (const auto *a{UnwrapExpr<ArrayConstructor<T>>(expr)}) {
1481 if (ArrayConstructorIsFlat(*a)) {
1482 return std::make_optional<Expr<T>>(expr);
1483 }
1484 } else if (const auto *p{UnwrapExpr<Parentheses<T>>(expr)}) {
1485 return AsFlatArrayConstructor(Expr<T>{p->left()});
1486 }
1487 return std::nullopt;
1488}
1489
1490template <TypeCategory CAT>
1491std::enable_if_t<CAT != TypeCategory::Derived,
1492 std::optional<Expr<SomeKind<CAT>>>>
1493AsFlatArrayConstructor(const Expr<SomeKind<CAT>> &expr) {
1494 return common::visit(
1495 [&](const auto &kindExpr) -> std::optional<Expr<SomeKind<CAT>>> {
1496 if (auto flattened{AsFlatArrayConstructor(kindExpr)}) {
1497 return Expr<SomeKind<CAT>>{std::move(*flattened)};
1498 } else {
1499 return std::nullopt;
1500 }
1501 },
1502 expr.u);
1503}
1504
1505// FromArrayConstructor is a subroutine for MapOperation() below.
1506// Given a flat ArrayConstructor<T> and a shape, it wraps the array
1507// into an Expr<T>, folds it, and returns the resulting wrapped
1508// array constructor or constant array value.
1509template <typename T>
1510std::optional<Expr<T>> FromArrayConstructor(
1511 FoldingContext &context, ArrayConstructor<T> &&values, const Shape &shape) {
1512 if (auto constShape{AsConstantExtents(context, shape)};
1513 constShape && !HasNegativeExtent(*constShape)) {
1514 Expr<T> result{Fold(context, Expr<T>{std::move(values)})};
1515 if (auto *constant{UnwrapConstantValue<T>(result)}) {
1516 // Elements and shape are both constant.
1517 return Expr<T>{constant->Reshape(std::move(*constShape))};
1518 }
1519 if (constShape->size() == 1) {
1520 if (auto elements{GetShape(context, result)}) {
1521 if (auto constElements{AsConstantExtents(context, *elements)}) {
1522 if (constElements->size() == 1 &&
1523 constElements->at(0) == constShape->at(0)) {
1524 // Elements are not constant, but array constructor has
1525 // the right known shape and can be simply returned as is.
1526 return std::move(result);
1527 }
1528 }
1529 }
1530 }
1531 }
1532 return std::nullopt;
1533}
1534
1535// MapOperation is a utility for various specializations of ApplyElementwise()
1536// that follow. Given one or two flat ArrayConstructor<OPERAND> (wrapped in an
1537// Expr<OPERAND>) for some specific operand type(s), apply a given function f
1538// to each of their corresponding elements to produce a flat
1539// ArrayConstructor<RESULT> (wrapped in an Expr<RESULT>).
1540// Preserves shape.
1541
1542// Unary case
1543template <typename RESULT, typename OPERAND>
1544std::optional<Expr<RESULT>> MapOperation(FoldingContext &context,
1545 std::function<Expr<RESULT>(Expr<OPERAND> &&)> &&f, const Shape &shape,
1546 [[maybe_unused]] std::optional<Expr<SubscriptInteger>> &&length,
1547 Expr<OPERAND> &&values) {
1548 ArrayConstructor<RESULT> result{values};
1549 if constexpr (common::HasMember<OPERAND, AllIntrinsicCategoryTypes>) {
1550 common::visit(
1551 [&](auto &&kindExpr) {
1552 using kindType = ResultType<decltype(kindExpr)>;
1553 auto &aConst{std::get<ArrayConstructor<kindType>>(kindExpr.u)};
1554 for (auto &acValue : aConst) {
1555 auto &scalar{std::get<Expr<kindType>>(acValue.u)};
1556 result.Push(Fold(context, f(Expr<OPERAND>{std::move(scalar)})));
1557 }
1558 },
1559 std::move(values.u));
1560 } else {
1561 auto &aConst{std::get<ArrayConstructor<OPERAND>>(values.u)};
1562 for (auto &acValue : aConst) {
1563 auto &scalar{std::get<Expr<OPERAND>>(acValue.u)};
1564 result.Push(Fold(context, f(std::move(scalar))));
1565 }
1566 }
1567 if constexpr (RESULT::category == TypeCategory::Character) {
1568 if (length) {
1569 result.set_LEN(std::move(*length));
1570 }
1571 }
1572 return FromArrayConstructor(context, std::move(result), shape);
1573}
1574
1575template <typename RESULT, typename A>
1576ArrayConstructor<RESULT> ArrayConstructorFromMold(
1577 const A &prototype, std::optional<Expr<SubscriptInteger>> &&length) {
1578 ArrayConstructor<RESULT> result{prototype};
1579 if constexpr (RESULT::category == TypeCategory::Character) {
1580 if (length) {
1581 result.set_LEN(std::move(*length));
1582 }
1583 }
1584 return result;
1585}
1586
1587template <typename LEFT, typename RIGHT>
1588bool ShapesMatch(FoldingContext &context,
1589 const ArrayConstructor<LEFT> &leftArrConst,
1590 const ArrayConstructor<RIGHT> &rightArrConst) {
1591 auto rightIter{rightArrConst.begin()};
1592 for (auto &leftValue : leftArrConst) {
1593 CHECK(rightIter != rightArrConst.end());
1594 auto &leftExpr{std::get<Expr<LEFT>>(leftValue.u)};
1595 auto &rightExpr{std::get<Expr<RIGHT>>(rightIter->u)};
1596 if (leftExpr.Rank() != rightExpr.Rank()) {
1597 return false;
1598 }
1599 std::optional<Shape> leftShape{GetShape(context, leftExpr)};
1600 std::optional<Shape> rightShape{GetShape(context, rightExpr)};
1601 if (!leftShape || !rightShape || *leftShape != *rightShape) {
1602 return false;
1603 }
1604 ++rightIter;
1605 }
1606 return true;
1607}
1608
1609// array * array case
1610template <typename RESULT, typename LEFT, typename RIGHT>
1611auto MapOperation(FoldingContext &context,
1612 std::function<Expr<RESULT>(Expr<LEFT> &&, Expr<RIGHT> &&)> &&f,
1613 const Shape &shape, std::optional<Expr<SubscriptInteger>> &&length,
1614 Expr<LEFT> &&leftValues, Expr<RIGHT> &&rightValues)
1615 -> std::optional<Expr<RESULT>> {
1616 auto result{ArrayConstructorFromMold<RESULT>(leftValues, std::move(length))};
1617 auto &leftArrConst{std::get<ArrayConstructor<LEFT>>(leftValues.u)};
1618 if constexpr (common::HasMember<RIGHT, AllIntrinsicCategoryTypes>) {
1619 bool mapped{common::visit(
1620 [&](auto &&kindExpr) -> bool {
1621 using kindType = ResultType<decltype(kindExpr)>;
1622
1623 auto &rightArrConst{std::get<ArrayConstructor<kindType>>(kindExpr.u)};
1624 if (!ShapesMatch(context, leftArrConst, rightArrConst)) {
1625 return false;
1626 }
1627 auto rightIter{rightArrConst.begin()};
1628 for (auto &leftValue : leftArrConst) {
1629 CHECK(rightIter != rightArrConst.end());
1630 auto &leftScalar{std::get<Expr<LEFT>>(leftValue.u)};
1631 auto &rightScalar{std::get<Expr<kindType>>(rightIter->u)};
1632 result.Push(Fold(context,
1633 f(std::move(leftScalar), Expr<RIGHT>{std::move(rightScalar)})));
1634 ++rightIter;
1635 }
1636 return true;
1637 },
1638 std::move(rightValues.u))};
1639 if (!mapped) {
1640 return std::nullopt;
1641 }
1642 } else {
1643 auto &rightArrConst{std::get<ArrayConstructor<RIGHT>>(rightValues.u)};
1644 if (!ShapesMatch(context, leftArrConst, rightArrConst)) {
1645 return std::nullopt;
1646 }
1647 auto rightIter{rightArrConst.begin()};
1648 for (auto &leftValue : leftArrConst) {
1649 CHECK(rightIter != rightArrConst.end());
1650 auto &leftScalar{std::get<Expr<LEFT>>(leftValue.u)};
1651 auto &rightScalar{std::get<Expr<RIGHT>>(rightIter->u)};
1652 result.Push(
1653 Fold(context, f(std::move(leftScalar), std::move(rightScalar))));
1654 ++rightIter;
1655 }
1656 }
1657 return FromArrayConstructor(context, std::move(result), shape);
1658}
1659
1660// array * scalar case
1661template <typename RESULT, typename LEFT, typename RIGHT>
1662auto MapOperation(FoldingContext &context,
1663 std::function<Expr<RESULT>(Expr<LEFT> &&, Expr<RIGHT> &&)> &&f,
1664 const Shape &shape, std::optional<Expr<SubscriptInteger>> &&length,
1665 Expr<LEFT> &&leftValues, const Expr<RIGHT> &rightScalar)
1666 -> std::optional<Expr<RESULT>> {
1667 auto result{ArrayConstructorFromMold<RESULT>(leftValues, std::move(length))};
1668 auto &leftArrConst{std::get<ArrayConstructor<LEFT>>(leftValues.u)};
1669 for (auto &leftValue : leftArrConst) {
1670 auto &leftScalar{std::get<Expr<LEFT>>(leftValue.u)};
1671 result.Push(
1672 Fold(context, f(std::move(leftScalar), Expr<RIGHT>{rightScalar})));
1673 }
1674 return FromArrayConstructor(context, std::move(result), shape);
1675}
1676
1677// scalar * array case
1678template <typename RESULT, typename LEFT, typename RIGHT>
1679auto MapOperation(FoldingContext &context,
1680 std::function<Expr<RESULT>(Expr<LEFT> &&, Expr<RIGHT> &&)> &&f,
1681 const Shape &shape, std::optional<Expr<SubscriptInteger>> &&length,
1682 const Expr<LEFT> &leftScalar, Expr<RIGHT> &&rightValues)
1683 -> std::optional<Expr<RESULT>> {
1684 auto result{ArrayConstructorFromMold<RESULT>(leftScalar, std::move(length))};
1685 if constexpr (common::HasMember<RIGHT, AllIntrinsicCategoryTypes>) {
1686 common::visit(
1687 [&](auto &&kindExpr) {
1688 using kindType = ResultType<decltype(kindExpr)>;
1689 auto &rightArrConst{std::get<ArrayConstructor<kindType>>(kindExpr.u)};
1690 for (auto &rightValue : rightArrConst) {
1691 auto &rightScalar{std::get<Expr<kindType>>(rightValue.u)};
1692 result.Push(Fold(context,
1693 f(Expr<LEFT>{leftScalar},
1694 Expr<RIGHT>{std::move(rightScalar)})));
1695 }
1696 },
1697 std::move(rightValues.u));
1698 } else {
1699 auto &rightArrConst{std::get<ArrayConstructor<RIGHT>>(rightValues.u)};
1700 for (auto &rightValue : rightArrConst) {
1701 auto &rightScalar{std::get<Expr<RIGHT>>(rightValue.u)};
1702 result.Push(
1703 Fold(context, f(Expr<LEFT>{leftScalar}, std::move(rightScalar))));
1704 }
1705 }
1706 return FromArrayConstructor(context, std::move(result), shape);
1707}
1708
1709template <typename DERIVED, typename RESULT, typename... OPD>
1710std::optional<Expr<SubscriptInteger>> ComputeResultLength(
1712 if constexpr (RESULT::category == TypeCategory::Character) {
1713 return Expr<RESULT>{operation.derived()}.LEN();
1714 }
1715 return std::nullopt;
1716}
1717
1718// ApplyElementwise() recursively folds the operand expression(s) of an
1719// operation, then attempts to apply the operation to the (corresponding)
1720// scalar element(s) of those operands. Returns std::nullopt for scalars
1721// or unlinearizable operands.
1722template <typename DERIVED, typename RESULT, typename OPERAND>
1723auto ApplyElementwise(FoldingContext &context,
1725 std::function<Expr<RESULT>(Expr<OPERAND> &&)> &&f)
1726 -> std::optional<Expr<RESULT>> {
1727 auto &expr{operation.left()};
1728 expr = Fold(context, std::move(expr));
1729 if (expr.Rank() > 0) {
1730 if (std::optional<Shape> shape{GetShape(context, expr)}) {
1731 if (auto values{AsFlatArrayConstructor(expr)}) {
1732 return MapOperation(context, std::move(f), *shape,
1733 ComputeResultLength(operation), std::move(*values));
1734 }
1735 }
1736 }
1737 return std::nullopt;
1738}
1739
1740template <typename DERIVED, typename RESULT, typename OPERAND>
1741auto ApplyElementwise(
1743 -> std::optional<Expr<RESULT>> {
1744 return ApplyElementwise(context, operation,
1745 std::function<Expr<RESULT>(Expr<OPERAND> &&)>{
1746 [](Expr<OPERAND> &&operand) {
1747 return Expr<RESULT>{DERIVED{std::move(operand)}};
1748 }});
1749}
1750
1751template <typename DERIVED, typename RESULT, typename LEFT, typename RIGHT>
1752auto ApplyElementwise(FoldingContext &context,
1754 std::function<Expr<RESULT>(Expr<LEFT> &&, Expr<RIGHT> &&)> &&f)
1755 -> std::optional<Expr<RESULT>> {
1756 auto resultLength{ComputeResultLength(operation)};
1757 auto &leftExpr{operation.left()};
1758 auto &rightExpr{operation.right()};
1759 if (leftExpr.Rank() != rightExpr.Rank() && leftExpr.Rank() != 0 &&
1760 rightExpr.Rank() != 0) {
1761 return std::nullopt; // error recovery
1762 }
1763 leftExpr = Fold(context, std::move(leftExpr));
1764 rightExpr = Fold(context, std::move(rightExpr));
1765 if (leftExpr.Rank() > 0) {
1766 if (std::optional<Shape> leftShape{GetShape(context, leftExpr)}) {
1767 if (auto left{AsFlatArrayConstructor(leftExpr)}) {
1768 if (rightExpr.Rank() > 0) {
1769 if (std::optional<Shape> rightShape{GetShape(context, rightExpr)}) {
1770 if (auto right{AsFlatArrayConstructor(rightExpr)}) {
1771 if (CheckConformance(context.messages(), *leftShape, *rightShape,
1772 CheckConformanceFlags::EitherScalarExpandable)
1773 .value_or(false /*fail if not known now to conform*/)) {
1774 return MapOperation(context, std::move(f), *leftShape,
1775 std::move(resultLength), std::move(*left),
1776 std::move(*right));
1777 } else {
1778 return std::nullopt;
1779 }
1780 return MapOperation(context, std::move(f), *leftShape,
1781 std::move(resultLength), std::move(*left), std::move(*right));
1782 }
1783 }
1784 } else if (IsExpandableScalar(rightExpr, context, *leftShape)) {
1785 return MapOperation(context, std::move(f), *leftShape,
1786 std::move(resultLength), std::move(*left), rightExpr);
1787 }
1788 }
1789 }
1790 } else if (rightExpr.Rank() > 0) {
1791 if (std::optional<Shape> rightShape{GetShape(context, rightExpr)}) {
1792 if (IsExpandableScalar(leftExpr, context, *rightShape)) {
1793 if (auto right{AsFlatArrayConstructor(rightExpr)}) {
1794 return MapOperation(context, std::move(f), *rightShape,
1795 std::move(resultLength), leftExpr, std::move(*right));
1796 }
1797 }
1798 }
1799 }
1800 return std::nullopt;
1801}
1802
1803template <typename DERIVED, typename RESULT, typename LEFT, typename RIGHT>
1804auto ApplyElementwise(
1806 -> std::optional<Expr<RESULT>> {
1807 return ApplyElementwise(context, operation,
1808 std::function<Expr<RESULT>(Expr<LEFT> &&, Expr<RIGHT> &&)>{
1809 [](Expr<LEFT> &&left, Expr<RIGHT> &&right) {
1810 return Expr<RESULT>{DERIVED{std::move(left), std::move(right)}};
1811 }});
1812}
1813
1814// Unary operations
1815
1816template <typename TO, typename FROM>
1817common::IfNoLvalue<std::optional<TO>, FROM> ConvertString(FROM &&s) {
1818 if constexpr (std::is_same_v<TO, FROM>) {
1819 return std::make_optional<TO>(std::move(s));
1820 } else {
1821 // Fortran character conversion is well defined between distinct kinds
1822 // only when the actual characters are valid 7-bit ASCII.
1823 TO str;
1824 for (auto iter{s.cbegin()}; iter != s.cend(); ++iter) {
1825 if (static_cast<std::uint64_t>(*iter) > 127) {
1826 return std::nullopt;
1827 }
1828 str.push_back(static_cast<typename TO::value_type>(*iter));
1829 }
1830 return std::make_optional<TO>(std::move(str));
1831 }
1832}
1833
1834template <typename TO, TypeCategory FROMCAT>
1835Expr<TO> FoldOperation(
1836 FoldingContext &context, Convert<TO, FROMCAT> &&convert) {
1837 if (auto array{ApplyElementwise(context, convert)}) {
1838 return *array;
1839 }
1840 struct {
1841 FoldingContext &context;
1842 Convert<TO, FROMCAT> &convert;
1843 } msvcWorkaround{context, convert};
1844 return common::visit(
1845 [&msvcWorkaround](auto &kindExpr) -> Expr<TO> {
1846 using Operand = ResultType<decltype(kindExpr)>;
1847 // This variable is a workaround for msvc which emits an error when
1848 // using the FROMCAT template parameter below.
1849 TypeCategory constexpr FromCat{FROMCAT};
1850 static_assert(FromCat == Operand::category);
1851 auto &convert{msvcWorkaround.convert};
1852 if (auto value{GetScalarConstantValue<Operand>(kindExpr)}) {
1853 FoldingContext &ctx{msvcWorkaround.context};
1854 if constexpr (TO::category == TypeCategory::Integer) {
1855 if constexpr (FromCat == TypeCategory::Integer) {
1856 auto converted{Scalar<TO>::ConvertSigned(*value)};
1857 if (converted.overflow) {
1858 ctx.Warn(common::UsageWarning::FoldingException,
1859 "conversion of %s_%d to INTEGER(%d) overflowed; result is %s"_warn_en_US,
1860 value->SignedDecimal(), Operand::kind, TO::kind,
1861 converted.value.SignedDecimal());
1862 }
1863 return ScalarConstantToExpr(std::move(converted.value));
1864 } else if constexpr (FromCat == TypeCategory::Unsigned) {
1865 auto converted{Scalar<TO>::ConvertUnsigned(*value)};
1866 if ((converted.overflow || converted.value.IsNegative())) {
1867 ctx.Warn(common::UsageWarning::FoldingException,
1868 "conversion of %s_U%d to INTEGER(%d) overflowed; result is %s"_warn_en_US,
1869 value->UnsignedDecimal(), Operand::kind, TO::kind,
1870 converted.value.SignedDecimal());
1871 }
1872 return ScalarConstantToExpr(std::move(converted.value));
1873 } else if constexpr (FromCat == TypeCategory::Real) {
1874 auto converted{value->template ToInteger<Scalar<TO>>()};
1875 if (converted.flags.test(RealFlag::InvalidArgument)) {
1876 ctx.Warn(common::UsageWarning::FoldingException,
1877 "REAL(%d) to INTEGER(%d) conversion: invalid argument"_warn_en_US,
1878 Operand::kind, TO::kind);
1879 } else if (converted.flags.test(RealFlag::Overflow)) {
1880 ctx.Warn(common::UsageWarning::FoldingException,
1881 "REAL(%d) to INTEGER(%d) conversion overflowed"_warn_en_US,
1882 Operand::kind, TO::kind);
1883 }
1884 return ScalarConstantToExpr(std::move(converted.value));
1885 }
1886 } else if constexpr (TO::category == TypeCategory::Unsigned) {
1887 if constexpr (FromCat == TypeCategory::Integer ||
1888 FromCat == TypeCategory::Unsigned) {
1889 return Expr<TO>{
1890 Constant<TO>{Scalar<TO>::ConvertUnsigned(*value).value}};
1891 } else if constexpr (FromCat == TypeCategory::Real) {
1892 return Expr<TO>{
1893 Constant<TO>{value->template ToInteger<Scalar<TO>>().value}};
1894 }
1895 } else if constexpr (TO::category == TypeCategory::Real) {
1896 if constexpr (FromCat == TypeCategory::Integer ||
1897 FromCat == TypeCategory::Unsigned) {
1898 auto converted{Scalar<TO>::FromInteger(
1899 *value, FromCat == TypeCategory::Unsigned)};
1900 if (!converted.flags.empty()) {
1901 char buffer[64];
1902 std::snprintf(buffer, sizeof buffer,
1903 "INTEGER(%d) to REAL(%d) conversion", Operand::kind,
1904 TO::kind);
1905 ctx.RealFlagWarnings(converted.flags, buffer);
1906 }
1907 return ScalarConstantToExpr(std::move(converted.value));
1908 } else if constexpr (FromCat == TypeCategory::Real) {
1909 auto converted{Scalar<TO>::Convert(*value)};
1910 char buffer[64];
1911 if (!converted.flags.empty()) {
1912 std::snprintf(buffer, sizeof buffer,
1913 "REAL(%d) to REAL(%d) conversion", Operand::kind, TO::kind);
1914 ctx.RealFlagWarnings(converted.flags, buffer);
1915 }
1916 if (ctx.targetCharacteristics().areSubnormalsFlushedToZero()) {
1917 converted.value = converted.value.FlushSubnormalToZero();
1918 }
1919 return ScalarConstantToExpr(std::move(converted.value));
1920 }
1921 } else if constexpr (TO::category == TypeCategory::Complex) {
1922 if constexpr (FromCat == TypeCategory::Complex) {
1923 return FoldOperation(ctx,
1925 AsExpr(Convert<typename TO::Part>{AsCategoryExpr(
1926 Constant<typename Operand::Part>{value->REAL()})}),
1927 AsExpr(Convert<typename TO::Part>{AsCategoryExpr(
1928 Constant<typename Operand::Part>{value->AIMAG()})})});
1929 }
1930 } else if constexpr (TO::category == TypeCategory::Character &&
1931 FromCat == TypeCategory::Character) {
1932 if (auto converted{ConvertString<Scalar<TO>>(std::move(*value))}) {
1933 return ScalarConstantToExpr(std::move(*converted));
1934 }
1935 } else if constexpr (TO::category == TypeCategory::Logical &&
1936 FromCat == TypeCategory::Logical) {
1937 return Expr<TO>{value->IsTrue()};
1938 }
1939 } else if constexpr (TO::category == FromCat &&
1940 FromCat != TypeCategory::Character) {
1941 // Conversion of non-constant in same type category
1942 if constexpr (std::is_same_v<Operand, TO>) {
1943 return std::move(kindExpr); // remove needless conversion
1944 } else if constexpr (TO::category == TypeCategory::Logical ||
1945 TO::category == TypeCategory::Integer) {
1946 if (auto *innerConv{
1947 std::get_if<Convert<Operand, TO::category>>(&kindExpr.u)}) {
1948 // Conversion of conversion of same category & kind
1949 if (auto *x{std::get_if<Expr<TO>>(&innerConv->left().u)}) {
1950 if constexpr (TO::category == TypeCategory::Logical ||
1951 TO::kind <= Operand::kind) {
1952 return std::move(*x); // no-op Logical or Integer
1953 // widening/narrowing conversion pair
1954 } else if constexpr (std::is_same_v<TO,
1955 DescriptorInquiry::Result>) {
1956 if (std::holds_alternative<DescriptorInquiry>(x->u) ||
1957 std::holds_alternative<TypeParamInquiry>(x->u)) {
1958 // int(int(size(...),kind=k),kind=8) -> size(...)
1959 return std::move(*x);
1960 }
1961 }
1962 }
1963 }
1964 }
1965 }
1966 return Expr<TO>{std::move(convert)};
1967 },
1968 convert.left().u);
1969}
1970
1971template <typename T>
1972Expr<T> FoldOperation(FoldingContext &context, Parentheses<T> &&x) {
1973 auto &operand{x.left()};
1974 operand = Fold(context, std::move(operand));
1975 if (auto value{GetScalarConstantValue<T>(operand)}) {
1976 // Preserve parentheses, even around constants.
1977 return Expr<T>{Parentheses<T>{Expr<T>{Constant<T>{*value}}}};
1978 } else if (std::holds_alternative<Parentheses<T>>(operand.u)) {
1979 // ((x)) -> (x)
1980 return std::move(operand);
1981 } else {
1982 return Expr<T>{Parentheses<T>{std::move(operand)}};
1983 }
1984}
1985
1986template <typename T>
1987Expr<T> FoldOperation(FoldingContext &context, Negate<T> &&x) {
1988 if (auto array{ApplyElementwise(context, x)}) {
1989 return *array;
1990 }
1991 auto &operand{x.left()};
1992 if (auto *nn{std::get_if<Negate<T>>(&x.left().u)}) {
1993 // -(-x) -> (x)
1994 if (IsVariable(nn->left())) {
1995 return FoldOperation(context, Parentheses<T>{std::move(nn->left())});
1996 } else {
1997 return std::move(nn->left());
1998 }
1999 } else if (auto value{GetScalarConstantValue<T>(operand)}) {
2000 if constexpr (T::category == TypeCategory::Integer) {
2001 auto negated{value->Negate()};
2002 if (negated.overflow) {
2003 context.Warn(common::UsageWarning::FoldingException,
2004 "INTEGER(%d) negation overflowed"_warn_en_US, T::kind);
2005 }
2006 return Expr<T>{Constant<T>{std::move(negated.value)}};
2007 } else if constexpr (T::category == TypeCategory::Unsigned) {
2008 return Expr<T>{Constant<T>{std::move(value->Negate().value)}};
2009 } else {
2010 // REAL & COMPLEX negation: no exceptions possible
2011 return Expr<T>{Constant<T>{value->Negate()}};
2012 }
2013 }
2014 return Expr<T>{std::move(x)};
2015}
2016
2017// Binary (dyadic) operations
2018
2019template <typename LEFT, typename RIGHT>
2020std::optional<std::pair<Scalar<LEFT>, Scalar<RIGHT>>> OperandsAreConstants(
2021 const Expr<LEFT> &x, const Expr<RIGHT> &y) {
2022 if (auto xvalue{GetScalarConstantValue<LEFT>(x)}) {
2023 if (auto yvalue{GetScalarConstantValue<RIGHT>(y)}) {
2024 return {std::make_pair(*xvalue, *yvalue)};
2025 }
2026 }
2027 return std::nullopt;
2028}
2029
2030template <typename DERIVED, typename RESULT, typename LEFT, typename RIGHT>
2031std::optional<std::pair<Scalar<LEFT>, Scalar<RIGHT>>> OperandsAreConstants(
2032 const Operation<DERIVED, RESULT, LEFT, RIGHT> &operation) {
2033 return OperandsAreConstants(operation.left(), operation.right());
2034}
2035
2036template <typename T>
2037Expr<T> FoldOperation(FoldingContext &context, Add<T> &&x) {
2038 if (auto array{ApplyElementwise(context, x)}) {
2039 return *array;
2040 }
2041 if (auto folded{OperandsAreConstants(x)}) {
2042 if constexpr (T::category == TypeCategory::Integer) {
2043 auto sum{folded->first.AddSigned(folded->second)};
2044 if (sum.overflow) {
2045 context.Warn(common::UsageWarning::FoldingException,
2046 "INTEGER(%d) addition overflowed"_warn_en_US, T::kind);
2047 }
2048 return Expr<T>{Constant<T>{sum.value}};
2049 } else if constexpr (T::category == TypeCategory::Unsigned) {
2050 return Expr<T>{
2051 Constant<T>{folded->first.AddUnsigned(folded->second).value}};
2052 } else {
2053 auto sum{folded->first.Add(
2054 folded->second, context.targetCharacteristics().roundingMode())};
2055 context.RealFlagWarnings(sum.flags, "addition");
2056 if (context.targetCharacteristics().areSubnormalsFlushedToZero()) {
2057 sum.value = sum.value.FlushSubnormalToZero();
2058 }
2059 return Expr<T>{Constant<T>{sum.value}};
2060 }
2061 } else if constexpr (T::category == TypeCategory::Integer ||
2062 T::category == TypeCategory::Unsigned) {
2063 if (auto c{GetScalarConstantValue<T>(x.right())}) {
2064 if (c->IsZero() && x.left().Rank() == 0) {
2065 if (IsVariable(x.left())) {
2066 return FoldOperation(context, Parentheses<T>{std::move(x.left())});
2067 } else {
2068 return std::move(x.left());
2069 }
2070 }
2071 } else if (auto c{GetScalarConstantValue<T>(x.left())}) {
2072 if (c->IsZero() && x.right().Rank() == 0) {
2073 if (IsVariable(x.right())) {
2074 return FoldOperation(context, Parentheses<T>{std::move(x.right())});
2075 } else {
2076 return std::move(x.right());
2077 }
2078 }
2079 }
2080 }
2081 return Expr<T>{std::move(x)};
2082}
2083
2084template <typename T>
2085Expr<T> FoldOperation(FoldingContext &context, Subtract<T> &&x) {
2086 if (auto array{ApplyElementwise(context, x)}) {
2087 return *array;
2088 }
2089 if (auto folded{OperandsAreConstants(x)}) {
2090 if constexpr (T::category == TypeCategory::Integer) {
2091 auto difference{folded->first.SubtractSigned(folded->second)};
2092 if (difference.overflow) {
2093 context.Warn(common::UsageWarning::FoldingException,
2094 "INTEGER(%d) subtraction overflowed"_warn_en_US, T::kind);
2095 }
2096 return Expr<T>{Constant<T>{difference.value}};
2097 } else if constexpr (T::category == TypeCategory::Unsigned) {
2098 return Expr<T>{
2099 Constant<T>{folded->first.SubtractSigned(folded->second).value}};
2100 } else {
2101 auto difference{folded->first.Subtract(
2102 folded->second, context.targetCharacteristics().roundingMode())};
2103 context.RealFlagWarnings(difference.flags, "subtraction");
2104 if (context.targetCharacteristics().areSubnormalsFlushedToZero()) {
2105 difference.value = difference.value.FlushSubnormalToZero();
2106 }
2107 return Expr<T>{Constant<T>{difference.value}};
2108 }
2109 } else if constexpr (T::category == TypeCategory::Integer ||
2110 T::category == TypeCategory::Unsigned) {
2111 if (auto c{GetScalarConstantValue<T>(x.right())}) {
2112 if (c->IsZero() && x.left().Rank() == 0) {
2113 if (IsVariable(x.left())) {
2114 return FoldOperation(context, Parentheses<T>{std::move(x.left())});
2115 } else {
2116 return std::move(x.left());
2117 }
2118 }
2119 }
2120 }
2121 return Expr<T>{std::move(x)};
2122}
2123
2124template <typename T>
2125Expr<T> FoldOperation(FoldingContext &context, Multiply<T> &&x) {
2126 if (auto array{ApplyElementwise(context, x)}) {
2127 return *array;
2128 }
2129 if (auto folded{OperandsAreConstants(x)}) {
2130 if constexpr (T::category == TypeCategory::Integer) {
2131 auto product{folded->first.MultiplySigned(folded->second)};
2132 if (product.SignedMultiplicationOverflowed()) {
2133 context.Warn(common::UsageWarning::FoldingException,
2134 "INTEGER(%d) multiplication overflowed"_warn_en_US, T::kind);
2135 }
2136 return Expr<T>{Constant<T>{product.lower}};
2137 } else if constexpr (T::category == TypeCategory::Unsigned) {
2138 return Expr<T>{
2139 Constant<T>{folded->first.MultiplyUnsigned(folded->second).lower}};
2140 } else {
2141 auto product{folded->first.Multiply(
2142 folded->second, context.targetCharacteristics().roundingMode())};
2143 context.RealFlagWarnings(product.flags, "multiplication");
2144 if (context.targetCharacteristics().areSubnormalsFlushedToZero()) {
2145 product.value = product.value.FlushSubnormalToZero();
2146 }
2147 return Expr<T>{Constant<T>{product.value}};
2148 }
2149 } else if constexpr (T::category == TypeCategory::Integer) {
2150 if (auto c{GetScalarConstantValue<T>(x.right())}) {
2151 x.right() = std::move(x.left());
2152 x.left() = Expr<T>{std::move(*c)};
2153 }
2154 if (auto c{GetScalarConstantValue<T>(x.left())}) {
2155 if (c->IsZero() && x.right().Rank() == 0) {
2156 return std::move(x.left());
2157 } else if (c->CompareSigned(Scalar<T>{1}) == Ordering::Equal) {
2158 if (IsVariable(x.right())) {
2159 return FoldOperation(context, Parentheses<T>{std::move(x.right())});
2160 } else {
2161 return std::move(x.right());
2162 }
2163 } else if (c->CompareSigned(Scalar<T>{-1}) == Ordering::Equal) {
2164 return FoldOperation(context, Negate<T>{std::move(x.right())});
2165 }
2166 }
2167 }
2168 return Expr<T>{std::move(x)};
2169}
2170
2171template <typename T>
2172Expr<T> FoldOperation(FoldingContext &context, Divide<T> &&x) {
2173 if (auto array{ApplyElementwise(context, x)}) {
2174 return *array;
2175 }
2176 if (auto folded{OperandsAreConstants(x)}) {
2177 if constexpr (T::category == TypeCategory::Integer) {
2178 auto quotAndRem{folded->first.DivideSigned(folded->second)};
2179 if (quotAndRem.divisionByZero) {
2180 context.Warn(common::UsageWarning::FoldingException,
2181 "INTEGER(%d) division by zero"_warn_en_US, T::kind);
2182 return Expr<T>{std::move(x)};
2183 }
2184 if (quotAndRem.overflow) {
2185 context.Warn(common::UsageWarning::FoldingException,
2186 "INTEGER(%d) division overflowed"_warn_en_US, T::kind);
2187 }
2188 return Expr<T>{Constant<T>{quotAndRem.quotient}};
2189 } else if constexpr (T::category == TypeCategory::Unsigned) {
2190 auto quotAndRem{folded->first.DivideUnsigned(folded->second)};
2191 if (quotAndRem.divisionByZero) {
2192 context.Warn(common::UsageWarning::FoldingException,
2193 "UNSIGNED(%d) division by zero"_warn_en_US, T::kind);
2194 return Expr<T>{std::move(x)};
2195 }
2196 return Expr<T>{Constant<T>{quotAndRem.quotient}};
2197 } else {
2198 auto quotient{folded->first.Divide(
2199 folded->second, context.targetCharacteristics().roundingMode())};
2200 // Don't warn about -1./0., 0./0., or 1./0. from a module file
2201 // they are interpreted as canonical Fortran representations of -Inf,
2202 // NaN, and Inf respectively.
2203 bool isCanonicalNaNOrInf{false};
2204 if constexpr (T::category == TypeCategory::Real) {
2205 if (folded->second.IsZero() && context.moduleFileName().has_value()) {
2206 using IntType = typename T::Scalar::Word;
2207 auto intNumerator{folded->first.template ToInteger<IntType>()};
2208 isCanonicalNaNOrInf = intNumerator.flags == RealFlags{} &&
2209 intNumerator.value >= IntType{-1} &&
2210 intNumerator.value <= IntType{1};
2211 }
2212 }
2213 if (!isCanonicalNaNOrInf) {
2214 context.RealFlagWarnings(quotient.flags, "division");
2215 }
2216 if (context.targetCharacteristics().areSubnormalsFlushedToZero()) {
2217 quotient.value = quotient.value.FlushSubnormalToZero();
2218 }
2219 return Expr<T>{Constant<T>{quotient.value}};
2220 }
2221 }
2222 return Expr<T>{std::move(x)};
2223}
2224
2225template <typename T>
2226Expr<T> FoldOperation(FoldingContext &context, Power<T> &&x) {
2227 if (auto array{ApplyElementwise(context, x)}) {
2228 return *array;
2229 }
2230 if (auto folded{OperandsAreConstants(x)}) {
2231 if constexpr (T::category == TypeCategory::Integer) {
2232 auto power{folded->first.Power(folded->second)};
2233 if (power.divisionByZero) {
2234 context.Warn(common::UsageWarning::FoldingException,
2235 "INTEGER(%d) zero to negative power"_warn_en_US, T::kind);
2236 } else if (power.overflow) {
2237 context.Warn(common::UsageWarning::FoldingException,
2238 "INTEGER(%d) power overflowed"_warn_en_US, T::kind);
2239 } else if (power.zeroToZero) {
2240 context.Warn(common::UsageWarning::FoldingException,
2241 "INTEGER(%d) 0**0 is not defined"_warn_en_US, T::kind);
2242 }
2243 return Expr<T>{Constant<T>{power.power}};
2244 } else {
2245 if (folded->first.IsZero()) {
2246 if (folded->second.IsZero()) {
2247 context.Warn(common::UsageWarning::FoldingException,
2248 "REAL/COMPLEX 0**0 is not defined"_warn_en_US);
2249 } else {
2250 return Expr<T>(Constant<T>{folded->first}); // 0. ** nonzero -> 0.
2251 }
2252 } else if (auto callable{GetHostRuntimeWrapper<T, T, T>("pow")}) {
2253 return Expr<T>{
2254 Constant<T>{(*callable)(context, folded->first, folded->second)}};
2255 } else {
2256 context.Warn(common::UsageWarning::FoldingFailure,
2257 "Power for %s cannot be folded on host"_warn_en_US,
2258 T{}.AsFortran());
2259 }
2260 }
2261 }
2262 return Expr<T>{std::move(x)};
2263}
2264
2265template <typename T>
2266Expr<T> FoldOperation(FoldingContext &context, RealToIntPower<T> &&x) {
2267 if (auto array{ApplyElementwise(context, x)}) {
2268 return *array;
2269 }
2270 return common::visit(
2271 [&](auto &y) -> Expr<T> {
2272 if (auto folded{OperandsAreConstants(x.left(), y)}) {
2273 auto power{evaluate::IntPower(folded->first, folded->second)};
2274 context.RealFlagWarnings(power.flags, "power with INTEGER exponent");
2275 if (context.targetCharacteristics().areSubnormalsFlushedToZero()) {
2276 power.value = power.value.FlushSubnormalToZero();
2277 }
2278 return Expr<T>{Constant<T>{power.value}};
2279 } else {
2280 return Expr<T>{std::move(x)};
2281 }
2282 },
2283 x.right().u);
2284}
2285
2286template <typename T>
2287Expr<T> FoldOperation(FoldingContext &context, ConditionalExpr<T> &&x) {
2288 x.condition() = Fold(context, std::move(x.condition()));
2289 // If the condition is a scalar logical constant, select the branch.
2290 if (auto cst{GetScalarConstantValue<LogicalResult>(x.condition())}) {
2291 return cst->IsTrue() ? Fold(context, std::move(x.thenValue()))
2292 : Fold(context, std::move(x.elseValue()));
2293 }
2294 return Expr<T>{std::move(x)};
2295}
2296
2297template <typename T>
2298Expr<T> FoldOperation(FoldingContext &context, Extremum<T> &&x) {
2299 if (auto array{ApplyElementwise(context, x,
2300 std::function<Expr<T>(Expr<T> &&, Expr<T> &&)>{[=](Expr<T> &&l,
2301 Expr<T> &&r) {
2302 return Expr<T>{Extremum<T>{x.ordering, std::move(l), std::move(r)}};
2303 }})}) {
2304 return *array;
2305 }
2306 if (auto folded{OperandsAreConstants(x)}) {
2307 if constexpr (T::category == TypeCategory::Integer) {
2308 if (folded->first.CompareSigned(folded->second) == x.ordering) {
2309 return Expr<T>{Constant<T>{folded->first}};
2310 }
2311 } else if constexpr (T::category == TypeCategory::Unsigned) {
2312 if (folded->first.CompareUnsigned(folded->second) == x.ordering) {
2313 return Expr<T>{Constant<T>{folded->first}};
2314 }
2315 } else if constexpr (T::category == TypeCategory::Real) {
2316 if (folded->first.IsNotANumber() ||
2317 (folded->first.Compare(folded->second) == Relation::Less) ==
2318 (x.ordering == Ordering::Less)) {
2319 return Expr<T>{Constant<T>{folded->first}};
2320 }
2321 } else {
2322 static_assert(T::category == TypeCategory::Character);
2323 // Result of MIN and MAX on character has the length of
2324 // the longest argument.
2325 auto maxLen{std::max(folded->first.length(), folded->second.length())};
2326 bool isFirst{x.ordering == Compare(folded->first, folded->second)};
2327 auto res{isFirst ? std::move(folded->first) : std::move(folded->second)};
2328 res = res.length() == maxLen
2329 ? std::move(res)
2330 : CharacterUtils<T::kind>::Resize(res, maxLen);
2331 return Expr<T>{Constant<T>{std::move(res)}};
2332 }
2333 return Expr<T>{Constant<T>{folded->second}};
2334 }
2335 return Expr<T>{std::move(x)};
2336}
2337
2338template <int KIND>
2340 FoldingContext &context, Expr<SomeType> &&expr) {
2341 using Result = Type<TypeCategory::Real, KIND>;
2342 std::optional<Expr<Result>> result;
2343 common::visit(
2344 [&](auto &&x) {
2345 using From = std::decay_t<decltype(x)>;
2346 if constexpr (std::is_same_v<From, BOZLiteralConstant>) {
2347 // Move the bits without any integer->real conversion
2348 From original{x};
2349 result = ConvertToType<Result>(std::move(x));
2350 const auto *constant{UnwrapExpr<Constant<Result>>(*result)};
2351 CHECK(constant);
2352 Scalar<Result> real{constant->GetScalarValue().value()};
2353 From converted{From::ConvertUnsigned(real.RawBits()).value};
2354 if (original != converted) { // C1601
2355 context.Warn(common::UsageWarning::FoldingValueChecks,
2356 "Nonzero bits truncated from BOZ literal constant in REAL intrinsic"_warn_en_US);
2357 }
2358 } else if constexpr (IsNumericCategoryExpr<From>()) {
2359 result = Fold(context, ConvertToType<Result>(std::move(x)));
2360 } else {
2361 common::die("ToReal: bad argument expression");
2362 }
2363 },
2364 std::move(expr.u));
2365 return result.value();
2366}
2367
2368// REAL(z) and AIMAG(z)
2369template <int KIND>
2371 FoldingContext &context, ComplexComponent<KIND> &&x) {
2372 using Operand = Type<TypeCategory::Complex, KIND>;
2373 using Result = Type<TypeCategory::Real, KIND>;
2374 if (auto array{ApplyElementwise(context, x,
2375 std::function<Expr<Result>(Expr<Operand> &&)>{
2376 [=](Expr<Operand> &&operand) {
2378 x.isImaginaryPart, std::move(operand)}};
2379 }})}) {
2380 return *array;
2381 }
2382 auto &operand{x.left()};
2383 if (auto value{GetScalarConstantValue<Operand>(operand)}) {
2384 if (x.isImaginaryPart) {
2385 return Expr<Result>{Constant<Result>{value->AIMAG()}};
2386 } else {
2387 return Expr<Result>{Constant<Result>{value->REAL()}};
2388 }
2389 }
2390 return Expr<Result>{std::move(x)};
2391}
2392
2393template <typename T>
2394Expr<T> ExpressionBase<T>::Rewrite(FoldingContext &context, Expr<T> &&expr) {
2395 return common::visit(
2396 [&](auto &&x) -> Expr<T> {
2397 if constexpr (IsSpecificIntrinsicType<T>) {
2398 return FoldOperation(context, std::move(x));
2399 } else if constexpr (std::is_same_v<T, SomeDerived>) {
2400 return FoldOperation(context, std::move(x));
2401 } else if constexpr (common::HasMember<decltype(x),
2402 TypelessExpression>) {
2403 return std::move(expr);
2404 } else {
2405 return Expr<T>{Fold(context, std::move(x))};
2406 }
2407 },
2408 std::move(expr.u));
2409}
2410
2411FOR_EACH_TYPE_AND_KIND(extern template class ExpressionBase, )
2412} // namespace Fortran::evaluate
2413#endif // FORTRAN_EVALUATE_FOLD_IMPLEMENTATION_H_
Definition fold-implementation.h:1341
Definition expression.h:506
Definition variable.h:205
Definition variable.h:243
Definition variable.h:357
Definition variable.h:73
Definition expression.h:394
Definition constant.h:60
Definition constant.h:147
Definition variable.h:381
Definition type.h:73
Definition common.h:215
Definition expression.h:65
Definition fold-implementation.h:53
Definition common.h:217
Definition call.h:394
Definition expression.h:444
Definition variable.h:101
Definition expression.h:113
Definition expression.h:781
Definition variable.h:304
Definition variable.h:160
Definition variable.h:136
Definition type.h:56
Definition symbol.h:896
Definition call.h:34
Definition ParserActions.h:24
Definition expression.h:295
Definition expression.h:472
Definition expression.h:256
Definition expression.h:356
Definition expression.h:210
Definition variable.h:288
Definition expression.h:316
Definition expression.h:339
Definition expression.h:436
Definition expression.h:309
Definition expression.h:246
Definition expression.h:228
Definition expression.h:323
Definition expression.h:331
Definition type.h:399
Definition variable.h:191
Definition expression.h:302