libguile/arrays.h

   1 /* classes: h_files */
   2
   3 #ifndef SCM_ARRAY_H
   4 #define SCM_ARRAY_H
   5
   6 /* Copyright (C) 1995,1996,1997,1999,2000,2001, 2004, 2006, 2008, 2009,
   7  *   2010, 2012 Free Software Foundation, Inc.
   8  *
   9  * This library is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU Lesser General Public License
  11  * as published by the Free Software Foundation; either version 3 of
  12  * the License, or (at your option) any later version.
  13  *
  14  * This library is distributed in the hope that it will be useful, but
  15  * WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public
  20  * License along with this library; if not, write to the Free Software
  21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  22  * 02110-1301 USA
  23  */
  24
  25 \f
  26
  27 #include "libguile/__scm.h"
  28 #include "libguile/print.h"
  29
  30 \f
  31
  32 /* Multidimensional arrays. Woo hoo!
  33    Also see ....
  34  */
  35
  36
  37 /** Arrays */
  38
  39 SCM_API SCM scm_make_array (SCM fill, SCM bounds);
  40 SCM_API SCM scm_from_contiguous_array (SCM bounds, const SCM *elts,
  41                                        size_t len);
  42 SCM_API SCM scm_make_typed_array (SCM type, SCM fill, SCM bounds);
  43 SCM_API SCM scm_from_contiguous_typed_array (SCM type, SCM bounds,
  44                                              const void *bytes,
  45                                              size_t byte_len);
  46 SCM_API SCM scm_shared_array_root (SCM ra);
  47 SCM_API SCM scm_shared_array_offset (SCM ra);
  48 SCM_API SCM scm_shared_array_increments (SCM ra);
  49 SCM_API SCM scm_make_shared_array (SCM oldra, SCM mapfunc, SCM dims);
  50 SCM_API SCM scm_transpose_array (SCM ra, SCM args);
  51 SCM_API SCM scm_array_contents (SCM ra, SCM strict);
  52 SCM_API SCM scm_list_to_array (SCM ndim, SCM lst);
  53 SCM_API SCM scm_list_to_typed_array (SCM type, SCM ndim, SCM lst);
  54
  55 /* internal. */
  56
  57 #define SCM_I_ARRAY_FLAG_CONTIGUOUS (1 << 0)
  58
  59 #define SCM_I_ARRAYP(a)     SCM_TYP16_PREDICATE (scm_tc7_array, a)
  60 #define SCM_I_ARRAY_NDIM(x)  ((size_t) (SCM_CELL_WORD_0 (x)>>17))
  61 #define SCM_I_ARRAY_CONTP(x) (SCM_CELL_WORD_0 (x) & (SCM_I_ARRAY_FLAG_CONTIGUOUS << 16))
  62
  63 #define SCM_I_ARRAY_V(a)    SCM_CELL_OBJECT_1 (a)
  64 #define SCM_I_ARRAY_BASE(a) ((size_t) SCM_CELL_WORD_2 (a))
  65 #define SCM_I_ARRAY_DIMS(a) ((scm_t_array_dim *) SCM_CELL_OBJECT_LOC (a, 3))
  66
  67 #define SCM_I_ARRAY_SET_V(a, v)       SCM_SET_CELL_OBJECT_1(a, v)
  68 #define SCM_I_ARRAY_SET_BASE(a, base) SCM_SET_CELL_WORD_2(a, base)
  69
  70 SCM_INTERNAL SCM scm_i_make_array (int ndim);
  71 SCM_INTERNAL int scm_i_print_array (SCM array, SCM port, scm_print_state *pstate);
  72
  73 SCM_INTERNAL void scm_init_arrays (void);
  74
  75 #endif  /* SCM_ARRAYS_H */
  76
  77 /*
  78   Local Variables:
  79   c-file-style: "gnu"
  80   End:
  81 */