1 /* Generic implementation of the PACK intrinsic
2 Copyright (C) 2002, 2004, 2005, 2006, 2007, 2009 Free Software Foundation, Inc.
3 Contributed by Paul Brook <paul@nowt.org>
5 This file is part of the GNU Fortran 95 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 Ligbfortran 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"
31 /* PACK is specified as follows:
33 13.14.80 PACK (ARRAY, MASK, [VECTOR])
35 Description: Pack an array into an array of rank one under the
38 Class: Transformational function.
41 ARRAY may be of any type. It shall not be scalar.
42 MASK shall be of type LOGICAL. It shall be conformable with ARRAY.
43 VECTOR (optional) shall be of the same type and type parameters
44 as ARRAY. VECTOR shall have at least as many elements as
45 there are true elements in MASK. If MASK is a scalar
46 with the value true, VECTOR shall have at least as many
47 elements as there are in ARRAY.
49 Result Characteristics: The result is an array of rank one with the
50 same type and type parameters as ARRAY. If VECTOR is present, the
51 result size is that of VECTOR; otherwise, the result size is the
52 number /t/ of true elements in MASK unless MASK is scalar with the
53 value true, in which case the result size is the size of ARRAY.
55 Result Value: Element /i/ of the result is the element of ARRAY
56 that corresponds to the /i/th true element of MASK, taking elements
57 in array element order, for /i/ = 1, 2, ..., /t/. If VECTOR is
58 present and has size /n/ > /t/, element /i/ of the result has the
59 value VECTOR(/i/), for /i/ = /t/ + 1, ..., /n/.
61 Examples: The nonzero elements of an array M with the value
63 | 9 0 0 | may be "gathered" by the function PACK. The result of
65 PACK (M, MASK = M.NE.0) is [9,7] and the result of PACK (M, M.NE.0,
66 VECTOR = (/ 2,4,6,8,10,12 /)) is [9,7,6,8,10,12].
68 There are two variants of the PACK intrinsic: one, where MASK is
69 array valued, and the other one where MASK is scalar. */
72 pack_internal (gfc_array_char *ret, const gfc_array_char *array,
73 const gfc_array_l1 *mask, const gfc_array_char *vector,
76 /* r.* indicates the return array. */
79 /* s.* indicates the source array. */
80 index_type sstride[GFC_MAX_DIMENSIONS];
83 /* m.* indicates the mask array. */
84 index_type mstride[GFC_MAX_DIMENSIONS];
86 const GFC_LOGICAL_1 *mptr;
88 index_type count[GFC_MAX_DIMENSIONS];
89 index_type extent[GFC_MAX_DIMENSIONS];
97 dim = GFC_DESCRIPTOR_RANK (array);
102 /* Use the same loop for all logical types, by using GFC_LOGICAL_1
103 and using shifting to address size and endian issues. */
105 mask_kind = GFC_DESCRIPTOR_SIZE (mask);
107 if (mask_kind == 1 || mask_kind == 2 || mask_kind == 4 || mask_kind == 8
108 #ifdef HAVE_GFC_LOGICAL_16
113 /* Don't convert a NULL pointer as we use test for NULL below. */
115 mptr = GFOR_POINTER_TO_L1 (mptr, mask_kind);
118 runtime_error ("Funny sized logical array");
121 for (n = 0; n < dim; n++)
124 extent[n] = GFC_DESCRIPTOR_EXTENT(array,n);
127 sstride[n] = GFC_DESCRIPTOR_STRIDE_BYTES(array,n);
128 mstride[n] = GFC_DESCRIPTOR_STRIDE_BYTES(mask,n);
133 mstride[0] = mask_kind;
135 if (ret->data == NULL || compile_options.bounds_check)
137 /* Count the elements, either for allocating memory or
138 for bounds checking. */
142 /* The return array will have as many
143 elements as there are in VECTOR. */
144 total = GFC_DESCRIPTOR_EXTENT(vector,0);
148 /* We have to count the true elements in MASK. */
150 /* TODO: We could speed up pack easily in the case of only
151 few .TRUE. entries in MASK, by keeping track of where we
152 would be in the source array during the initial traversal
153 of MASK, and caching the pointers to those elements. Then,
154 supposed the number of elements is small enough, we would
155 only have to traverse the list, and copy those elements
156 into the result array. In the case of datatypes which fit
157 in one of the integer types we could also cache the
158 value instead of a pointer to it.
159 This approach might be bad from the point of view of
160 cache behavior in the case where our cache is not big
161 enough to hold all elements that have to be copied. */
163 const GFC_LOGICAL_1 *m = mptr;
171 /* Test this element. */
175 /* Advance to the next element. */
179 while (count[n] == extent[n])
181 /* When we get to the end of a dimension, reset it
182 and increment the next dimension. */
184 /* We could precalculate this product, but this is a
185 less frequently used path so probably not worth
187 m -= mstride[n] * extent[n];
191 /* Break out of the loop. */
204 if (ret->data == NULL)
206 /* Setup the array descriptor. */
207 GFC_DIMENSION_SET(ret->dim[0], 0, total-1, 1);
212 /* In this case, nothing remains to be done. */
213 ret->data = internal_malloc_size (1);
217 ret->data = internal_malloc_size (size * total);
221 /* We come here because of range checking. */
222 index_type ret_extent;
224 ret_extent = GFC_DESCRIPTOR_EXTENT(ret,0);
225 if (total != ret_extent)
226 runtime_error ("Incorrect extent in return value of PACK intrinsic;"
227 " is %ld, should be %ld", (long int) total,
228 (long int) ret_extent);
232 rstride0 = GFC_DESCRIPTOR_STRIDE_BYTES(ret,0);
235 sstride0 = sstride[0];
236 mstride0 = mstride[0];
241 /* Test this element. */
245 memcpy (rptr, sptr, size);
248 /* Advance to the next element. */
253 while (count[n] == extent[n])
255 /* When we get to the end of a dimension, reset it and increment
256 the next dimension. */
258 /* We could precalculate these products, but this is a less
259 frequently used path so probably not worth it. */
260 sptr -= sstride[n] * extent[n];
261 mptr -= mstride[n] * extent[n];
265 /* Break out of the loop. */
278 /* Add any remaining elements from VECTOR. */
281 n = GFC_DESCRIPTOR_EXTENT(vector,0);
282 nelem = ((rptr - ret->data) / rstride0);
285 sstride0 = GFC_DESCRIPTOR_STRIDE_BYTES(vector,0);
289 sptr = vector->data + sstride0 * nelem;
293 memcpy (rptr, sptr, size);
301 extern void pack (gfc_array_char *, const gfc_array_char *,
302 const gfc_array_l1 *, const gfc_array_char *);
306 pack (gfc_array_char *ret, const gfc_array_char *array,
307 const gfc_array_l1 *mask, const gfc_array_char *vector)
309 index_type type_size;
312 type_size = GFC_DTYPE_TYPE_SIZE(array);
316 case GFC_DTYPE_LOGICAL_1:
317 case GFC_DTYPE_INTEGER_1:
318 case GFC_DTYPE_DERIVED_1:
319 pack_i1 ((gfc_array_i1 *) ret, (gfc_array_i1 *) array,
320 (gfc_array_l1 *) mask, (gfc_array_i1 *) vector);
323 case GFC_DTYPE_LOGICAL_2:
324 case GFC_DTYPE_INTEGER_2:
325 pack_i2 ((gfc_array_i2 *) ret, (gfc_array_i2 *) array,
326 (gfc_array_l1 *) mask, (gfc_array_i2 *) vector);
329 case GFC_DTYPE_LOGICAL_4:
330 case GFC_DTYPE_INTEGER_4:
332 pack_i4 ((gfc_array_i4 *) ret, (gfc_array_i4 *) array,
333 (gfc_array_l1 *) mask, (gfc_array_i4 *) vector);
336 case GFC_DTYPE_LOGICAL_8:
337 case GFC_DTYPE_INTEGER_8:
339 pack_i8 ((gfc_array_i8 *) ret, (gfc_array_i8 *) array,
340 (gfc_array_l1 *) mask, (gfc_array_i8 *) vector);
343 #ifdef HAVE_GFC_INTEGER_16
344 case GFC_DTYPE_LOGICAL_16:
345 case GFC_DTYPE_INTEGER_16:
347 pack_i16 ((gfc_array_i16 *) ret, (gfc_array_i16 *) array,
348 (gfc_array_l1 *) mask, (gfc_array_i16 *) vector);
351 case GFC_DTYPE_REAL_4:
352 pack_r4 ((gfc_array_r4 *) ret, (gfc_array_r4 *) array,
353 (gfc_array_l1 *) mask, (gfc_array_r4 *) vector);
356 case GFC_DTYPE_REAL_8:
357 pack_r8 ((gfc_array_r8 *) ret, (gfc_array_r8 *) array,
358 (gfc_array_l1 *) mask, (gfc_array_r8 *) vector);
361 #ifdef HAVE_GFC_REAL_10
362 case GFC_DTYPE_REAL_10:
363 pack_r10 ((gfc_array_r10 *) ret, (gfc_array_r10 *) array,
364 (gfc_array_l1 *) mask, (gfc_array_r10 *) vector);
368 #ifdef HAVE_GFC_REAL_16
369 case GFC_DTYPE_REAL_16:
370 pack_r16 ((gfc_array_r16 *) ret, (gfc_array_r16 *) array,
371 (gfc_array_l1 *) mask, (gfc_array_r16 *) vector);
374 case GFC_DTYPE_COMPLEX_4:
375 pack_c4 ((gfc_array_c4 *) ret, (gfc_array_c4 *) array,
376 (gfc_array_l1 *) mask, (gfc_array_c4 *) vector);
379 case GFC_DTYPE_COMPLEX_8:
380 pack_c8 ((gfc_array_c8 *) ret, (gfc_array_c8 *) array,
381 (gfc_array_l1 *) mask, (gfc_array_c8 *) vector);
384 #ifdef HAVE_GFC_COMPLEX_10
385 case GFC_DTYPE_COMPLEX_10:
386 pack_c10 ((gfc_array_c10 *) ret, (gfc_array_c10 *) array,
387 (gfc_array_l1 *) mask, (gfc_array_c10 *) vector);
391 #ifdef HAVE_GFC_COMPLEX_16
392 case GFC_DTYPE_COMPLEX_16:
393 pack_c16 ((gfc_array_c16 *) ret, (gfc_array_c16 *) array,
394 (gfc_array_l1 *) mask, (gfc_array_c16 *) vector);
398 /* For derived types, let's check the actual alignment of the
399 data pointers. If they are aligned, we can safely call
400 the unpack functions. */
402 case GFC_DTYPE_DERIVED_2:
403 if (GFC_UNALIGNED_2(ret->data) || GFC_UNALIGNED_2(array->data)
404 || GFC_UNALIGNED_2(vector->data))
408 pack_i2 ((gfc_array_i2 *) ret, (gfc_array_i2 *) array,
409 (gfc_array_l1 *) mask, (gfc_array_i2 *) vector);
413 case GFC_DTYPE_DERIVED_4:
414 if (GFC_UNALIGNED_4(ret->data) || GFC_UNALIGNED_4(array->data)
415 || GFC_UNALIGNED_4(vector->data))
419 pack_i4 ((gfc_array_i4 *) ret, (gfc_array_i4 *) array,
420 (gfc_array_l1 *) mask, (gfc_array_i4 *) vector);
424 case GFC_DTYPE_DERIVED_8:
425 if (GFC_UNALIGNED_8(ret->data) || GFC_UNALIGNED_8(array->data)
426 || GFC_UNALIGNED_8(vector->data))
430 pack_i8 ((gfc_array_i8 *) ret, (gfc_array_i8 *) array,
431 (gfc_array_l1 *) mask, (gfc_array_i8 *) vector);
434 #ifdef HAVE_GFC_INTEGER_16
435 case GFC_DTYPE_DERIVED_16:
436 if (GFC_UNALIGNED_16(ret->data) || GFC_UNALIGNED_16(array->data)
437 || GFC_UNALIGNED_16(vector->data))
441 pack_i16 ((gfc_array_i16 *) ret, (gfc_array_i16 *) array,
442 (gfc_array_l1 *) mask, (gfc_array_i16 *) vector);
449 size = GFC_DESCRIPTOR_SIZE (array);
450 pack_internal (ret, array, mask, vector, size);
454 extern void pack_char (gfc_array_char *, GFC_INTEGER_4, const gfc_array_char *,
455 const gfc_array_l1 *, const gfc_array_char *,
456 GFC_INTEGER_4, GFC_INTEGER_4);
457 export_proto(pack_char);
460 pack_char (gfc_array_char *ret,
461 GFC_INTEGER_4 ret_length __attribute__((unused)),
462 const gfc_array_char *array, const gfc_array_l1 *mask,
463 const gfc_array_char *vector, GFC_INTEGER_4 array_length,
464 GFC_INTEGER_4 vector_length __attribute__((unused)))
466 pack_internal (ret, array, mask, vector, array_length);
470 extern void pack_char4 (gfc_array_char *, GFC_INTEGER_4, const gfc_array_char *,
471 const gfc_array_l1 *, const gfc_array_char *,
472 GFC_INTEGER_4, GFC_INTEGER_4);
473 export_proto(pack_char4);
476 pack_char4 (gfc_array_char *ret,
477 GFC_INTEGER_4 ret_length __attribute__((unused)),
478 const gfc_array_char *array, const gfc_array_l1 *mask,
479 const gfc_array_char *vector, GFC_INTEGER_4 array_length,
480 GFC_INTEGER_4 vector_length __attribute__((unused)))
482 pack_internal (ret, array, mask, vector, array_length * sizeof (gfc_char4_t));
487 pack_s_internal (gfc_array_char *ret, const gfc_array_char *array,
488 const GFC_LOGICAL_4 *mask, const gfc_array_char *vector,
491 /* r.* indicates the return array. */
494 /* s.* indicates the source array. */
495 index_type sstride[GFC_MAX_DIMENSIONS];
499 index_type count[GFC_MAX_DIMENSIONS];
500 index_type extent[GFC_MAX_DIMENSIONS];
507 dim = GFC_DESCRIPTOR_RANK (array);
509 for (n = 0; n < dim; n++)
512 extent[n] = GFC_DESCRIPTOR_EXTENT(array,n);
516 sstride[n] = GFC_DESCRIPTOR_STRIDE_BYTES(array,n);
522 sstride0 = sstride[0];
529 if (ret->data == NULL)
531 /* Allocate the memory for the result. */
535 /* The return array will have as many elements as there are
537 total = GFC_DESCRIPTOR_EXTENT(vector,0);
548 /* The result array will have as many elements as the input
551 for (n = 1; n < dim; n++)
555 /* The result array will be empty. */
559 /* Setup the array descriptor. */
560 GFC_DIMENSION_SET(ret->dim[0],0,total-1,1);
566 ret->data = internal_malloc_size (1);
570 ret->data = internal_malloc_size (size * total);
573 rstride0 = GFC_DESCRIPTOR_STRIDE_BYTES(ret,0);
578 /* The remaining possibilities are now:
579 If MASK is .TRUE., we have to copy the source array into the
580 result array. We then have to fill it up with elements from VECTOR.
581 If MASK is .FALSE., we have to copy VECTOR into the result
582 array. If VECTOR were not present we would have already returned. */
584 if (*mask && ssize != 0)
588 /* Add this element. */
589 memcpy (rptr, sptr, size);
592 /* Advance to the next element. */
596 while (count[n] == extent[n])
598 /* When we get to the end of a dimension, reset it and
599 increment the next dimension. */
601 /* We could precalculate these products, but this is a
602 less frequently used path so probably not worth it. */
603 sptr -= sstride[n] * extent[n];
607 /* Break out of the loop. */
620 /* Add any remaining elements from VECTOR. */
623 n = GFC_DESCRIPTOR_EXTENT(vector,0);
624 nelem = ((rptr - ret->data) / rstride0);
627 sstride0 = GFC_DESCRIPTOR_STRIDE_BYTES(vector,0);
631 sptr = vector->data + sstride0 * nelem;
635 memcpy (rptr, sptr, size);
643 extern void pack_s (gfc_array_char *ret, const gfc_array_char *array,
644 const GFC_LOGICAL_4 *, const gfc_array_char *);
645 export_proto(pack_s);
648 pack_s (gfc_array_char *ret, const gfc_array_char *array,
649 const GFC_LOGICAL_4 *mask, const gfc_array_char *vector)
651 pack_s_internal (ret, array, mask, vector, GFC_DESCRIPTOR_SIZE (array));
655 extern void pack_s_char (gfc_array_char *ret, GFC_INTEGER_4,
656 const gfc_array_char *array, const GFC_LOGICAL_4 *,
657 const gfc_array_char *, GFC_INTEGER_4,
659 export_proto(pack_s_char);
662 pack_s_char (gfc_array_char *ret,
663 GFC_INTEGER_4 ret_length __attribute__((unused)),
664 const gfc_array_char *array, const GFC_LOGICAL_4 *mask,
665 const gfc_array_char *vector, GFC_INTEGER_4 array_length,
666 GFC_INTEGER_4 vector_length __attribute__((unused)))
668 pack_s_internal (ret, array, mask, vector, array_length);
672 extern void pack_s_char4 (gfc_array_char *ret, GFC_INTEGER_4,
673 const gfc_array_char *array, const GFC_LOGICAL_4 *,
674 const gfc_array_char *, GFC_INTEGER_4,
676 export_proto(pack_s_char4);
679 pack_s_char4 (gfc_array_char *ret,
680 GFC_INTEGER_4 ret_length __attribute__((unused)),
681 const gfc_array_char *array, const GFC_LOGICAL_4 *mask,
682 const gfc_array_char *vector, GFC_INTEGER_4 array_length,
683 GFC_INTEGER_4 vector_length __attribute__((unused)))
685 pack_s_internal (ret, array, mask, vector,
686 array_length * sizeof (gfc_char4_t));