1 /* Implementation of the MAXLOC intrinsic
2 Copyright (C) 2017-2021 Free Software Foundation, Inc.
3 Contributed by Thomas Koenig
5 This file is part of the GNU Fortran runtime library (libgfortran).
7 Libgfortran is free software; you can redistribute it and/or
8 modify it under the terms of the GNU General Public
9 License as published by the Free Software Foundation; either
10 version 3 of the License, or (at your option) any later version.
12 Libgfortran is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 Under Section 7 of GPL version 3, you are granted additional
18 permissions described in the GCC Runtime Library Exception, version
19 3.1, as published by the Free Software Foundation.
21 You should have received a copy of the GNU General Public License and
22 a copy of the GCC Runtime Library Exception along with this program;
23 see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
24 <http://www.gnu.org/licenses/>. */
26 #include "libgfortran.h"
29 #if defined (HAVE_GFC_UINTEGER_4) && defined (HAVE_GFC_INTEGER_4)
31 #define HAVE_BACK_ARG 1
37 compare_fcn (const GFC_UINTEGER_4
*a
, const GFC_UINTEGER_4
*b
, gfc_charlen_type n
)
39 if (sizeof (GFC_UINTEGER_4
) == 1)
40 return memcmp (a
, b
, n
);
42 return memcmp_char4 (a
, b
, n
);
45 extern void maxloc1_4_s4 (gfc_array_i4
* const restrict
,
46 gfc_array_s4
* const restrict
, const index_type
* const restrict
, GFC_LOGICAL_4 back
,
48 export_proto(maxloc1_4_s4
);
51 maxloc1_4_s4 (gfc_array_i4
* const restrict retarray
,
52 gfc_array_s4
* const restrict array
,
53 const index_type
* const restrict pdim
, GFC_LOGICAL_4 back
,
54 gfc_charlen_type string_len
)
56 index_type count
[GFC_MAX_DIMENSIONS
];
57 index_type extent
[GFC_MAX_DIMENSIONS
];
58 index_type sstride
[GFC_MAX_DIMENSIONS
];
59 index_type dstride
[GFC_MAX_DIMENSIONS
];
60 const GFC_UINTEGER_4
* restrict base
;
61 GFC_INTEGER_4
* restrict dest
;
69 /* Make dim zero based to avoid confusion. */
70 rank
= GFC_DESCRIPTOR_RANK (array
) - 1;
73 if (unlikely (dim
< 0 || dim
> rank
))
75 runtime_error ("Dim argument incorrect in MAXLOC intrinsic: "
76 "is %ld, should be between 1 and %ld",
77 (long int) dim
+ 1, (long int) rank
+ 1);
80 len
= GFC_DESCRIPTOR_EXTENT(array
,dim
);
83 delta
= GFC_DESCRIPTOR_STRIDE(array
,dim
) * string_len
;
85 for (n
= 0; n
< dim
; n
++)
87 sstride
[n
] = GFC_DESCRIPTOR_STRIDE(array
,n
) * string_len
;
88 extent
[n
] = GFC_DESCRIPTOR_EXTENT(array
,n
);
93 for (n
= dim
; n
< rank
; n
++)
95 sstride
[n
] = GFC_DESCRIPTOR_STRIDE(array
, n
+ 1) * string_len
;
96 extent
[n
] = GFC_DESCRIPTOR_EXTENT(array
, n
+ 1);
102 if (retarray
->base_addr
== NULL
)
104 size_t alloc_size
, str
;
106 for (n
= 0; n
< rank
; n
++)
111 str
= GFC_DESCRIPTOR_STRIDE(retarray
,n
-1) * extent
[n
-1];
113 GFC_DIMENSION_SET(retarray
->dim
[n
], 0, extent
[n
] - 1, str
);
117 retarray
->offset
= 0;
118 retarray
->dtype
.rank
= rank
;
120 alloc_size
= GFC_DESCRIPTOR_STRIDE(retarray
,rank
-1) * extent
[rank
-1];
122 retarray
->base_addr
= xmallocarray (alloc_size
, sizeof (GFC_INTEGER_4
));
125 /* Make sure we have a zero-sized array. */
126 GFC_DIMENSION_SET(retarray
->dim
[0], 0, -1, 1);
133 if (rank
!= GFC_DESCRIPTOR_RANK (retarray
))
134 runtime_error ("rank of return array incorrect in"
135 " MAXLOC intrinsic: is %ld, should be %ld",
136 (long int) (GFC_DESCRIPTOR_RANK (retarray
)),
139 if (unlikely (compile_options
.bounds_check
))
140 bounds_ifunction_return ((array_t
*) retarray
, extent
,
141 "return value", "MAXLOC");
144 for (n
= 0; n
< rank
; n
++)
147 dstride
[n
] = GFC_DESCRIPTOR_STRIDE(retarray
,n
);
152 base
= array
->base_addr
;
153 dest
= retarray
->base_addr
;
156 while (continue_loop
)
158 const GFC_UINTEGER_4
* restrict src
;
159 GFC_INTEGER_4 result
;
163 const GFC_UINTEGER_4
*maxval
;
170 for (n
= 0; n
< len
; n
++, src
+= delta
)
173 if (maxval
== NULL
|| (back
? compare_fcn (src
, maxval
, string_len
) >= 0 :
174 compare_fcn (src
, maxval
, string_len
) > 0))
177 result
= (GFC_INTEGER_4
)n
+ 1;
184 /* Advance to the next element. */
189 while (count
[n
] == extent
[n
])
191 /* When we get to the end of a dimension, reset it and increment
192 the next dimension. */
194 /* We could precalculate these products, but this is a less
195 frequently used path so probably not worth it. */
196 base
-= sstride
[n
] * extent
[n
];
197 dest
-= dstride
[n
] * extent
[n
];
201 /* Break out of the loop. */
216 extern void mmaxloc1_4_s4 (gfc_array_i4
* const restrict
,
217 gfc_array_s4
* const restrict
, const index_type
* const restrict
,
218 gfc_array_l1
* const restrict
, GFC_LOGICAL_4 back
, gfc_charlen_type
);
219 export_proto(mmaxloc1_4_s4
);
222 mmaxloc1_4_s4 (gfc_array_i4
* const restrict retarray
,
223 gfc_array_s4
* const restrict array
,
224 const index_type
* const restrict pdim
,
225 gfc_array_l1
* const restrict mask
, GFC_LOGICAL_4 back
,
226 gfc_charlen_type string_len
)
228 index_type count
[GFC_MAX_DIMENSIONS
];
229 index_type extent
[GFC_MAX_DIMENSIONS
];
230 index_type sstride
[GFC_MAX_DIMENSIONS
];
231 index_type dstride
[GFC_MAX_DIMENSIONS
];
232 index_type mstride
[GFC_MAX_DIMENSIONS
];
233 GFC_INTEGER_4
* restrict dest
;
234 const GFC_UINTEGER_4
* restrict base
;
235 const GFC_LOGICAL_1
* restrict mbase
;
247 maxloc1_4_s4 (retarray
, array
, pdim
, back
, string_len
);
249 maxloc1_4_s4 (retarray
, array
, pdim
, string_len
);
255 rank
= GFC_DESCRIPTOR_RANK (array
) - 1;
258 if (unlikely (dim
< 0 || dim
> rank
))
260 runtime_error ("Dim argument incorrect in MAXLOC intrinsic: "
261 "is %ld, should be between 1 and %ld",
262 (long int) dim
+ 1, (long int) rank
+ 1);
265 len
= GFC_DESCRIPTOR_EXTENT(array
,dim
);
269 mbase
= mask
->base_addr
;
271 mask_kind
= GFC_DESCRIPTOR_SIZE (mask
);
273 if (mask_kind
== 1 || mask_kind
== 2 || mask_kind
== 4 || mask_kind
== 8
274 #ifdef HAVE_GFC_LOGICAL_16
278 mbase
= GFOR_POINTER_TO_L1 (mbase
, mask_kind
);
280 runtime_error ("Funny sized logical array");
282 delta
= GFC_DESCRIPTOR_STRIDE(array
,dim
) * string_len
;
283 mdelta
= GFC_DESCRIPTOR_STRIDE_BYTES(mask
,dim
);
285 for (n
= 0; n
< dim
; n
++)
287 sstride
[n
] = GFC_DESCRIPTOR_STRIDE(array
,n
) * string_len
;
288 mstride
[n
] = GFC_DESCRIPTOR_STRIDE_BYTES(mask
,n
);
289 extent
[n
] = GFC_DESCRIPTOR_EXTENT(array
,n
);
295 for (n
= dim
; n
< rank
; n
++)
297 sstride
[n
] = GFC_DESCRIPTOR_STRIDE(array
,n
+ 1) * string_len
;
298 mstride
[n
] = GFC_DESCRIPTOR_STRIDE_BYTES(mask
, n
+ 1);
299 extent
[n
] = GFC_DESCRIPTOR_EXTENT(array
, n
+ 1);
305 if (retarray
->base_addr
== NULL
)
307 size_t alloc_size
, str
;
309 for (n
= 0; n
< rank
; n
++)
314 str
= GFC_DESCRIPTOR_STRIDE(retarray
,n
-1) * extent
[n
-1];
316 GFC_DIMENSION_SET(retarray
->dim
[n
], 0, extent
[n
] - 1, str
);
320 alloc_size
= GFC_DESCRIPTOR_STRIDE(retarray
,rank
-1) * extent
[rank
-1];
322 retarray
->offset
= 0;
323 retarray
->dtype
.rank
= rank
;
327 /* Make sure we have a zero-sized array. */
328 GFC_DIMENSION_SET(retarray
->dim
[0], 0, -1, 1);
332 retarray
->base_addr
= xmallocarray (alloc_size
, sizeof (GFC_INTEGER_4
));
337 if (rank
!= GFC_DESCRIPTOR_RANK (retarray
))
338 runtime_error ("rank of return array incorrect in MAXLOC intrinsic");
340 if (unlikely (compile_options
.bounds_check
))
342 bounds_ifunction_return ((array_t
*) retarray
, extent
,
343 "return value", "MAXLOC");
344 bounds_equal_extents ((array_t
*) mask
, (array_t
*) array
,
345 "MASK argument", "MAXLOC");
349 for (n
= 0; n
< rank
; n
++)
352 dstride
[n
] = GFC_DESCRIPTOR_STRIDE(retarray
,n
);
357 dest
= retarray
->base_addr
;
358 base
= array
->base_addr
;
362 const GFC_UINTEGER_4
* restrict src
;
363 const GFC_LOGICAL_1
* restrict msrc
;
364 GFC_INTEGER_4 result
;
369 const GFC_UINTEGER_4
*maxval
;
372 for (n
= 0; n
< len
; n
++, src
+= delta
, msrc
+= mdelta
)
378 result
= (GFC_INTEGER_4
)n
+ 1;
382 for (; n
< len
; n
++, src
+= delta
, msrc
+= mdelta
)
384 if (*msrc
&& (back
? compare_fcn (src
, maxval
, string_len
) >= 0 :
385 compare_fcn (src
, maxval
, string_len
) > 0))
388 result
= (GFC_INTEGER_4
)n
+ 1;
394 /* Advance to the next element. */
400 while (count
[n
] == extent
[n
])
402 /* When we get to the end of a dimension, reset it and increment
403 the next dimension. */
405 /* We could precalculate these products, but this is a less
406 frequently used path so probably not worth it. */
407 base
-= sstride
[n
] * extent
[n
];
408 mbase
-= mstride
[n
] * extent
[n
];
409 dest
-= dstride
[n
] * extent
[n
];
413 /* Break out of the loop. */
429 extern void smaxloc1_4_s4 (gfc_array_i4
* const restrict
,
430 gfc_array_s4
* const restrict
, const index_type
* const restrict
,
431 GFC_LOGICAL_4
*, GFC_LOGICAL_4 back
, gfc_charlen_type
);
432 export_proto(smaxloc1_4_s4
);
435 smaxloc1_4_s4 (gfc_array_i4
* const restrict retarray
,
436 gfc_array_s4
* const restrict array
,
437 const index_type
* const restrict pdim
,
438 GFC_LOGICAL_4
* mask
, GFC_LOGICAL_4 back
, gfc_charlen_type string_len
)
440 index_type count
[GFC_MAX_DIMENSIONS
];
441 index_type extent
[GFC_MAX_DIMENSIONS
];
442 index_type dstride
[GFC_MAX_DIMENSIONS
];
443 GFC_INTEGER_4
* restrict dest
;
449 if (mask
== NULL
|| *mask
)
452 maxloc1_4_s4 (retarray
, array
, pdim
, back
, string_len
);
454 maxloc1_4_s4 (retarray
, array
, pdim
, string_len
);
458 /* Make dim zero based to avoid confusion. */
460 rank
= GFC_DESCRIPTOR_RANK (array
) - 1;
462 if (unlikely (dim
< 0 || dim
> rank
))
464 runtime_error ("Dim argument incorrect in MAXLOC intrinsic: "
465 "is %ld, should be between 1 and %ld",
466 (long int) dim
+ 1, (long int) rank
+ 1);
469 for (n
= 0; n
< dim
; n
++)
471 extent
[n
] = GFC_DESCRIPTOR_EXTENT(array
,n
) * string_len
;
477 for (n
= dim
; n
< rank
; n
++)
480 GFC_DESCRIPTOR_EXTENT(array
,n
+ 1) * string_len
;
486 if (retarray
->base_addr
== NULL
)
488 size_t alloc_size
, str
;
490 for (n
= 0; n
< rank
; n
++)
495 str
= GFC_DESCRIPTOR_STRIDE(retarray
,n
-1) * extent
[n
-1];
497 GFC_DIMENSION_SET(retarray
->dim
[n
], 0, extent
[n
] - 1, str
);
501 retarray
->offset
= 0;
502 retarray
->dtype
.rank
= rank
;
504 alloc_size
= GFC_DESCRIPTOR_STRIDE(retarray
,rank
-1) * extent
[rank
-1];
508 /* Make sure we have a zero-sized array. */
509 GFC_DIMENSION_SET(retarray
->dim
[0], 0, -1, 1);
513 retarray
->base_addr
= xmallocarray (alloc_size
, sizeof (GFC_INTEGER_4
));
517 if (rank
!= GFC_DESCRIPTOR_RANK (retarray
))
518 runtime_error ("rank of return array incorrect in"
519 " MAXLOC intrinsic: is %ld, should be %ld",
520 (long int) (GFC_DESCRIPTOR_RANK (retarray
)),
523 if (unlikely (compile_options
.bounds_check
))
525 for (n
=0; n
< rank
; n
++)
527 index_type ret_extent
;
529 ret_extent
= GFC_DESCRIPTOR_EXTENT(retarray
,n
);
530 if (extent
[n
] != ret_extent
)
531 runtime_error ("Incorrect extent in return value of"
532 " MAXLOC intrinsic in dimension %ld:"
533 " is %ld, should be %ld", (long int) n
+ 1,
534 (long int) ret_extent
, (long int) extent
[n
]);
539 for (n
= 0; n
< rank
; n
++)
542 dstride
[n
] = GFC_DESCRIPTOR_STRIDE(retarray
,n
);
545 dest
= retarray
->base_addr
;
553 while (count
[n
] == extent
[n
])
555 /* When we get to the end of a dimension, reset it and increment
556 the next dimension. */
558 /* We could precalculate these products, but this is a less
559 frequently used path so probably not worth it. */
560 dest
-= dstride
[n
] * extent
[n
];