libgfortran/m4/reshape.m4

   1 `/* Implementation of the RESHAPE
   2    Copyright 2002, 2006, 2007 Free Software Foundation, Inc.
   3    Contributed by Paul Brook <paul@nowt.org>
   4
   5 This file is part of the GNU Fortran 95 runtime library (libgfortran).
   6
   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 2 of the License, or (at your option) any later version.
  11
  12 In addition to the permissions in the GNU General Public License, the
  13 Free Software Foundation gives you unlimited permission to link the
  14 compiled version of this file into combinations with other programs,
  15 and to distribute those combinations without any restriction coming
  16 from the use of this file.  (The General Public License restrictions
  17 do apply in other respects; for example, they cover modification of
  18 the file, and distribution when not linked into a combine
  19 executable.)
  20
  21 Libgfortran is distributed in the hope that it will be useful,
  22 but WITHOUT ANY WARRANTY; without even the implied warranty of
  23 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  24 GNU General Public License for more details.
  25
  26 You should have received a copy of the GNU General Public
  27 License along with libgfortran; see the file COPYING.  If not,
  28 write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  29 Boston, MA 02110-1301, USA.  */
  30
  31 #include "libgfortran.h"
  32 #include <stdlib.h>
  33 #include <assert.h>'
  34
  35 include(iparm.m4)dnl
  36
  37 `#if defined (HAVE_'rtype_name`)
  38
  39 typedef GFC_ARRAY_DESCRIPTOR(1, 'index_type`) 'shape_type`;'
  40
  41 dnl For integer routines, only the kind (ie size) is used to name the
  42 dnl function.  The same function will be used for integer and logical
  43 dnl arrays of the same kind.
  44
  45 `extern void reshape_'rtype_ccode` ('rtype` * const restrict,
  46         'rtype` * const restrict,
  47         'shape_type` * const restrict,
  48         'rtype` * const restrict,
  49         'shape_type` * const restrict);
  50 export_proto(reshape_'rtype_ccode`);
  51
  52 void
  53 reshape_'rtype_ccode` ('rtype` * const restrict ret,
  54         'rtype` * const restrict source,
  55         'shape_type` * const restrict shape,
  56         'rtype` * const restrict pad,
  57         'shape_type` * const restrict order)
  58 {
  59   /* r.* indicates the return array.  */
  60   index_type rcount[GFC_MAX_DIMENSIONS];
  61   index_type rextent[GFC_MAX_DIMENSIONS];
  62   index_type rstride[GFC_MAX_DIMENSIONS];
  63   index_type rstride0;
  64   index_type rdim;
  65   index_type rsize;
  66   index_type rs;
  67   index_type rex;
  68   'rtype_name` *rptr;
  69   /* s.* indicates the source array.  */
  70   index_type scount[GFC_MAX_DIMENSIONS];
  71   index_type sextent[GFC_MAX_DIMENSIONS];
  72   index_type sstride[GFC_MAX_DIMENSIONS];
  73   index_type sstride0;
  74   index_type sdim;
  75   index_type ssize;
  76   const 'rtype_name` *sptr;
  77   /* p.* indicates the pad array.  */
  78   index_type pcount[GFC_MAX_DIMENSIONS];
  79   index_type pextent[GFC_MAX_DIMENSIONS];
  80   index_type pstride[GFC_MAX_DIMENSIONS];
  81   index_type pdim;
  82   index_type psize;
  83   const 'rtype_name` *pptr;
  84
  85   const 'rtype_name` *src;
  86   int n;
  87   int dim;
  88   int sempty, pempty, shape_empty;
  89   index_type shape_data[GFC_MAX_DIMENSIONS];
  90
  91   rdim = shape->dim[0].ubound - shape->dim[0].lbound + 1;
  92   if (rdim != GFC_DESCRIPTOR_RANK(ret))
  93     runtime_error("rank of return array incorrect in RESHAPE intrinsic");
  94
  95   shape_empty = 0;
  96
  97   for (n = 0; n < rdim; n++)
  98     {
  99       shape_data[n] = shape->data[n * shape->dim[0].stride];
 100       if (shape_data[n] <= 0)
 101       {
 102         shape_data[n] = 0;
 103         shape_empty = 1;
 104       }
 105     }
 106
 107   if (ret->data == NULL)
 108     {
 109       rs = 1;
 110       for (n = 0; n < rdim; n++)
 111         {
 112           ret->dim[n].lbound = 0;
 113           rex = shape_data[n];
 114           ret->dim[n].ubound =  rex - 1;
 115           ret->dim[n].stride = rs;
 116           rs *= rex;
 117         }
 118       ret->offset = 0;
 119       ret->data = internal_malloc_size ( rs * sizeof ('rtype_name`));
 120       ret->dtype = (source->dtype & ~GFC_DTYPE_RANK_MASK) | rdim;
 121     }
 122
 123   if (shape_empty)
 124     return;
 125
 126   if (pad)
 127     {
 128       pdim = GFC_DESCRIPTOR_RANK (pad);
 129       psize = 1;
 130       pempty = 0;
 131       for (n = 0; n < pdim; n++)
 132         {
 133           pcount[n] = 0;
 134           pstride[n] = pad->dim[n].stride;
 135           pextent[n] = pad->dim[n].ubound + 1 - pad->dim[n].lbound;
 136           if (pextent[n] <= 0)
 137             {
 138               pempty = 1;
 139               pextent[n] = 0;
 140             }
 141
 142           if (psize == pstride[n])
 143             psize *= pextent[n];
 144           else
 145             psize = 0;
 146         }
 147       pptr = pad->data;
 148     }
 149   else
 150     {
 151       pdim = 0;
 152       psize = 1;
 153       pempty = 1;
 154       pptr = NULL;
 155     }
 156
 157   if (unlikely (compile_options.bounds_check))
 158     {
 159       index_type ret_extent, source_extent;
 160
 161       rs = 1;
 162       for (n = 0; n < rdim; n++)
 163         {
 164           rs *= shape_data[n];
 165           ret_extent = ret->dim[n].ubound + 1 - ret->dim[n].lbound;
 166           if (ret_extent != shape_data[n])
 167             runtime_error("Incorrect extent in return value of RESHAPE"
 168                           " intrinsic in dimension %ld: is %ld,"
 169                           " should be %ld", (long int) n+1,
 170                           (long int) ret_extent, (long int) shape_data[n]);
 171         }
 172
 173       source_extent = 1;
 174       sdim = GFC_DESCRIPTOR_RANK (source);
 175       for (n = 0; n < sdim; n++)
 176         {
 177           index_type se;
 178           se = source->dim[n].ubound + 1 - source->dim[0].lbound;
 179           source_extent *= se > 0 ? se : 0;
 180         }
 181
 182       if (rs > source_extent && (!pad || pempty))
 183         runtime_error("Incorrect size in SOURCE argument to RESHAPE"
 184                       " intrinsic: is %ld, should be %ld",
 185                       (long int) source_extent, (long int) rs);
 186
 187       if (order)
 188         {
 189           int seen[GFC_MAX_DIMENSIONS];
 190           index_type v;
 191
 192           for (n = 0; n < rdim; n++)
 193             seen[n] = 0;
 194
 195           for (n = 0; n < rdim; n++)
 196             {
 197               v = order->data[n * order->dim[0].stride] - 1;
 198
 199               if (v < 0 || v >= rdim)
 200                 runtime_error("Value %ld out of range in ORDER argument"
 201                               " to RESHAPE intrinsic", (long int) v + 1);
 202
 203               if (seen[v] != 0)
 204                 runtime_error("Duplicate value %ld in ORDER argument to"
 205                               " RESHAPE intrinsic", (long int) v + 1);
 206
 207               seen[v] = 1;
 208             }
 209         }
 210     }
 211
 212   rsize = 1;
 213   for (n = 0; n < rdim; n++)
 214     {
 215       if (order)
 216         dim = order->data[n * order->dim[0].stride] - 1;
 217       else
 218         dim = n;
 219
 220       rcount[n] = 0;
 221       rstride[n] = ret->dim[dim].stride;
 222       rextent[n] = ret->dim[dim].ubound + 1 - ret->dim[dim].lbound;
 223       if (rextent[n] < 0)
 224         rextent[n] = 0;
 225
 226       if (rextent[n] != shape_data[dim])
 227         runtime_error ("shape and target do not conform");
 228
 229       if (rsize == rstride[n])
 230         rsize *= rextent[n];
 231       else
 232         rsize = 0;
 233       if (rextent[n] <= 0)
 234         return;
 235     }
 236
 237   sdim = GFC_DESCRIPTOR_RANK (source);
 238   ssize = 1;
 239   sempty = 0;
 240   for (n = 0; n < sdim; n++)
 241     {
 242       scount[n] = 0;
 243       sstride[n] = source->dim[n].stride;
 244       sextent[n] = source->dim[n].ubound + 1 - source->dim[n].lbound;
 245       if (sextent[n] <= 0)
 246         {
 247           sempty = 1;
 248           sextent[n] = 0;
 249         }
 250
 251       if (ssize == sstride[n])
 252         ssize *= sextent[n];
 253       else
 254         ssize = 0;
 255     }
 256
 257   if (rsize != 0 && ssize != 0 && psize != 0)
 258     {
 259       rsize *= sizeof ('rtype_name`);
 260       ssize *= sizeof ('rtype_name`);
 261       psize *= sizeof ('rtype_name`);
 262       reshape_packed ((char *)ret->data, rsize, (char *)source->data,
 263                       ssize, pad ? (char *)pad->data : NULL, psize);
 264       return;
 265     }
 266   rptr = ret->data;
 267   src = sptr = source->data;
 268   rstride0 = rstride[0];
 269   sstride0 = sstride[0];
 270
 271   if (sempty && pempty)
 272     abort ();
 273
 274   if (sempty)
 275     {
 276       /* Pretend we are using the pad array the first time around, too.  */
 277       src = pptr;
 278       sptr = pptr;
 279       sdim = pdim;
 280       for (dim = 0; dim < pdim; dim++)
 281         {
 282           scount[dim] = pcount[dim];
 283           sextent[dim] = pextent[dim];
 284           sstride[dim] = pstride[dim];
 285           sstride0 = pstride[0];
 286         }
 287     }
 288
 289   while (rptr)
 290     {
 291       /* Select between the source and pad arrays.  */
 292       *rptr = *src;
 293       /* Advance to the next element.  */
 294       rptr += rstride0;
 295       src += sstride0;
 296       rcount[0]++;
 297       scount[0]++;
 298
 299       /* Advance to the next destination element.  */
 300       n = 0;
 301       while (rcount[n] == rextent[n])
 302         {
 303           /* When we get to the end of a dimension, reset it and increment
 304              the next dimension.  */
 305           rcount[n] = 0;
 306           /* We could precalculate these products, but this is a less
 307              frequently used path so probably not worth it.  */
 308           rptr -= rstride[n] * rextent[n];
 309           n++;
 310           if (n == rdim)
 311             {
 312               /* Break out of the loop.  */
 313               rptr = NULL;
 314               break;
 315             }
 316           else
 317             {
 318               rcount[n]++;
 319               rptr += rstride[n];
 320             }
 321         }
 322       /* Advance to the next source element.  */
 323       n = 0;
 324       while (scount[n] == sextent[n])
 325         {
 326           /* When we get to the end of a dimension, reset it and increment
 327              the next dimension.  */
 328           scount[n] = 0;
 329           /* We could precalculate these products, but this is a less
 330              frequently used path so probably not worth it.  */
 331           src -= sstride[n] * sextent[n];
 332           n++;
 333           if (n == sdim)
 334             {
 335               if (sptr && pad)
 336                 {
 337                   /* Switch to the pad array.  */
 338                   sptr = NULL;
 339                   sdim = pdim;
 340                   for (dim = 0; dim < pdim; dim++)
 341                     {
 342                       scount[dim] = pcount[dim];
 343                       sextent[dim] = pextent[dim];
 344                       sstride[dim] = pstride[dim];
 345                       sstride0 = sstride[0];
 346                     }
 347                 }
 348               /* We now start again from the beginning of the pad array.  */
 349               src = pptr;
 350               break;
 351             }
 352           else
 353             {
 354               scount[n]++;
 355               src += sstride[n];
 356             }
 357         }
 358     }
 359 }
 360
 361 #endif'