libguile/unif.h

   1 /* classes: h_files */
   2
   3 #ifndef SCM_UNIFORM_VECTORS_H
   4 #define SCM_UNIFORM_VECTORS_H
   5 /* Copyright (C) 1995,1996,1997,1999,2000,2001 Free Software Foundation, Inc.
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2, or (at your option)
  10  * any later version.
  11  *
  12  * This program 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.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this software; see the file COPYING.  If not, write to
  19  * the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  20  * Boston, MA 02111-1307 USA
  21  *
  22  * As a special exception, the Free Software Foundation gives permission
  23  * for additional uses of the text contained in its release of GUILE.
  24  *
  25  * The exception is that, if you link the GUILE library with other files
  26  * to produce an executable, this does not by itself cause the
  27  * resulting executable to be covered by the GNU General Public License.
  28  * Your use of that executable is in no way restricted on account of
  29  * linking the GUILE library code into it.
  30  *
  31  * This exception does not however invalidate any other reasons why
  32  * the executable file might be covered by the GNU General Public License.
  33  *
  34  * This exception applies only to the code released by the
  35  * Free Software Foundation under the name GUILE.  If you copy
  36  * code from other Free Software Foundation releases into a copy of
  37  * GUILE, as the General Public License permits, the exception does
  38  * not apply to the code that you add in this way.  To avoid misleading
  39  * anyone as to the status of such modified files, you must delete
  40  * this exception notice from them.
  41  *
  42  * If you write modifications of your own for GUILE, it is your choice
  43  * whether to permit this exception to apply to your modifications.
  44  * If you do not wish that, delete this exception notice.  */
  45
  46 /* Software engineering face-lift by Greg J. Badros, 11-Dec-1999,
  47    gjb@cs.washington.edu, http://www.cs.washington.edu/homes/gjb */
  48 \f
  49
  50 #include "libguile/__scm.h"
  51
  52 \f
  53
  54 /*
  55   an array SCM is a non-immediate pointing to a  heap cell with:
  56
  57    CAR: bits 0-14 hold the dimension (0 -- 32767)
  58         bit  15 is the SCM_ARRAY_FLAG_CONTIGUOUS flag
  59         bits 16-31 hold the smob type id: scm_tc16_array
  60    CDR: pointer to a malloced block containing an scm_array structure
  61         followed by an scm_array_dim_t structure for each dimension.
  62 */
  63
  64 typedef struct scm_array_t
  65 {
  66   SCM v;  /* the contents of the array, e.g., a vector or uniform vector.  */
  67   unsigned long base;
  68 } scm_array_t;
  69
  70 typedef struct scm_array_dim_t
  71 {
  72   long lbnd;
  73   long ubnd;
  74   long inc;
  75 } scm_array_dim_t;
  76
  77 #if (SCM_DEBUG_DEPRECATED == 0)
  78 # define scm_array scm_array_t
  79 # define scm_array_dim scm_array_dim_t
  80 #endif
  81
  82 extern scm_bits_t scm_tc16_array;
  83
  84 #define SCM_ARRAY_FLAG_CONTIGUOUS (1 << 16)
  85
  86 #if (SCM_DEBUG_DEPRECATED == 0)
  87 #define SCM_ARRAY_CONTIGUOUS SCM_ARRAY_FLAG_CONTIGUOUS
  88 #endif
  89
  90 #define SCM_ARRAYP(a)       SCM_TYP16_PREDICATE (scm_tc16_array, a)
  91 #define SCM_ARRAY_NDIM(x)   ((size_t) (SCM_CELL_WORD_0 (x)) >> 17)
  92 #define SCM_ARRAY_CONTP(x)  (SCM_CELL_WORD_0 (x) & SCM_ARRAY_FLAG_CONTIGUOUS)
  93 #define SCM_SET_ARRAY_CONTIGUOUS_FLAG(x) \
  94   (SCM_SET_CELL_WORD_0 ((x), SCM_CELL_WORD_0 (x) | SCM_ARRAY_FLAG_CONTIGUOUS))
  95 #define SCM_CLR_ARRAY_CONTIGUOUS_FLAG(x) \
  96   (SCM_SET_CELL_WORD_0 ((x), SCM_CELL_WORD_0 (x) & ~SCM_ARRAY_FLAG_CONTIGUOUS))
  97
  98 #define SCM_ARRAY_MEM(a)  ((scm_array_t *) SCM_CELL_WORD_1 (a))
  99 #define SCM_ARRAY_V(a)    (SCM_ARRAY_MEM (a)->v)
 100 #define SCM_ARRAY_BASE(a) (SCM_ARRAY_MEM (a)->base)
 101 #define SCM_ARRAY_DIMS(a) ((scm_array_dim_t *)((char *) SCM_ARRAY_MEM (a) + sizeof (scm_array_t)))
 102
 103 #define SCM_I_MAX_LENGTH  ((unsigned long) (-1L) >> 8)
 104
 105 #define SCM_UVECTOR_BASE(x) ((void *) (SCM_CELL_WORD_1 (x)))
 106 #define SCM_SET_UVECTOR_BASE(v, b) (SCM_SET_CELL_WORD_1 ((v), (b)))
 107 #define SCM_UVECTOR_MAX_LENGTH SCM_I_MAX_LENGTH
 108 #define SCM_UVECTOR_LENGTH(x) (((unsigned long) SCM_CELL_WORD_0 (x)) >> 8)
 109 #define SCM_SET_UVECTOR_LENGTH(v, l, t) (SCM_SET_CELL_WORD_0 ((v), ((l) << 8) + (t)))
 110
 111 #define SCM_BITVECTOR_P(x) (!SCM_IMP (x) && (SCM_TYP7 (x) == scm_tc7_bvect))
 112 #define SCM_BITVECTOR_BASE(x) ((void *) (SCM_CELL_WORD_1 (x)))
 113 #define SCM_SET_BITVECTOR_BASE(v, b) (SCM_SET_CELL_WORD_1 ((v), (b)))
 114 #define SCM_BITVECTOR_MAX_LENGTH SCM_I_MAX_LENGTH
 115 #define SCM_BITVECTOR_LENGTH(x) (((unsigned long) SCM_CELL_WORD_0 (x)) >> 8)
 116 #define SCM_SET_BITVECTOR_LENGTH(v, l) (SCM_SET_CELL_WORD_0 ((v), ((l) << 8) + scm_tc7_bvect))
 117
 118 \f
 119
 120 extern size_t scm_uniform_element_size (SCM obj);
 121 extern SCM scm_make_uve (long k, SCM prot);
 122 extern SCM scm_uniform_vector_length (SCM v);
 123 extern SCM scm_array_p (SCM v, SCM prot);
 124 extern SCM scm_array_rank (SCM ra);
 125 extern SCM scm_array_dimensions (SCM ra);
 126 extern SCM scm_shared_array_root (SCM ra);
 127 extern SCM scm_shared_array_offset (SCM ra);
 128 extern SCM scm_shared_array_increments (SCM ra);
 129 extern long scm_aind (SCM ra, SCM args, const char *what);
 130 extern SCM scm_make_ra (int ndim);
 131 extern SCM scm_shap2ra (SCM args, const char *what);
 132 extern SCM scm_dimensions_to_uniform_array (SCM dims, SCM prot, SCM fill);
 133 extern void scm_ra_set_contp (SCM ra);
 134 extern SCM scm_make_shared_array (SCM oldra, SCM mapfunc, SCM dims);
 135 extern SCM scm_transpose_array (SCM ra, SCM args);
 136 extern SCM scm_enclose_array (SCM ra, SCM axes);
 137 extern SCM scm_array_in_bounds_p (SCM v, SCM args);
 138 extern SCM scm_uniform_vector_ref (SCM v, SCM args);
 139 extern SCM scm_cvref (SCM v, unsigned long pos, SCM last);
 140 extern SCM scm_array_set_x (SCM v, SCM obj, SCM args);
 141 extern SCM scm_array_contents (SCM ra, SCM strict);
 142 extern SCM scm_ra2contig (SCM ra, int copy);
 143 extern SCM scm_uniform_array_read_x (SCM ra, SCM port_or_fd, SCM start, SCM end);
 144 extern SCM scm_uniform_array_write (SCM v, SCM port_or_fd, SCM start, SCM end);
 145 extern SCM scm_bit_count (SCM item, SCM seq);
 146 extern SCM scm_bit_position (SCM item, SCM v, SCM k);
 147 extern SCM scm_bit_set_star_x (SCM v, SCM kv, SCM obj);
 148 extern SCM scm_bit_count_star (SCM v, SCM kv, SCM obj);
 149 extern SCM scm_bit_invert_x (SCM v);
 150 extern SCM scm_istr2bve (char *str, long len);
 151 extern SCM scm_array_to_list (SCM v);
 152 extern SCM scm_list_to_uniform_array (SCM ndim, SCM prot, SCM lst);
 153 extern int scm_raprin1 (SCM exp, SCM port, scm_print_state *pstate);
 154 extern SCM scm_array_prototype (SCM ra);
 155 extern void scm_init_unif (void);
 156
 157 \f
 158
 159 #if (SCM_DEBUG_DEPRECATED == 0)
 160
 161 /* apparently it's possible to have more than SCM_LENGTH_MAX elements
 162    in an array: if the length is SCM_LENGTH_MAX then the SCM_VELTS
 163    block begins with the true length (a long int).  I wonder if it
 164    works.  */
 165 #define SCM_HUGE_LENGTH(x)\
 166   (SCM_LENGTH_MAX==SCM_LENGTH(x) ? *((long *)SCM_VELTS(x)) : SCM_LENGTH(x))
 167
 168 #endif  /* SCM_DEBUG_DEPRECATED == 0 */
 169
 170 #endif  /* SCM_UNIFORM_VECTORS_H */
 171
 172 /*
 173   Local Variables:
 174   c-file-style: "gnu"
 175   End:
 176 */