9#ifndef FORTRAN_EVALUATE_FOLD_IMPLEMENTATION_H_
10#define FORTRAN_EVALUATE_FOLD_IMPLEMENTATION_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/formatting.h"
24#include "flang/Evaluate/intrinsics-library.h"
25#include "flang/Evaluate/intrinsics.h"
26#include "flang/Evaluate/shape.h"
27#include "flang/Evaluate/tools.h"
28#include "flang/Evaluate/traverse.h"
29#include "flang/Evaluate/type.h"
30#include "flang/Parser/message.h"
31#include "flang/Semantics/scope.h"
32#include "flang/Semantics/symbol.h"
33#include "flang/Semantics/tools.h"
52static constexpr bool useKahanSummation{
false};
58 : context_{c}, forOptionalArgument_{forOptionalArgument} {}
59 std::optional<Constant<T>> GetNamedConstant(
const Symbol &);
60 std::optional<Constant<T>> ApplySubscripts(
const Constant<T> &array,
65 std::optional<Constant<T>> GetConstantComponent(
67 std::optional<Constant<T>> Folding(
ArrayRef &);
68 std::optional<Constant<T>> Folding(
DataRef &);
70 Constant<T> *Folding(std::optional<ActualArgument> &);
85 bool forOptionalArgument_{
false};
88std::optional<Constant<SubscriptInteger>> GetConstantSubscript(
92template <
typename TR,
typename... TA>
93std::optional<std::function<Scalar<TR>(
FoldingContext &, Scalar<TA>...)>>
94GetHostRuntimeWrapper(
const std::string &name) {
95 std::vector<DynamicType> argTypes{TA{}.GetType()...};
96 if (
auto hostWrapper{GetHostRuntimeWrapper(name, TR{}.GetType(), argTypes)}) {
98 FoldingContext &context, Scalar<TA>... args) -> Scalar<TR> {
99 std::vector<Expr<SomeType>> genericArgs{
100 AsGenericExpr(Constant<TA>{args})...};
101 return GetScalarConstantValue<TR>(
102 (*hostWrapper)(context, std::move(genericArgs)))
117common::IfNoLvalue<Expr<ResultType<A>>, A> FoldOperation(
118 FoldingContext &, A &&x) {
119 static_assert(!std::is_same_v<A, Expr<ResultType<A>>>,
120 "call Fold() instead for Expr<>");
121 return Expr<ResultType<A>>{std::move(x)};
124Component FoldOperation(FoldingContext &, Component &&);
125NamedEntity FoldOperation(FoldingContext &, NamedEntity &&);
126Triplet FoldOperation(FoldingContext &, Triplet &&);
127Subscript FoldOperation(FoldingContext &, Subscript &&);
128ArrayRef FoldOperation(FoldingContext &, ArrayRef &&);
129CoarrayRef FoldOperation(FoldingContext &, CoarrayRef &&);
130DataRef FoldOperation(FoldingContext &, DataRef &&);
131Substring FoldOperation(FoldingContext &, Substring &&);
132ComplexPart FoldOperation(FoldingContext &, ComplexPart &&);
134Expr<T> FoldOperation(FoldingContext &, FunctionRef<T> &&);
136Expr<T> FoldOperation(FoldingContext &context, Designator<T> &&designator) {
137 return Folder<T>{context}.Folding(std::move(designator));
139Expr<TypeParamInquiry::Result> FoldOperation(
140 FoldingContext &, TypeParamInquiry &&);
141Expr<ImpliedDoIndex::Result> FoldOperation(
142 FoldingContext &context, ImpliedDoIndex &&);
144Expr<T> FoldOperation(FoldingContext &, ArrayConstructor<T> &&);
145Expr<SomeDerived> FoldOperation(FoldingContext &, StructureConstructor &&);
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())}) {
162std::optional<Constant<T>> Folder<T>::Folding(ArrayRef &aRef) {
163 std::vector<Constant<SubscriptInteger>> subscripts;
165 for (Subscript &ss : aRef.subscript()) {
166 if (
auto constant{GetConstantSubscript(context_, ss, aRef.base(), dim++)}) {
167 subscripts.emplace_back(std::move(*constant));
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);
183std::optional<Constant<T>> Folder<T>::Folding(DataRef &ref) {
184 return common::visit(
186 [
this](SymbolRef &sym) {
return GetNamedConstant(*sym); },
187 [
this](Component &comp) {
188 comp = FoldOperation(context_, std::move(comp));
189 return GetConstantComponent(comp);
191 [
this](ArrayRef &aRef) {
192 aRef = FoldOperation(context_, std::move(aRef));
193 return Folding(aRef);
195 [](CoarrayRef &) {
return std::optional<Constant<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) {
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};
225 for (
int j{0}; j < rank; ++j) {
226 if (subscripts[j].Rank() == 0) {
227 at[j] = subscripts[j].GetScalarValue().value().ToInt64();
229 CHECK(k < GetRank(resultShape));
230 tmp[0] = ssLB.at(k) + ssAt.at(k);
231 at[j] = subscripts[j].At(tmp).ToInt64();
233 if (++ssAt[k] == resultShape[k]) {
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,
248 values.emplace_back(array.At(at));
249 CHECK(!increment || elements == 0);
250 CHECK(k == GetRank(resultShape));
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)};
258 return Constant<T>{std::move(values), std::move(resultShape)};
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)}) {
270 return ApplySubscripts(*value, *subscripts);
278 std::unique_ptr<ArrayConstructor<T>> array;
279 if (structures.empty()) {
282 ConstantSubscripts at{structures.lbounds()};
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())}) {
290 auto *typedExpr{UnwrapExpr<Expr<T>>(expr.value())};
292 array = std::make_unique<ArrayConstructor<T>>(*typedExpr);
293 if constexpr (T::category == TypeCategory::Character) {
294 array->set_LEN(Expr<SubscriptInteger>{value->LEN()});
298 if (
auto element{ApplySubscripts(*value, *subscripts)}) {
299 CHECK(element->Rank() == 0);
300 array->Push(Expr<T>{std::move(*element)});
305 CHECK(value->Rank() == 0);
306 array->Push(Expr<T>{*value});
312 }
while (structures.IncrementSubscripts(at));
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()));
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(
328 [&](
const Symbol &symbol) {
329 return Folder<SomeDerived>{context_}.GetNamedConstant(symbol);
331 [&](ArrayRef &aRef) {
332 return Folder<SomeDerived>{context_}.Folding(aRef);
334 [&](Component &base) {
335 return Folder<SomeDerived>{context_}.GetConstantComponent(base);
338 return std::optional<Constant<SomeDerived>>{};
341 component.base().u)}) {
342 return ApplyComponent(
343 std::move(*structures), component.GetLastSymbol(), subscripts);
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);
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));
365 using ComplexT = Type<TypeCategory::Complex, T::kind>;
366 if (
auto zConst{Folder<ComplexT>{context_}.Folding(zPart->complex())}) {
367 return Fold(context_,
368 Expr<T>{ComplexComponent<T::kind>{
369 zPart->part() == ComplexPart::Part::IM,
370 Expr<ComplexT>{std::move(*zConst)}}});
372 return Expr<T>{Designator<T>{std::move(*zPart)}};
376 return common::visit(
378 [&](SymbolRef &&symbol) {
379 if (
auto constant{GetNamedConstant(*symbol)}) {
380 return Expr<T>{std::move(*constant)};
382 return Expr<T>{std::move(designator)};
384 [&](ArrayRef &&aRef) {
385 aRef = FoldOperation(context_, std::move(aRef));
386 if (
auto c{Folding(aRef)}) {
387 return Expr<T>{std::move(*c)};
389 return Expr<T>{Designator<T>{std::move(aRef)}};
392 [&](Component &&component) {
393 component = FoldOperation(context_, std::move(component));
394 if (
auto c{GetConstantComponent(component)}) {
395 return Expr<T>{std::move(*c)};
397 return Expr<T>{Designator<T>{std::move(component)}};
402 Designator<T>{FoldOperation(context_, std::move(x))}};
405 std::move(designator.u));
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)) {
417 var{forOptionalArgument_
418 ? UnwrapWholeSymbolOrComponentDataRef(*expr)
420 var && (IsOptional(*var) || IsAllocatableOrObjectPointer(var))) {
422 }
else if (
auto converted{
423 ConvertToType(T::GetType(), std::move(*expr))}) {
424 *expr = Fold(context_, std::move(*converted));
428 return UnwrapConstantValue<T>(*expr);
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)))) {
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...>{});
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...>) {
459 GetConstantArguments<A...>(context, args, hasOptionalArgument)}) {
460 return std::tuple<Scalar<A>...>{
461 std::get<I>(*constArgs)->GetScalarValue().value()...};
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...>{});
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> &...)>;
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)}) {
493 ConstantSubscripts shape;
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) {
503 if (shape != *shapes[i]) {
508 context.messages().Say(
509 "Arguments in elemental intrinsic function are not conformable"_err_en_US);
510 return Expr<TR>{std::move(funcRef)};
515 CHECK(rank == GetRank(shape));
517 std::vector<Scalar<TR>> results;
518 std::optional<uint64_t> n{TotalElementCount(shape)};
520 context.messages().Say(
521 "Too many elements in elemental intrinsic function result"_err_en_US);
522 return Expr<TR>{std::move(funcRef)};
525 ConstantBounds bounds{shape};
526 ConstantSubscripts resultIndex(rank, 1);
527 ConstantSubscripts argIndex[]{std::get<I>(*args)->lbounds()...};
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])...));
537 (std::get<I>(*args)->IncrementSubscripts(argIndex[I]), ...);
538 }
while (bounds.IncrementSubscripts(resultIndex));
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)}};
553 return Expr<TR>{Constant<TR>{std::move(results), std::move(shape)}};
556 return Expr<TR>{std::move(funcRef)};
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...>{});
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...>{});
576std::optional<std::int64_t> GetInt64ArgOr(
577 const std::optional<ActualArgument> &, std::int64_t defaultValue);
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()));
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())}}};
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)};
622 auto convertedShift{Fold(context_,
623 ConvertToType<SubscriptInteger>(Expr<SomeInteger>{*shiftExpr}))};
624 const auto *shift{UnwrapConstantValue<SubscriptInteger>(convertedShift)};
626 return Expr<T>{std::move(funcRef)};
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) {
635 int rank{array->Rank()};
636 int zbDim{
static_cast<int>(*dim) - 1};
638 if (shift->Rank() > 0) {
640 for (
int j{0}; j < rank; ++j) {
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]));
654 std::vector<Scalar<T>> resultElements;
655 ConstantSubscripts arrayLB{array->lbounds()};
656 ConstantSubscripts arrayAt{arrayLB};
657 ConstantSubscript &dimIndex{arrayAt[zbDim]};
658 ConstantSubscript dimLB{dimIndex};
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) {
666 for (
int j{0}; j < rank; ++j) {
668 shiftAt.emplace_back(shiftLB[k++] + arrayAt[j] - arrayLB[j]);
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;
679 resultElements.push_back(array->At(arrayAt));
680 dimIndex = origDimIndex;
681 array->IncrementSubscripts(arrayAt);
683 return Expr<T>{PackageConstant<T>(
684 std::move(resultElements), *array, array->shape())};
688 return MakeInvalidIntrinsic(std::move(funcRef));
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)};
701 auto convertedShift{Fold(context_,
702 ConvertToType<SubscriptInteger>(Expr<SomeInteger>{*shiftExpr}))};
703 const auto *shift{UnwrapConstantValue<SubscriptInteger>(convertedShift)};
705 return Expr<T>{std::move(funcRef)};
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);
714 return Expr<T>{std::move(funcRef)};
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) {
724 }
else if (boundary && boundary->Rank() > 0 &&
725 boundary->Rank() != array->Rank() - 1) {
728 int rank{array->Rank()};
729 int zbDim{
static_cast<int>(*dim) - 1};
731 if (shift->Rank() > 0) {
733 for (
int j{0}; j < rank; ++j) {
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]));
746 if (boundary && boundary->Rank() > 0) {
748 for (
int j{0}; j < rank; ++j) {
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]));
762 std::vector<Scalar<T>> resultElements;
763 ConstantSubscripts arrayLB{array->lbounds()};
764 ConstantSubscripts arrayAt{arrayLB};
765 ConstantSubscript &dimIndex{arrayAt[zbDim]};
766 ConstantSubscript dimLB{dimIndex};
767 ConstantSubscript dimExtent{array->shape()[zbDim]};
768 ConstantSubscripts shiftLB{shift->lbounds()};
769 ConstantSubscripts boundaryLB;
771 boundaryLB = boundary->lbounds();
773 for (
auto n{GetSize(array->shape())}; n > 0; --n) {
774 ConstantSubscript origDimIndex{dimIndex};
775 ConstantSubscripts shiftAt;
776 if (shift->Rank() > 0) {
778 for (
int j{0}; j < rank; ++j) {
780 shiftAt.emplace_back(shiftLB[k++] + arrayAt[j] - arrayLB[j]);
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) {
794 boundaryAt.emplace_back(
795 boundaryLB[k++] + arrayAt[j] - arrayLB[j]);
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);
811 DIE(
"no derived type boundary");
813 dimIndex = origDimIndex;
814 array->IncrementSubscripts(arrayAt);
816 return Expr<T>{PackageConstant<T>(
817 std::move(resultElements), *array, array->shape())};
821 return MakeInvalidIntrinsic(std::move(funcRef));
824template <
typename T> Expr<T> Folder<T>::MERGE(FunctionRef<T> &&funcRef) {
825 return FoldElementalIntrinsic<T, T, T, LogicalResult>(context_,
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;
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)};
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;
854 }
else if (array->shape() != mask->shape()) {
856 return MakeInvalidIntrinsic(std::move(funcRef));
858 for (ConstantSubscript j{0}; j < arrayElements;
859 ++j, mask->IncrementSubscripts(maskAt)) {
860 if (mask->At(maskAt).IsTrue()) {
865 std::vector<Scalar<T>> resultElements;
866 ConstantSubscripts arrayAt{array->lbounds()};
867 ConstantSubscript resultSize{truths};
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));
878 for (ConstantSubscript j{0}; j < truths;) {
879 if (mask->At(maskAt).IsTrue()) {
880 resultElements.push_back(array->At(arrayAt));
883 array->IncrementSubscripts(arrayAt);
884 mask->IncrementSubscripts(maskAt);
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));
894 return Expr<T>{PackageConstant<T>(std::move(resultElements), *array,
895 ConstantSubscripts{
static_cast<ConstantSubscript
>(resultSize)})};
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;
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);
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());
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());
930 dimOrder = ValidateDimensionOrder(GetRank(*shape), *order);
932 context_.messages().Say(
933 "Invalid 'order=' argument (%s) in RESHAPE"_err_en_US,
934 DEREF(args[3]->UnwrapExpr()).AsFortran());
941 }
else if (!source || !shape || (args[2] && !pad) || (args[3] && !order)) {
942 return Expr<T>{std::move(funcRef)};
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);
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) {
961 copied += result.CopyFrom(
962 *pad, resultElements - copied, subscripts, dimOrderPtr);
964 CHECK(copied == resultElements);
965 return Expr<T>{std::move(result)};
969 return MakeInvalidIntrinsic(std::move(funcRef));
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)};
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,
990 }
else if (!ncopies) {
991 return Expr<T>{std::move(funcRef)};
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())};
1006 context_.messages().Say(
"Too many elements in SPREAD result"_err_en_US);
1008 std::vector<int> dimOrder;
1009 for (
int j{0}; j < sourceRank; ++j) {
1010 dimOrder.push_back(j < *dim - 1 ? j : j + 1);
1012 dimOrder.push_back(*dim - 1);
1013 ConstantSubscripts at{spread.lbounds()};
1014 spread.CopyFrom(*source, *n, at, &dimOrder);
1015 return Expr<T>{std::move(spread)};
1019 return MakeInvalidIntrinsic(std::move(funcRef));
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])};
1027 return Expr<T>{std::move(funcRef)};
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));
1039 at = matrix->shape();
1040 std::swap(at[0], at[1]);
1041 return Expr<T>{PackageConstant<T>(std::move(resultElements), *matrix, at)};
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)};
1057 if (field->Rank() > 0 && field->shape() != mask->shape()) {
1059 return MakeInvalidIntrinsic(std::move(funcRef));
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()) {
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));
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);
1085 resultElements.push_back(field->At(fieldAt));
1087 mask->IncrementSubscripts(maskAt);
1088 field->IncrementSubscripts(fieldAt);
1091 PackageConstant<T>(std::move(resultElements), *vector, mask->shape())};
1094std::optional<Expr<SomeType>> FoldTransfer(
1095 FoldingContext &,
const ActualArguments &);
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));
1101 return Expr<T>{std::move(funcRef)};
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);
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};
1142 Folder<T> folder{context,
false};
1143 if (!folder.Folding(args[0])) {
1144 allArgsConstant =
false;
1146 if (!folder.Folding(args[1])) {
1147 allArgsConstant =
false;
1152 Folder<T> folder{context,
true};
1153 for (std::size_t i{2}; i < nargs; ++i) {
1155 if (!folder.Folding(args[i])) {
1156 allArgsConstant =
false;
1164 if (allArgsConstant || extremumAnyway) {
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});
1175 return Expr<T>{std::move(funcRef)};
1183 return Expr<T>{std::move(funcRef)};
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))};
1200 std::optional<DynamicType> resultType;
1201 ActualArgument *resultTypeArg{
nullptr};
1202 for (
auto j{args.size()}; j-- > 0;) {
1204 DynamicType type{args[j]->GetType().value()};
1209 (type.category() == resultType->category() &&
1210 type.kind() > resultType->kind()) ||
1211 resultType->category() == TypeCategory::Integer) {
1213 resultTypeArg = &*args[j];
1218 return Expr<T>{std::move(funcRef)};
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))));
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);
1234 return Expr<T>{std::move(funcRef)};
1240Expr<Type<TypeCategory::Integer, KIND>> FoldIntrinsicFunction(
1241 FoldingContext &context, FunctionRef<Type<TypeCategory::Integer, KIND>> &&);
1243Expr<Type<TypeCategory::Unsigned, KIND>> FoldIntrinsicFunction(
1244 FoldingContext &context,
1245 FunctionRef<Type<TypeCategory::Unsigned, KIND>> &&);
1247Expr<Type<TypeCategory::Real, KIND>> FoldIntrinsicFunction(
1248 FoldingContext &context, FunctionRef<Type<TypeCategory::Real, KIND>> &&);
1250Expr<Type<TypeCategory::Complex, KIND>> FoldIntrinsicFunction(
1251 FoldingContext &context, FunctionRef<Type<TypeCategory::Complex, KIND>> &&);
1253Expr<Type<TypeCategory::Logical, KIND>> FoldIntrinsicFunction(
1254 FoldingContext &context, FunctionRef<Type<TypeCategory::Logical, KIND>> &&);
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") {
1263 for (std::optional<ActualArgument> &arg : args) {
1264 if (
auto *expr{UnwrapExpr<Expr<SomeType>>(arg)}) {
1265 *expr = Fold(context, std::move(*expr));
1270 const std::string name{intrinsic->name};
1271 if (name ==
"cshift") {
1272 return Folder<T>{context}.CSHIFT(std::move(funcRef));
1273 }
else if (name ==
"eoshift") {
1274 return Folder<T>{context}.EOSHIFT(std::move(funcRef));
1275 }
else if (name ==
"merge") {
1276 return Folder<T>{context}.MERGE(std::move(funcRef));
1277 }
else if (name ==
"pack") {
1278 return Folder<T>{context}.PACK(std::move(funcRef));
1279 }
else if (name ==
"reshape") {
1280 return Folder<T>{context}.RESHAPE(std::move(funcRef));
1281 }
else if (name ==
"spread") {
1282 return Folder<T>{context}.SPREAD(std::move(funcRef));
1283 }
else if (name ==
"transfer") {
1284 return Folder<T>{context}.TRANSFER(std::move(funcRef));
1285 }
else if (name ==
"transpose") {
1286 return Folder<T>{context}.TRANSPOSE(std::move(funcRef));
1287 }
else if (name ==
"unpack") {
1288 return Folder<T>{context}.UNPACK(std::move(funcRef));
1291 if constexpr (!std::is_same_v<T, SomeDerived>) {
1292 return FoldIntrinsicFunction(context, std::move(funcRef));
1295 return Expr<T>{std::move(funcRef)};
1298Expr<ImpliedDoIndex::Result> FoldOperation(FoldingContext &, ImpliedDoIndex &&);
1306 if constexpr (T::category == TypeCategory::Character) {
1307 if (
const auto *len{array.LEN()}) {
1308 charLength_ = ToInt64(Fold(context_, common::Clone(*len)));
1309 knownCharLength_ = charLength_.has_value();
1313 if (FoldArray(array)) {
1314 auto n{
static_cast<ConstantSubscript
>(elements_.size())};
1315 if constexpr (std::is_same_v<T, SomeDerived>) {
1317 std::move(elements_), ConstantSubscripts{n}}};
1318 }
else if constexpr (T::category == TypeCategory::Character) {
1321 *charLength_, std::move(elements_), ConstantSubscripts{n}}};
1325 std::move(elements_), ConstantSubscripts{n}, resultInfo_}};
1328 return Expr<T>{std::move(array)};
1332 bool FoldArray(
const Expr<T> &expr) {
1333 Expr<T> folded{Fold(context_, common::Clone(expr))};
1334 if (
const auto *c{UnwrapConstantValue<T>(folded)}) {
1337 ConstantSubscripts index{c->lbounds()};
1339 elements_.emplace_back(c->At(index));
1340 }
while (c->IncrementSubscripts(index));
1342 if constexpr (T::category == TypeCategory::Character) {
1343 if (!knownCharLength_) {
1344 charLength_ = std::max(c->LEN(), charLength_.value_or(-1));
1346 }
else if constexpr (T::category == TypeCategory::Real ||
1347 T::category == TypeCategory::Complex) {
1348 if (c->result().isFromInexactLiteralConversion()) {
1349 resultInfo_.set_isFromInexactLiteralConversion();
1358 return FoldArray(expr.value());
1367 std::optional<ConstantSubscript> start{ToInt64(lower)}, end{ToInt64(upper)},
1368 step{ToInt64(stride)};
1369 if (start && end && step && *step != 0) {
1371 ConstantSubscript &j{context_.StartImpliedDo(iDo.name(), *start)};
1373 for (; j <= *end; j += *step) {
1374 result &= FoldArray(iDo.values());
1377 for (; j >= *end; j += *step) {
1378 result &= FoldArray(iDo.values());
1381 context_.EndImpliedDo(iDo.name());
1388 return common::visit([&](
const auto &y) {
return FoldArray(y); }, x.u);
1391 for (
const auto &x : xs) {
1392 if (!FoldArray(x)) {
1400 std::vector<Scalar<T>> elements_;
1401 std::optional<ConstantSubscript> charLength_;
1402 bool knownCharLength_{
false};
1403 typename Constant<T>::Result resultInfo_;
1406template <
typename T>
1419template <
typename T>
1420bool ArrayConstructorIsFlat(
const ArrayConstructorValues<T> &values) {
1421 for (
const ArrayConstructorValue<T> &x : values) {
1422 if (!std::holds_alternative<Expr<T>>(x.u)) {
1429template <
typename T>
1430std::optional<Expr<T>> AsFlatArrayConstructor(
const Expr<T> &expr) {
1431 if (
const auto *c{UnwrapConstantValue<T>(expr)}) {
1432 ArrayConstructor<T> result{expr};
1434 ConstantSubscripts at{c->lbounds()};
1436 result.Push(Expr<T>{Constant<T>{c->At(at)}});
1437 }
while (c->IncrementSubscripts(at));
1439 return std::make_optional<Expr<T>>(std::move(result));
1440 }
else if (
const auto *a{UnwrapExpr<ArrayConstructor<T>>(expr)}) {
1441 if (ArrayConstructorIsFlat(*a)) {
1442 return std::make_optional<Expr<T>>(expr);
1444 }
else if (
const auto *p{UnwrapExpr<Parentheses<T>>(expr)}) {
1445 return AsFlatArrayConstructor(Expr<T>{p->left()});
1447 return std::nullopt;
1450template <TypeCategory CAT>
1451std::enable_if_t<CAT != TypeCategory::Derived,
1452 std::optional<Expr<SomeKind<CAT>>>>
1453AsFlatArrayConstructor(
const Expr<SomeKind<CAT>> &expr) {
1454 return common::visit(
1455 [&](
const auto &kindExpr) -> std::optional<Expr<SomeKind<CAT>>> {
1456 if (
auto flattened{AsFlatArrayConstructor(kindExpr)}) {
1457 return Expr<SomeKind<CAT>>{std::move(*flattened)};
1459 return std::nullopt;
1469template <
typename T>
1470std::optional<Expr<T>> FromArrayConstructor(
1471 FoldingContext &context, ArrayConstructor<T> &&values,
const Shape &shape) {
1472 if (
auto constShape{AsConstantExtents(context, shape)};
1473 constShape && !HasNegativeExtent(*constShape)) {
1474 Expr<T> result{Fold(context, Expr<T>{std::move(values)})};
1475 if (
auto *constant{UnwrapConstantValue<T>(result)}) {
1477 return Expr<T>{constant->Reshape(std::move(*constShape))};
1479 if (constShape->size() == 1) {
1480 if (
auto elements{GetShape(context, result)}) {
1481 if (
auto constElements{AsConstantExtents(context, *elements)}) {
1482 if (constElements->size() == 1 &&
1483 constElements->at(0) == constShape->at(0)) {
1486 return std::move(result);
1492 return std::nullopt;
1503template <
typename RESULT,
typename OPERAND>
1504std::optional<Expr<RESULT>> MapOperation(FoldingContext &context,
1505 std::function<Expr<RESULT>(Expr<OPERAND> &&)> &&f,
const Shape &shape,
1506 [[maybe_unused]] std::optional<Expr<SubscriptInteger>> &&length,
1507 Expr<OPERAND> &&values) {
1508 ArrayConstructor<RESULT> result{values};
1509 if constexpr (common::HasMember<OPERAND, AllIntrinsicCategoryTypes>) {
1511 [&](
auto &&kindExpr) {
1512 using kindType = ResultType<
decltype(kindExpr)>;
1513 auto &aConst{std::get<ArrayConstructor<kindType>>(kindExpr.u)};
1514 for (
auto &acValue : aConst) {
1515 auto &scalar{std::get<Expr<kindType>>(acValue.u)};
1516 result.Push(Fold(context, f(Expr<OPERAND>{std::move(scalar)})));
1519 std::move(values.u));
1521 auto &aConst{std::get<ArrayConstructor<OPERAND>>(values.u)};
1522 for (
auto &acValue : aConst) {
1523 auto &scalar{std::get<Expr<OPERAND>>(acValue.u)};
1524 result.Push(Fold(context, f(std::move(scalar))));
1527 if constexpr (RESULT::category == TypeCategory::Character) {
1529 result.set_LEN(std::move(*length));
1532 return FromArrayConstructor(context, std::move(result), shape);
1535template <
typename RESULT,
typename A>
1536ArrayConstructor<RESULT> ArrayConstructorFromMold(
1537 const A &prototype, std::optional<Expr<SubscriptInteger>> &&length) {
1538 ArrayConstructor<RESULT> result{prototype};
1539 if constexpr (RESULT::category == TypeCategory::Character) {
1541 result.set_LEN(std::move(*length));
1547template <
typename LEFT,
typename RIGHT>
1548bool ShapesMatch(FoldingContext &context,
1549 const ArrayConstructor<LEFT> &leftArrConst,
1550 const ArrayConstructor<RIGHT> &rightArrConst) {
1551 auto rightIter{rightArrConst.begin()};
1552 for (
auto &leftValue : leftArrConst) {
1553 CHECK(rightIter != rightArrConst.end());
1554 auto &leftExpr{std::get<Expr<LEFT>>(leftValue.u)};
1555 auto &rightExpr{std::get<Expr<RIGHT>>(rightIter->u)};
1556 if (leftExpr.Rank() != rightExpr.Rank()) {
1559 std::optional<Shape> leftShape{GetShape(context, leftExpr)};
1560 std::optional<Shape> rightShape{GetShape(context, rightExpr)};
1561 if (!leftShape || !rightShape || *leftShape != *rightShape) {
1570template <
typename RESULT,
typename LEFT,
typename RIGHT>
1571auto MapOperation(FoldingContext &context,
1572 std::function<Expr<RESULT>(Expr<LEFT> &&, Expr<RIGHT> &&)> &&f,
1573 const Shape &shape, std::optional<Expr<SubscriptInteger>> &&length,
1574 Expr<LEFT> &&leftValues, Expr<RIGHT> &&rightValues)
1575 -> std::optional<Expr<RESULT>> {
1576 auto result{ArrayConstructorFromMold<RESULT>(leftValues, std::move(length))};
1577 auto &leftArrConst{std::get<ArrayConstructor<LEFT>>(leftValues.u)};
1578 if constexpr (common::HasMember<RIGHT, AllIntrinsicCategoryTypes>) {
1579 bool mapped{common::visit(
1580 [&](
auto &&kindExpr) ->
bool {
1581 using kindType = ResultType<
decltype(kindExpr)>;
1583 auto &rightArrConst{std::get<ArrayConstructor<kindType>>(kindExpr.u)};
1584 if (!ShapesMatch(context, leftArrConst, rightArrConst)) {
1587 auto rightIter{rightArrConst.begin()};
1588 for (
auto &leftValue : leftArrConst) {
1589 CHECK(rightIter != rightArrConst.end());
1590 auto &leftScalar{std::get<Expr<LEFT>>(leftValue.u)};
1591 auto &rightScalar{std::get<Expr<kindType>>(rightIter->u)};
1592 result.Push(Fold(context,
1593 f(std::move(leftScalar), Expr<RIGHT>{std::move(rightScalar)})));
1598 std::move(rightValues.u))};
1600 return std::nullopt;
1603 auto &rightArrConst{std::get<ArrayConstructor<RIGHT>>(rightValues.u)};
1604 if (!ShapesMatch(context, leftArrConst, rightArrConst)) {
1605 return std::nullopt;
1607 auto rightIter{rightArrConst.begin()};
1608 for (
auto &leftValue : leftArrConst) {
1609 CHECK(rightIter != rightArrConst.end());
1610 auto &leftScalar{std::get<Expr<LEFT>>(leftValue.u)};
1611 auto &rightScalar{std::get<Expr<RIGHT>>(rightIter->u)};
1613 Fold(context, f(std::move(leftScalar), std::move(rightScalar))));
1617 return FromArrayConstructor(context, std::move(result), shape);
1621template <
typename RESULT,
typename LEFT,
typename RIGHT>
1622auto MapOperation(FoldingContext &context,
1623 std::function<Expr<RESULT>(Expr<LEFT> &&, Expr<RIGHT> &&)> &&f,
1624 const Shape &shape, std::optional<Expr<SubscriptInteger>> &&length,
1625 Expr<LEFT> &&leftValues,
const Expr<RIGHT> &rightScalar)
1626 -> std::optional<Expr<RESULT>> {
1627 auto result{ArrayConstructorFromMold<RESULT>(leftValues, std::move(length))};
1628 auto &leftArrConst{std::get<ArrayConstructor<LEFT>>(leftValues.u)};
1629 for (
auto &leftValue : leftArrConst) {
1630 auto &leftScalar{std::get<Expr<LEFT>>(leftValue.u)};
1632 Fold(context, f(std::move(leftScalar), Expr<RIGHT>{rightScalar})));
1634 return FromArrayConstructor(context, std::move(result), shape);
1638template <
typename RESULT,
typename LEFT,
typename RIGHT>
1639auto MapOperation(FoldingContext &context,
1640 std::function<Expr<RESULT>(Expr<LEFT> &&, Expr<RIGHT> &&)> &&f,
1641 const Shape &shape, std::optional<Expr<SubscriptInteger>> &&length,
1642 const Expr<LEFT> &leftScalar, Expr<RIGHT> &&rightValues)
1643 -> std::optional<Expr<RESULT>> {
1644 auto result{ArrayConstructorFromMold<RESULT>(leftScalar, std::move(length))};
1645 if constexpr (common::HasMember<RIGHT, AllIntrinsicCategoryTypes>) {
1647 [&](
auto &&kindExpr) {
1648 using kindType = ResultType<
decltype(kindExpr)>;
1649 auto &rightArrConst{std::get<ArrayConstructor<kindType>>(kindExpr.u)};
1650 for (
auto &rightValue : rightArrConst) {
1651 auto &rightScalar{std::get<Expr<kindType>>(rightValue.u)};
1652 result.Push(Fold(context,
1653 f(Expr<LEFT>{leftScalar},
1654 Expr<RIGHT>{std::move(rightScalar)})));
1657 std::move(rightValues.u));
1659 auto &rightArrConst{std::get<ArrayConstructor<RIGHT>>(rightValues.u)};
1660 for (
auto &rightValue : rightArrConst) {
1661 auto &rightScalar{std::get<Expr<RIGHT>>(rightValue.u)};
1663 Fold(context, f(Expr<LEFT>{leftScalar}, std::move(rightScalar))));
1666 return FromArrayConstructor(context, std::move(result), shape);
1669template <
typename DERIVED,
typename RESULT,
typename... OPD>
1670std::optional<Expr<SubscriptInteger>> ComputeResultLength(
1671 Operation<DERIVED, RESULT, OPD...> &operation) {
1672 if constexpr (RESULT::category == TypeCategory::Character) {
1673 return Expr<RESULT>{operation.derived()}.LEN();
1675 return std::nullopt;
1682template <
typename DERIVED,
typename RESULT,
typename OPERAND>
1683auto ApplyElementwise(FoldingContext &context,
1684 Operation<DERIVED, RESULT, OPERAND> &operation,
1685 std::function<Expr<RESULT>(Expr<OPERAND> &&)> &&f)
1686 -> std::optional<Expr<RESULT>> {
1687 auto &expr{operation.left()};
1688 expr = Fold(context, std::move(expr));
1689 if (expr.Rank() > 0) {
1690 if (std::optional<Shape> shape{GetShape(context, expr)}) {
1691 if (
auto values{AsFlatArrayConstructor(expr)}) {
1692 return MapOperation(context, std::move(f), *shape,
1693 ComputeResultLength(operation), std::move(*values));
1697 return std::nullopt;
1700template <
typename DERIVED,
typename RESULT,
typename OPERAND>
1701auto ApplyElementwise(
1702 FoldingContext &context, Operation<DERIVED, RESULT, OPERAND> &operation)
1703 -> std::optional<Expr<RESULT>> {
1704 return ApplyElementwise(context, operation,
1705 std::function<Expr<RESULT>(Expr<OPERAND> &&)>{
1706 [](Expr<OPERAND> &&operand) {
1707 return Expr<RESULT>{DERIVED{std::move(operand)}};
1711template <
typename DERIVED,
typename RESULT,
typename LEFT,
typename RIGHT>
1712auto ApplyElementwise(FoldingContext &context,
1713 Operation<DERIVED, RESULT, LEFT, RIGHT> &operation,
1714 std::function<Expr<RESULT>(Expr<LEFT> &&, Expr<RIGHT> &&)> &&f)
1715 -> std::optional<Expr<RESULT>> {
1716 auto resultLength{ComputeResultLength(operation)};
1717 auto &leftExpr{operation.left()};
1718 auto &rightExpr{operation.right()};
1719 if (leftExpr.Rank() != rightExpr.Rank() && leftExpr.Rank() != 0 &&
1720 rightExpr.Rank() != 0) {
1721 return std::nullopt;
1723 leftExpr = Fold(context, std::move(leftExpr));
1724 rightExpr = Fold(context, std::move(rightExpr));
1725 if (leftExpr.Rank() > 0) {
1726 if (std::optional<Shape> leftShape{GetShape(context, leftExpr)}) {
1727 if (
auto left{AsFlatArrayConstructor(leftExpr)}) {
1728 if (rightExpr.Rank() > 0) {
1729 if (std::optional<Shape> rightShape{GetShape(context, rightExpr)}) {
1730 if (
auto right{AsFlatArrayConstructor(rightExpr)}) {
1731 if (CheckConformance(context.messages(), *leftShape, *rightShape,
1732 CheckConformanceFlags::EitherScalarExpandable)
1733 .value_or(
false )) {
1734 return MapOperation(context, std::move(f), *leftShape,
1735 std::move(resultLength), std::move(*left),
1738 return std::nullopt;
1740 return MapOperation(context, std::move(f), *leftShape,
1741 std::move(resultLength), std::move(*left), std::move(*right));
1744 }
else if (IsExpandableScalar(rightExpr, context, *leftShape)) {
1745 return MapOperation(context, std::move(f), *leftShape,
1746 std::move(resultLength), std::move(*left), rightExpr);
1750 }
else if (rightExpr.Rank() > 0) {
1751 if (std::optional<Shape> rightShape{GetShape(context, rightExpr)}) {
1752 if (IsExpandableScalar(leftExpr, context, *rightShape)) {
1753 if (
auto right{AsFlatArrayConstructor(rightExpr)}) {
1754 return MapOperation(context, std::move(f), *rightShape,
1755 std::move(resultLength), leftExpr, std::move(*right));
1760 return std::nullopt;
1763template <
typename DERIVED,
typename RESULT,
typename LEFT,
typename RIGHT>
1764auto ApplyElementwise(
1765 FoldingContext &context, Operation<DERIVED, RESULT, LEFT, RIGHT> &operation)
1766 -> std::optional<Expr<RESULT>> {
1767 return ApplyElementwise(context, operation,
1768 std::function<Expr<RESULT>(Expr<LEFT> &&, Expr<RIGHT> &&)>{
1769 [](Expr<LEFT> &&left, Expr<RIGHT> &&right) {
1770 return Expr<RESULT>{DERIVED{std::move(left), std::move(right)}};
1776template <
typename TO,
typename FROM>
1777common::IfNoLvalue<std::optional<TO>, FROM> ConvertString(FROM &&s) {
1778 if constexpr (std::is_same_v<TO, FROM>) {
1779 return std::make_optional<TO>(std::move(s));
1784 for (
auto iter{s.cbegin()}; iter != s.cend(); ++iter) {
1785 if (
static_cast<std::uint64_t
>(*iter) > 127) {
1786 return std::nullopt;
1788 str.push_back(
static_cast<typename TO::value_type
>(*iter));
1790 return std::make_optional<TO>(std::move(str));
1794template <
typename TO, TypeCategory FROMCAT>
1795Expr<TO> FoldOperation(
1796 FoldingContext &context, Convert<TO, FROMCAT> &&convert) {
1797 if (
auto array{ApplyElementwise(context, convert)}) {
1801 FoldingContext &context;
1802 Convert<TO, FROMCAT> &convert;
1803 } msvcWorkaround{context, convert};
1804 return common::visit(
1805 [&msvcWorkaround](
auto &kindExpr) -> Expr<TO> {
1806 using Operand = ResultType<
decltype(kindExpr)>;
1809 TypeCategory
constexpr FromCat{FROMCAT};
1810 static_assert(FromCat == Operand::category);
1811 auto &convert{msvcWorkaround.convert};
1812 if (
auto value{GetScalarConstantValue<Operand>(kindExpr)}) {
1813 FoldingContext &ctx{msvcWorkaround.context};
1814 if constexpr (TO::category == TypeCategory::Integer) {
1815 if constexpr (FromCat == TypeCategory::Integer) {
1816 auto converted{Scalar<TO>::ConvertSigned(*value)};
1817 if (converted.overflow) {
1818 ctx.Warn(common::UsageWarning::FoldingException,
1819 "conversion of %s_%d to INTEGER(%d) overflowed; result is %s"_warn_en_US,
1820 value->SignedDecimal(), Operand::kind, TO::kind,
1821 converted.value.SignedDecimal());
1823 return ScalarConstantToExpr(std::move(converted.value));
1824 }
else if constexpr (FromCat == TypeCategory::Unsigned) {
1825 auto converted{Scalar<TO>::ConvertUnsigned(*value)};
1826 if ((converted.overflow || converted.value.IsNegative())) {
1827 ctx.Warn(common::UsageWarning::FoldingException,
1828 "conversion of %s_U%d to INTEGER(%d) overflowed; result is %s"_warn_en_US,
1829 value->UnsignedDecimal(), Operand::kind, TO::kind,
1830 converted.value.SignedDecimal());
1832 return ScalarConstantToExpr(std::move(converted.value));
1833 }
else if constexpr (FromCat == TypeCategory::Real) {
1834 auto converted{value->template ToInteger<Scalar<TO>>()};
1835 if (converted.flags.test(RealFlag::InvalidArgument)) {
1836 ctx.Warn(common::UsageWarning::FoldingException,
1837 "REAL(%d) to INTEGER(%d) conversion: invalid argument"_warn_en_US,
1838 Operand::kind, TO::kind);
1839 }
else if (converted.flags.test(RealFlag::Overflow)) {
1840 ctx.Warn(common::UsageWarning::FoldingException,
1841 "REAL(%d) to INTEGER(%d) conversion overflowed"_warn_en_US,
1842 Operand::kind, TO::kind);
1844 return ScalarConstantToExpr(std::move(converted.value));
1846 }
else if constexpr (TO::category == TypeCategory::Unsigned) {
1847 if constexpr (FromCat == TypeCategory::Integer ||
1848 FromCat == TypeCategory::Unsigned) {
1850 Constant<TO>{Scalar<TO>::ConvertUnsigned(*value).value}};
1851 }
else if constexpr (FromCat == TypeCategory::Real) {
1853 Constant<TO>{value->template ToInteger<Scalar<TO>>().value}};
1855 }
else if constexpr (TO::category == TypeCategory::Real) {
1856 if constexpr (FromCat == TypeCategory::Integer ||
1857 FromCat == TypeCategory::Unsigned) {
1858 auto converted{Scalar<TO>::FromInteger(
1859 *value, FromCat == TypeCategory::Unsigned)};
1860 if (!converted.flags.empty()) {
1862 std::snprintf(buffer,
sizeof buffer,
1863 "INTEGER(%d) to REAL(%d) conversion", Operand::kind,
1865 RealFlagWarnings(ctx, converted.flags, buffer);
1867 return ScalarConstantToExpr(std::move(converted.value));
1868 }
else if constexpr (FromCat == TypeCategory::Real) {
1869 auto converted{Scalar<TO>::Convert(*value)};
1871 if (!converted.flags.empty()) {
1872 std::snprintf(buffer,
sizeof buffer,
1873 "REAL(%d) to REAL(%d) conversion", Operand::kind, TO::kind);
1874 RealFlagWarnings(ctx, converted.flags, buffer);
1876 if (ctx.targetCharacteristics().areSubnormalsFlushedToZero()) {
1877 converted.value = converted.value.FlushSubnormalToZero();
1879 return ScalarConstantToExpr(std::move(converted.value));
1881 }
else if constexpr (TO::category == TypeCategory::Complex) {
1882 if constexpr (FromCat == TypeCategory::Complex) {
1883 return FoldOperation(ctx,
1884 ComplexConstructor<TO::kind>{
1885 AsExpr(Convert<typename TO::Part>{AsCategoryExpr(
1886 Constant<typename Operand::Part>{value->REAL()})}),
1887 AsExpr(Convert<typename TO::Part>{AsCategoryExpr(
1888 Constant<typename Operand::Part>{value->AIMAG()})})});
1890 }
else if constexpr (TO::category == TypeCategory::Character &&
1891 FromCat == TypeCategory::Character) {
1892 if (
auto converted{ConvertString<Scalar<TO>>(std::move(*value))}) {
1893 return ScalarConstantToExpr(std::move(*converted));
1895 }
else if constexpr (TO::category == TypeCategory::Logical &&
1896 FromCat == TypeCategory::Logical) {
1897 return Expr<TO>{value->IsTrue()};
1899 }
else if constexpr (TO::category == FromCat &&
1900 FromCat != TypeCategory::Character) {
1902 if constexpr (std::is_same_v<Operand, TO>) {
1903 return std::move(kindExpr);
1904 }
else if constexpr (TO::category == TypeCategory::Logical ||
1905 TO::category == TypeCategory::Integer) {
1906 if (
auto *innerConv{
1907 std::get_if<Convert<Operand, TO::category>>(&kindExpr.u)}) {
1909 if (
auto *x{std::get_if<Expr<TO>>(&innerConv->left().u)}) {
1910 if constexpr (TO::category == TypeCategory::Logical ||
1911 TO::kind <= Operand::kind) {
1912 return std::move(*x);
1914 }
else if constexpr (std::is_same_v<TO,
1915 DescriptorInquiry::Result>) {
1916 if (std::holds_alternative<DescriptorInquiry>(x->u) ||
1917 std::holds_alternative<TypeParamInquiry>(x->u)) {
1919 return std::move(*x);
1926 return Expr<TO>{std::move(convert)};
1931template <
typename T>
1932Expr<T> FoldOperation(FoldingContext &context, Parentheses<T> &&x) {
1933 auto &operand{x.left()};
1934 operand = Fold(context, std::move(operand));
1935 if (
auto value{GetScalarConstantValue<T>(operand)}) {
1937 return Expr<T>{Parentheses<T>{Expr<T>{Constant<T>{*value}}}};
1938 }
else if (std::holds_alternative<Parentheses<T>>(operand.u)) {
1940 return std::move(operand);
1942 return Expr<T>{Parentheses<T>{std::move(operand)}};
1946template <
typename T>
1947Expr<T> FoldOperation(FoldingContext &context, Negate<T> &&x) {
1948 if (
auto array{ApplyElementwise(context, x)}) {
1951 auto &operand{x.left()};
1952 if (
auto *nn{std::get_if<Negate<T>>(&x.left().u)}) {
1954 if (IsVariable(nn->left())) {
1955 return FoldOperation(context, Parentheses<T>{std::move(nn->left())});
1957 return std::move(nn->left());
1959 }
else if (
auto value{GetScalarConstantValue<T>(operand)}) {
1960 if constexpr (T::category == TypeCategory::Integer) {
1961 auto negated{value->Negate()};
1962 if (negated.overflow) {
1963 context.Warn(common::UsageWarning::FoldingException,
1964 "INTEGER(%d) negation overflowed"_warn_en_US, T::kind);
1966 return Expr<T>{Constant<T>{std::move(negated.value)}};
1967 }
else if constexpr (T::category == TypeCategory::Unsigned) {
1968 return Expr<T>{Constant<T>{std::move(value->Negate().value)}};
1971 return Expr<T>{Constant<T>{value->Negate()}};
1974 return Expr<T>{std::move(x)};
1979template <
typename LEFT,
typename RIGHT>
1980std::optional<std::pair<Scalar<LEFT>, Scalar<RIGHT>>> OperandsAreConstants(
1981 const Expr<LEFT> &x,
const Expr<RIGHT> &y) {
1982 if (
auto xvalue{GetScalarConstantValue<LEFT>(x)}) {
1983 if (
auto yvalue{GetScalarConstantValue<RIGHT>(y)}) {
1984 return {std::make_pair(*xvalue, *yvalue)};
1987 return std::nullopt;
1990template <
typename DERIVED,
typename RESULT,
typename LEFT,
typename RIGHT>
1991std::optional<std::pair<Scalar<LEFT>, Scalar<RIGHT>>> OperandsAreConstants(
1992 const Operation<DERIVED, RESULT, LEFT, RIGHT> &operation) {
1993 return OperandsAreConstants(operation.left(), operation.right());
1996template <
typename T>
1997Expr<T> FoldOperation(FoldingContext &context, Add<T> &&x) {
1998 if (
auto array{ApplyElementwise(context, x)}) {
2001 if (
auto folded{OperandsAreConstants(x)}) {
2002 if constexpr (T::category == TypeCategory::Integer) {
2003 auto sum{folded->first.AddSigned(folded->second)};
2005 context.Warn(common::UsageWarning::FoldingException,
2006 "INTEGER(%d) addition overflowed"_warn_en_US, T::kind);
2008 return Expr<T>{Constant<T>{sum.value}};
2009 }
else if constexpr (T::category == TypeCategory::Unsigned) {
2011 Constant<T>{folded->first.AddUnsigned(folded->second).value}};
2013 auto sum{folded->first.Add(
2014 folded->second, context.targetCharacteristics().roundingMode())};
2015 RealFlagWarnings(context, sum.flags,
"addition");
2016 if (context.targetCharacteristics().areSubnormalsFlushedToZero()) {
2017 sum.value = sum.value.FlushSubnormalToZero();
2019 return Expr<T>{Constant<T>{sum.value}};
2022 return Expr<T>{std::move(x)};
2025template <
typename T>
2026Expr<T> FoldOperation(FoldingContext &context, Subtract<T> &&x) {
2027 if (
auto array{ApplyElementwise(context, x)}) {
2030 if (
auto folded{OperandsAreConstants(x)}) {
2031 if constexpr (T::category == TypeCategory::Integer) {
2032 auto difference{folded->first.SubtractSigned(folded->second)};
2033 if (difference.overflow) {
2034 context.Warn(common::UsageWarning::FoldingException,
2035 "INTEGER(%d) subtraction overflowed"_warn_en_US, T::kind);
2037 return Expr<T>{Constant<T>{difference.value}};
2038 }
else if constexpr (T::category == TypeCategory::Unsigned) {
2040 Constant<T>{folded->first.SubtractSigned(folded->second).value}};
2042 auto difference{folded->first.Subtract(
2043 folded->second, context.targetCharacteristics().roundingMode())};
2044 RealFlagWarnings(context, difference.flags,
"subtraction");
2045 if (context.targetCharacteristics().areSubnormalsFlushedToZero()) {
2046 difference.value = difference.value.FlushSubnormalToZero();
2048 return Expr<T>{Constant<T>{difference.value}};
2051 return Expr<T>{std::move(x)};
2054template <
typename T>
2055Expr<T> FoldOperation(FoldingContext &context, Multiply<T> &&x) {
2056 if (
auto array{ApplyElementwise(context, x)}) {
2059 if (
auto folded{OperandsAreConstants(x)}) {
2060 if constexpr (T::category == TypeCategory::Integer) {
2061 auto product{folded->first.MultiplySigned(folded->second)};
2062 if (product.SignedMultiplicationOverflowed()) {
2063 context.Warn(common::UsageWarning::FoldingException,
2064 "INTEGER(%d) multiplication overflowed"_warn_en_US, T::kind);
2066 return Expr<T>{Constant<T>{product.lower}};
2067 }
else if constexpr (T::category == TypeCategory::Unsigned) {
2069 Constant<T>{folded->first.MultiplyUnsigned(folded->second).lower}};
2071 auto product{folded->first.Multiply(
2072 folded->second, context.targetCharacteristics().roundingMode())};
2073 RealFlagWarnings(context, product.flags,
"multiplication");
2074 if (context.targetCharacteristics().areSubnormalsFlushedToZero()) {
2075 product.value = product.value.FlushSubnormalToZero();
2077 return Expr<T>{Constant<T>{product.value}};
2079 }
else if constexpr (T::category == TypeCategory::Integer) {
2080 if (
auto c{GetScalarConstantValue<T>(x.right())}) {
2081 x.right() = std::move(x.left());
2082 x.left() = Expr<T>{std::move(*c)};
2084 if (
auto c{GetScalarConstantValue<T>(x.left())}) {
2085 if (c->IsZero() && x.right().Rank() == 0) {
2086 return std::move(x.left());
2087 }
else if (c->CompareSigned(Scalar<T>{1}) == Ordering::Equal) {
2088 if (IsVariable(x.right())) {
2089 return FoldOperation(context, Parentheses<T>{std::move(x.right())});
2091 return std::move(x.right());
2093 }
else if (c->CompareSigned(Scalar<T>{-1}) == Ordering::Equal) {
2094 return FoldOperation(context, Negate<T>{std::move(x.right())});
2098 return Expr<T>{std::move(x)};
2101template <
typename T>
2102Expr<T> FoldOperation(FoldingContext &context, Divide<T> &&x) {
2103 if (
auto array{ApplyElementwise(context, x)}) {
2106 if (
auto folded{OperandsAreConstants(x)}) {
2107 if constexpr (T::category == TypeCategory::Integer) {
2108 auto quotAndRem{folded->first.DivideSigned(folded->second)};
2109 if (quotAndRem.divisionByZero) {
2110 context.Warn(common::UsageWarning::FoldingException,
2111 "INTEGER(%d) division by zero"_warn_en_US, T::kind);
2112 return Expr<T>{std::move(x)};
2114 if (quotAndRem.overflow) {
2115 context.Warn(common::UsageWarning::FoldingException,
2116 "INTEGER(%d) division overflowed"_warn_en_US, T::kind);
2118 return Expr<T>{Constant<T>{quotAndRem.quotient}};
2119 }
else if constexpr (T::category == TypeCategory::Unsigned) {
2120 auto quotAndRem{folded->first.DivideUnsigned(folded->second)};
2121 if (quotAndRem.divisionByZero) {
2122 context.Warn(common::UsageWarning::FoldingException,
2123 "UNSIGNED(%d) division by zero"_warn_en_US, T::kind);
2124 return Expr<T>{std::move(x)};
2126 return Expr<T>{Constant<T>{quotAndRem.quotient}};
2128 auto quotient{folded->first.Divide(
2129 folded->second, context.targetCharacteristics().roundingMode())};
2133 bool isCanonicalNaNOrInf{
false};
2134 if constexpr (T::category == TypeCategory::Real) {
2135 if (folded->second.IsZero() && context.moduleFileName().has_value()) {
2136 using IntType =
typename T::Scalar::Word;
2137 auto intNumerator{folded->first.template ToInteger<IntType>()};
2138 isCanonicalNaNOrInf = intNumerator.flags == RealFlags{} &&
2139 intNumerator.value >= IntType{-1} &&
2140 intNumerator.value <= IntType{1};
2143 if (!isCanonicalNaNOrInf) {
2144 RealFlagWarnings(context, quotient.flags,
"division");
2146 if (context.targetCharacteristics().areSubnormalsFlushedToZero()) {
2147 quotient.value = quotient.value.FlushSubnormalToZero();
2149 return Expr<T>{Constant<T>{quotient.value}};
2152 return Expr<T>{std::move(x)};
2155template <
typename T>
2156Expr<T> FoldOperation(FoldingContext &context, Power<T> &&x) {
2157 if (
auto array{ApplyElementwise(context, x)}) {
2160 if (
auto folded{OperandsAreConstants(x)}) {
2161 if constexpr (T::category == TypeCategory::Integer) {
2162 auto power{folded->first.Power(folded->second)};
2163 if (power.divisionByZero) {
2164 context.Warn(common::UsageWarning::FoldingException,
2165 "INTEGER(%d) zero to negative power"_warn_en_US, T::kind);
2166 }
else if (power.overflow) {
2167 context.Warn(common::UsageWarning::FoldingException,
2168 "INTEGER(%d) power overflowed"_warn_en_US, T::kind);
2169 }
else if (power.zeroToZero) {
2170 context.Warn(common::UsageWarning::FoldingException,
2171 "INTEGER(%d) 0**0 is not defined"_warn_en_US, T::kind);
2173 return Expr<T>{Constant<T>{power.power}};
2175 if (folded->first.IsZero()) {
2176 if (folded->second.IsZero()) {
2177 context.Warn(common::UsageWarning::FoldingException,
2178 "REAL/COMPLEX 0**0 is not defined"_warn_en_US);
2180 return Expr<T>(Constant<T>{folded->first});
2182 }
else if (
auto callable{GetHostRuntimeWrapper<T, T, T>(
"pow")}) {
2184 Constant<T>{(*callable)(context, folded->first, folded->second)}};
2186 context.Warn(common::UsageWarning::FoldingFailure,
2187 "Power for %s cannot be folded on host"_warn_en_US,
2192 return Expr<T>{std::move(x)};
2195template <
typename T>
2196Expr<T> FoldOperation(FoldingContext &context, RealToIntPower<T> &&x) {
2197 if (
auto array{ApplyElementwise(context, x)}) {
2200 return common::visit(
2201 [&](
auto &y) -> Expr<T> {
2202 if (
auto folded{OperandsAreConstants(x.left(), y)}) {
2203 auto power{evaluate::IntPower(folded->first, folded->second)};
2204 RealFlagWarnings(context, power.flags,
"power with INTEGER exponent");
2205 if (context.targetCharacteristics().areSubnormalsFlushedToZero()) {
2206 power.value = power.value.FlushSubnormalToZero();
2208 return Expr<T>{Constant<T>{power.value}};
2210 return Expr<T>{std::move(x)};
2216template <
typename T>
2217Expr<T> FoldOperation(FoldingContext &context, Extremum<T> &&x) {
2218 if (
auto array{ApplyElementwise(context, x,
2219 std::function<Expr<T>(Expr<T> &&, Expr<T> &&)>{[=](Expr<T> &&l,
2221 return Expr<T>{Extremum<T>{x.ordering, std::move(l), std::move(r)}};
2225 if (
auto folded{OperandsAreConstants(x)}) {
2226 if constexpr (T::category == TypeCategory::Integer) {
2227 if (folded->first.CompareSigned(folded->second) == x.ordering) {
2228 return Expr<T>{Constant<T>{folded->first}};
2230 }
else if constexpr (T::category == TypeCategory::Unsigned) {
2231 if (folded->first.CompareUnsigned(folded->second) == x.ordering) {
2232 return Expr<T>{Constant<T>{folded->first}};
2234 }
else if constexpr (T::category == TypeCategory::Real) {
2235 if (folded->first.IsNotANumber() ||
2236 (folded->first.Compare(folded->second) == Relation::Less) ==
2237 (x.ordering == Ordering::Less)) {
2238 return Expr<T>{Constant<T>{folded->first}};
2241 static_assert(T::category == TypeCategory::Character);
2244 auto maxLen{std::max(folded->first.length(), folded->second.length())};
2245 bool isFirst{x.ordering == Compare(folded->first, folded->second)};
2246 auto res{isFirst ? std::move(folded->first) : std::move(folded->second)};
2247 res = res.length() == maxLen
2249 : CharacterUtils<T::kind>::Resize(res, maxLen);
2250 return Expr<T>{Constant<T>{std::move(res)}};
2252 return Expr<T>{Constant<T>{folded->second}};
2254 return Expr<T>{std::move(x)};
2258Expr<Type<TypeCategory::Real, KIND>> ToReal(
2259 FoldingContext &context, Expr<SomeType> &&expr) {
2260 using Result = Type<TypeCategory::Real, KIND>;
2261 std::optional<Expr<Result>> result;
2264 using From = std::decay_t<
decltype(x)>;
2265 if constexpr (std::is_same_v<From, BOZLiteralConstant>) {
2268 result = ConvertToType<Result>(std::move(x));
2269 const auto *constant{UnwrapExpr<Constant<Result>>(*result)};
2271 Scalar<Result> real{constant->GetScalarValue().value()};
2272 From converted{From::ConvertUnsigned(real.RawBits()).value};
2273 if (original != converted) {
2274 context.Warn(common::UsageWarning::FoldingValueChecks,
2275 "Nonzero bits truncated from BOZ literal constant in REAL intrinsic"_warn_en_US);
2277 }
else if constexpr (IsNumericCategoryExpr<From>()) {
2278 result = Fold(context, ConvertToType<Result>(std::move(x)));
2280 common::die(
"ToReal: bad argument expression");
2284 return result.value();
2289Expr<Type<TypeCategory::Real, KIND>> FoldOperation(
2290 FoldingContext &context, ComplexComponent<KIND> &&x) {
2291 using Operand = Type<TypeCategory::Complex, KIND>;
2292 using Result = Type<TypeCategory::Real, KIND>;
2293 if (
auto array{ApplyElementwise(context, x,
2294 std::function<Expr<Result>(Expr<Operand> &&)>{
2295 [=](Expr<Operand> &&operand) {
2296 return Expr<Result>{ComplexComponent<KIND>{
2297 x.isImaginaryPart, std::move(operand)}};
2301 auto &operand{x.left()};
2302 if (
auto value{GetScalarConstantValue<Operand>(operand)}) {
2303 if (x.isImaginaryPart) {
2304 return Expr<Result>{Constant<Result>{value->AIMAG()}};
2306 return Expr<Result>{Constant<Result>{value->REAL()}};
2309 return Expr<Result>{std::move(x)};
2312template <
typename T>
2313Expr<T> ExpressionBase<T>::Rewrite(FoldingContext &context, Expr<T> &&expr) {
2314 return common::visit(
2315 [&](
auto &&x) -> Expr<T> {
2316 if constexpr (IsSpecificIntrinsicType<T>) {
2317 return FoldOperation(context, std::move(x));
2318 }
else if constexpr (std::is_same_v<T, SomeDerived>) {
2319 return FoldOperation(context, std::move(x));
2320 }
else if constexpr (common::HasMember<
decltype(x),
2321 TypelessExpression>) {
2322 return std::move(expr);
2324 return Expr<T>{Fold(context, std::move(x))};
2330FOR_EACH_TYPE_AND_KIND(
extern template class ExpressionBase, )
Definition: indirection.h:72
Definition: fold-implementation.h:1301
Definition: expression.h:438
Definition: expression.h:466
Definition: variable.h:205
Definition: variable.h:73
Definition: constant.h:147
Definition: variable.h:377
Definition: fold-implementation.h:55
Definition: expression.h:404
Definition: variable.h:101
Definition: expression.h:432
Definition: variable.h:284
Definition: variable.h:191