/* Specific implementation of the PACK intrinsic
|
/* Specific implementation of the PACK intrinsic
|
Copyright (C) 2002, 2004, 2005, 2006, 2007, 2008, 2009 Free Software Foundation, Inc.
|
Copyright (C) 2002, 2004, 2005, 2006, 2007, 2008, 2009 Free Software Foundation, Inc.
|
Contributed by Paul Brook <paul@nowt.org>
|
Contributed by Paul Brook <paul@nowt.org>
|
|
|
This file is part of the GNU Fortran 95 runtime library (libgfortran).
|
This file is part of the GNU Fortran 95 runtime library (libgfortran).
|
|
|
Libgfortran is free software; you can redistribute it and/or
|
Libgfortran is free software; you can redistribute it and/or
|
modify it under the terms of the GNU General Public
|
modify it under the terms of the GNU General Public
|
License as published by the Free Software Foundation; either
|
License as published by the Free Software Foundation; either
|
version 3 of the License, or (at your option) any later version.
|
version 3 of the License, or (at your option) any later version.
|
|
|
Ligbfortran is distributed in the hope that it will be useful,
|
Ligbfortran is distributed in the hope that it will be useful,
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
GNU General Public License for more details.
|
GNU General Public License for more details.
|
|
|
Under Section 7 of GPL version 3, you are granted additional
|
Under Section 7 of GPL version 3, you are granted additional
|
permissions described in the GCC Runtime Library Exception, version
|
permissions described in the GCC Runtime Library Exception, version
|
3.1, as published by the Free Software Foundation.
|
3.1, as published by the Free Software Foundation.
|
|
|
You should have received a copy of the GNU General Public License and
|
You should have received a copy of the GNU General Public License and
|
a copy of the GCC Runtime Library Exception along with this program;
|
a copy of the GCC Runtime Library Exception along with this program;
|
see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
|
see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
|
<http://www.gnu.org/licenses/>. */
|
<http://www.gnu.org/licenses/>. */
|
|
|
#include "libgfortran.h"
|
#include "libgfortran.h"
|
#include <stdlib.h>
|
#include <stdlib.h>
|
#include <assert.h>
|
#include <assert.h>
|
#include <string.h>
|
#include <string.h>
|
|
|
|
|
#if defined (HAVE_GFC_INTEGER_1)
|
#if defined (HAVE_GFC_INTEGER_1)
|
|
|
/* PACK is specified as follows:
|
/* PACK is specified as follows:
|
|
|
13.14.80 PACK (ARRAY, MASK, [VECTOR])
|
13.14.80 PACK (ARRAY, MASK, [VECTOR])
|
|
|
Description: Pack an array into an array of rank one under the
|
Description: Pack an array into an array of rank one under the
|
control of a mask.
|
control of a mask.
|
|
|
Class: Transformational function.
|
Class: Transformational function.
|
|
|
Arguments:
|
Arguments:
|
ARRAY may be of any type. It shall not be scalar.
|
ARRAY may be of any type. It shall not be scalar.
|
MASK shall be of type LOGICAL. It shall be conformable with ARRAY.
|
MASK shall be of type LOGICAL. It shall be conformable with ARRAY.
|
VECTOR (optional) shall be of the same type and type parameters
|
VECTOR (optional) shall be of the same type and type parameters
|
as ARRAY. VECTOR shall have at least as many elements as
|
as ARRAY. VECTOR shall have at least as many elements as
|
there are true elements in MASK. If MASK is a scalar
|
there are true elements in MASK. If MASK is a scalar
|
with the value true, VECTOR shall have at least as many
|
with the value true, VECTOR shall have at least as many
|
elements as there are in ARRAY.
|
elements as there are in ARRAY.
|
|
|
Result Characteristics: The result is an array of rank one with the
|
Result Characteristics: The result is an array of rank one with the
|
same type and type parameters as ARRAY. If VECTOR is present, the
|
same type and type parameters as ARRAY. If VECTOR is present, the
|
result size is that of VECTOR; otherwise, the result size is the
|
result size is that of VECTOR; otherwise, the result size is the
|
number /t/ of true elements in MASK unless MASK is scalar with the
|
number /t/ of true elements in MASK unless MASK is scalar with the
|
value true, in which case the result size is the size of ARRAY.
|
value true, in which case the result size is the size of ARRAY.
|
|
|
Result Value: Element /i/ of the result is the element of ARRAY
|
Result Value: Element /i/ of the result is the element of ARRAY
|
that corresponds to the /i/th true element of MASK, taking elements
|
that corresponds to the /i/th true element of MASK, taking elements
|
in array element order, for /i/ = 1, 2, ..., /t/. If VECTOR is
|
in array element order, for /i/ = 1, 2, ..., /t/. If VECTOR is
|
present and has size /n/ > /t/, element /i/ of the result has the
|
present and has size /n/ > /t/, element /i/ of the result has the
|
value VECTOR(/i/), for /i/ = /t/ + 1, ..., /n/.
|
value VECTOR(/i/), for /i/ = /t/ + 1, ..., /n/.
|
|
|
Examples: The nonzero elements of an array M with the value
|
Examples: The nonzero elements of an array M with the value
|
| 0 0 0 |
|
| 0 0 0 |
|
| 9 0 0 | may be "gathered" by the function PACK. The result of
|
| 9 0 0 | may be "gathered" by the function PACK. The result of
|
| 0 0 7 |
|
| 0 0 7 |
|
PACK (M, MASK = M.NE.0) is [9,7] and the result of PACK (M, M.NE.0,
|
PACK (M, MASK = M.NE.0) is [9,7] and the result of PACK (M, M.NE.0,
|
VECTOR = (/ 2,4,6,8,10,12 /)) is [9,7,6,8,10,12].
|
VECTOR = (/ 2,4,6,8,10,12 /)) is [9,7,6,8,10,12].
|
|
|
There are two variants of the PACK intrinsic: one, where MASK is
|
There are two variants of the PACK intrinsic: one, where MASK is
|
array valued, and the other one where MASK is scalar. */
|
array valued, and the other one where MASK is scalar. */
|
|
|
void
|
void
|
pack_i1 (gfc_array_i1 *ret, const gfc_array_i1 *array,
|
pack_i1 (gfc_array_i1 *ret, const gfc_array_i1 *array,
|
const gfc_array_l1 *mask, const gfc_array_i1 *vector)
|
const gfc_array_l1 *mask, const gfc_array_i1 *vector)
|
{
|
{
|
/* r.* indicates the return array. */
|
/* r.* indicates the return array. */
|
index_type rstride0;
|
index_type rstride0;
|
GFC_INTEGER_1 * restrict rptr;
|
GFC_INTEGER_1 * restrict rptr;
|
/* s.* indicates the source array. */
|
/* s.* indicates the source array. */
|
index_type sstride[GFC_MAX_DIMENSIONS];
|
index_type sstride[GFC_MAX_DIMENSIONS];
|
index_type sstride0;
|
index_type sstride0;
|
const GFC_INTEGER_1 *sptr;
|
const GFC_INTEGER_1 *sptr;
|
/* m.* indicates the mask array. */
|
/* m.* indicates the mask array. */
|
index_type mstride[GFC_MAX_DIMENSIONS];
|
index_type mstride[GFC_MAX_DIMENSIONS];
|
index_type mstride0;
|
index_type mstride0;
|
const GFC_LOGICAL_1 *mptr;
|
const GFC_LOGICAL_1 *mptr;
|
|
|
index_type count[GFC_MAX_DIMENSIONS];
|
index_type count[GFC_MAX_DIMENSIONS];
|
index_type extent[GFC_MAX_DIMENSIONS];
|
index_type extent[GFC_MAX_DIMENSIONS];
|
int zero_sized;
|
int zero_sized;
|
index_type n;
|
index_type n;
|
index_type dim;
|
index_type dim;
|
index_type nelem;
|
index_type nelem;
|
index_type total;
|
index_type total;
|
int mask_kind;
|
int mask_kind;
|
|
|
dim = GFC_DESCRIPTOR_RANK (array);
|
dim = GFC_DESCRIPTOR_RANK (array);
|
|
|
mptr = mask->data;
|
mptr = mask->data;
|
|
|
/* Use the same loop for all logical types, by using GFC_LOGICAL_1
|
/* Use the same loop for all logical types, by using GFC_LOGICAL_1
|
and using shifting to address size and endian issues. */
|
and using shifting to address size and endian issues. */
|
|
|
mask_kind = GFC_DESCRIPTOR_SIZE (mask);
|
mask_kind = GFC_DESCRIPTOR_SIZE (mask);
|
|
|
if (mask_kind == 1 || mask_kind == 2 || mask_kind == 4 || mask_kind == 8
|
if (mask_kind == 1 || mask_kind == 2 || mask_kind == 4 || mask_kind == 8
|
#ifdef HAVE_GFC_LOGICAL_16
|
#ifdef HAVE_GFC_LOGICAL_16
|
|| mask_kind == 16
|
|| mask_kind == 16
|
#endif
|
#endif
|
)
|
)
|
{
|
{
|
/* Do not convert a NULL pointer as we use test for NULL below. */
|
/* Do not convert a NULL pointer as we use test for NULL below. */
|
if (mptr)
|
if (mptr)
|
mptr = GFOR_POINTER_TO_L1 (mptr, mask_kind);
|
mptr = GFOR_POINTER_TO_L1 (mptr, mask_kind);
|
}
|
}
|
else
|
else
|
runtime_error ("Funny sized logical array");
|
runtime_error ("Funny sized logical array");
|
|
|
zero_sized = 0;
|
zero_sized = 0;
|
for (n = 0; n < dim; n++)
|
for (n = 0; n < dim; n++)
|
{
|
{
|
count[n] = 0;
|
count[n] = 0;
|
extent[n] = GFC_DESCRIPTOR_EXTENT(array,n);
|
extent[n] = GFC_DESCRIPTOR_EXTENT(array,n);
|
if (extent[n] <= 0)
|
if (extent[n] <= 0)
|
zero_sized = 1;
|
zero_sized = 1;
|
sstride[n] = GFC_DESCRIPTOR_STRIDE(array,n);
|
sstride[n] = GFC_DESCRIPTOR_STRIDE(array,n);
|
mstride[n] = GFC_DESCRIPTOR_STRIDE_BYTES(mask,n);
|
mstride[n] = GFC_DESCRIPTOR_STRIDE_BYTES(mask,n);
|
}
|
}
|
if (sstride[0] == 0)
|
if (sstride[0] == 0)
|
sstride[0] = 1;
|
sstride[0] = 1;
|
if (mstride[0] == 0)
|
if (mstride[0] == 0)
|
mstride[0] = mask_kind;
|
mstride[0] = mask_kind;
|
|
|
if (zero_sized)
|
if (zero_sized)
|
sptr = NULL;
|
sptr = NULL;
|
else
|
else
|
sptr = array->data;
|
sptr = array->data;
|
|
|
if (ret->data == NULL || unlikely (compile_options.bounds_check))
|
if (ret->data == NULL || unlikely (compile_options.bounds_check))
|
{
|
{
|
/* Count the elements, either for allocating memory or
|
/* Count the elements, either for allocating memory or
|
for bounds checking. */
|
for bounds checking. */
|
|
|
if (vector != NULL)
|
if (vector != NULL)
|
{
|
{
|
/* The return array will have as many
|
/* The return array will have as many
|
elements as there are in VECTOR. */
|
elements as there are in VECTOR. */
|
total = GFC_DESCRIPTOR_EXTENT(vector,0);
|
total = GFC_DESCRIPTOR_EXTENT(vector,0);
|
if (total < 0)
|
if (total < 0)
|
{
|
{
|
total = 0;
|
total = 0;
|
vector = NULL;
|
vector = NULL;
|
}
|
}
|
}
|
}
|
else
|
else
|
{
|
{
|
/* We have to count the true elements in MASK. */
|
/* We have to count the true elements in MASK. */
|
total = count_0 (mask);
|
total = count_0 (mask);
|
}
|
}
|
|
|
if (ret->data == NULL)
|
if (ret->data == NULL)
|
{
|
{
|
/* Setup the array descriptor. */
|
/* Setup the array descriptor. */
|
GFC_DIMENSION_SET(ret->dim[0], 0, total-1, 1);
|
GFC_DIMENSION_SET(ret->dim[0], 0, total-1, 1);
|
|
|
ret->offset = 0;
|
ret->offset = 0;
|
|
|
/* internal_malloc_size allocates a single byte for zero size. */
|
/* internal_malloc_size allocates a single byte for zero size. */
|
ret->data = internal_malloc_size (sizeof (GFC_INTEGER_1) * total);
|
ret->data = internal_malloc_size (sizeof (GFC_INTEGER_1) * total);
|
|
|
if (total == 0)
|
if (total == 0)
|
return;
|
return;
|
}
|
}
|
else
|
else
|
{
|
{
|
/* We come here because of range checking. */
|
/* We come here because of range checking. */
|
index_type ret_extent;
|
index_type ret_extent;
|
|
|
ret_extent = GFC_DESCRIPTOR_EXTENT(ret,0);
|
ret_extent = GFC_DESCRIPTOR_EXTENT(ret,0);
|
if (total != ret_extent)
|
if (total != ret_extent)
|
runtime_error ("Incorrect extent in return value of PACK intrinsic;"
|
runtime_error ("Incorrect extent in return value of PACK intrinsic;"
|
" is %ld, should be %ld", (long int) total,
|
" is %ld, should be %ld", (long int) total,
|
(long int) ret_extent);
|
(long int) ret_extent);
|
}
|
}
|
}
|
}
|
|
|
rstride0 = GFC_DESCRIPTOR_STRIDE(ret,0);
|
rstride0 = GFC_DESCRIPTOR_STRIDE(ret,0);
|
if (rstride0 == 0)
|
if (rstride0 == 0)
|
rstride0 = 1;
|
rstride0 = 1;
|
sstride0 = sstride[0];
|
sstride0 = sstride[0];
|
mstride0 = mstride[0];
|
mstride0 = mstride[0];
|
rptr = ret->data;
|
rptr = ret->data;
|
|
|
while (sptr && mptr)
|
while (sptr && mptr)
|
{
|
{
|
/* Test this element. */
|
/* Test this element. */
|
if (*mptr)
|
if (*mptr)
|
{
|
{
|
/* Add it. */
|
/* Add it. */
|
*rptr = *sptr;
|
*rptr = *sptr;
|
rptr += rstride0;
|
rptr += rstride0;
|
}
|
}
|
/* Advance to the next element. */
|
/* Advance to the next element. */
|
sptr += sstride0;
|
sptr += sstride0;
|
mptr += mstride0;
|
mptr += mstride0;
|
count[0]++;
|
count[0]++;
|
n = 0;
|
n = 0;
|
while (count[n] == extent[n])
|
while (count[n] == extent[n])
|
{
|
{
|
/* When we get to the end of a dimension, reset it and increment
|
/* When we get to the end of a dimension, reset it and increment
|
the next dimension. */
|
the next dimension. */
|
count[n] = 0;
|
count[n] = 0;
|
/* We could precalculate these products, but this is a less
|
/* We could precalculate these products, but this is a less
|
frequently used path so probably not worth it. */
|
frequently used path so probably not worth it. */
|
sptr -= sstride[n] * extent[n];
|
sptr -= sstride[n] * extent[n];
|
mptr -= mstride[n] * extent[n];
|
mptr -= mstride[n] * extent[n];
|
n++;
|
n++;
|
if (n >= dim)
|
if (n >= dim)
|
{
|
{
|
/* Break out of the loop. */
|
/* Break out of the loop. */
|
sptr = NULL;
|
sptr = NULL;
|
break;
|
break;
|
}
|
}
|
else
|
else
|
{
|
{
|
count[n]++;
|
count[n]++;
|
sptr += sstride[n];
|
sptr += sstride[n];
|
mptr += mstride[n];
|
mptr += mstride[n];
|
}
|
}
|
}
|
}
|
}
|
}
|
|
|
/* Add any remaining elements from VECTOR. */
|
/* Add any remaining elements from VECTOR. */
|
if (vector)
|
if (vector)
|
{
|
{
|
n = GFC_DESCRIPTOR_EXTENT(vector,0);
|
n = GFC_DESCRIPTOR_EXTENT(vector,0);
|
nelem = ((rptr - ret->data) / rstride0);
|
nelem = ((rptr - ret->data) / rstride0);
|
if (n > nelem)
|
if (n > nelem)
|
{
|
{
|
sstride0 = GFC_DESCRIPTOR_STRIDE(vector,0);
|
sstride0 = GFC_DESCRIPTOR_STRIDE(vector,0);
|
if (sstride0 == 0)
|
if (sstride0 == 0)
|
sstride0 = 1;
|
sstride0 = 1;
|
|
|
sptr = vector->data + sstride0 * nelem;
|
sptr = vector->data + sstride0 * nelem;
|
n -= nelem;
|
n -= nelem;
|
while (n--)
|
while (n--)
|
{
|
{
|
*rptr = *sptr;
|
*rptr = *sptr;
|
rptr += rstride0;
|
rptr += rstride0;
|
sptr += sstride0;
|
sptr += sstride0;
|
}
|
}
|
}
|
}
|
}
|
}
|
}
|
}
|
|
|
#endif
|
#endif
|
|
|
|
|
