libguile/unif.h

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