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 library is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU Lesser General Public
  10  * License as published by the Free Software Foundation; either
  11  * version 2.1 of the License, or (at your option) any later version.
  12  *
  13  * This library 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 GNU
  16  * Lesser General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Lesser General Public
  19  * License along with this library; if not, write to the Free Software
  20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  21  */
  22
  23 \f
  24
  25 #include "libguile/__scm.h"
  26
  27 \f
  28
  29 /*
  30   an array SCM is a non-immediate pointing to a  heap cell where:
  31
  32    CAR: bits 0-15 hold the smob type id: scm_tc16_array
  33         bit  16 is the SCM_ARRAY_FLAG_CONTIGUOUS flag
  34         bits 17-31 hold the dimension (0 -- 32767)
  35    CDR: pointer to a malloced block containing an scm_t_array structure
  36         followed by an scm_t_array_dim structure for each dimension.
  37 */
  38
  39 typedef struct scm_t_array
  40 {
  41   SCM v;  /* the contents of the array, e.g., a vector or uniform vector.  */
  42   unsigned long base;
  43 } scm_t_array;
  44
  45 typedef struct scm_t_array_dim
  46 {
  47   long lbnd;
  48   long ubnd;
  49   long inc;
  50 } scm_t_array_dim;
  51
  52 SCM_API scm_t_bits scm_tc16_array;
  53
  54 #define SCM_ARRAY_FLAG_CONTIGUOUS (1 << 16)
  55
  56 #define SCM_ARRAYP(a)       SCM_TYP16_PREDICATE (scm_tc16_array, a)
  57 #define SCM_ARRAY_NDIM(x)   ((size_t) (SCM_CELL_WORD_0 (x) >> 17))
  58 #define SCM_ARRAY_CONTP(x)  (SCM_CELL_WORD_0 (x) & SCM_ARRAY_FLAG_CONTIGUOUS)
  59 #define SCM_SET_ARRAY_CONTIGUOUS_FLAG(x) \
  60   (SCM_SET_CELL_WORD_0 ((x), SCM_CELL_WORD_0 (x) | SCM_ARRAY_FLAG_CONTIGUOUS))
  61 #define SCM_CLR_ARRAY_CONTIGUOUS_FLAG(x) \
  62   (SCM_SET_CELL_WORD_0 ((x), SCM_CELL_WORD_0 (x) & ~SCM_ARRAY_FLAG_CONTIGUOUS))
  63
  64 #define SCM_ARRAY_MEM(a)  ((scm_t_array *) SCM_CELL_WORD_1 (a))
  65 #define SCM_ARRAY_V(a)    (SCM_ARRAY_MEM (a)->v)
  66 #define SCM_ARRAY_BASE(a) (SCM_ARRAY_MEM (a)->base)
  67 #define SCM_ARRAY_DIMS(a) ((scm_t_array_dim *)((char *) SCM_ARRAY_MEM (a) + sizeof (scm_t_array)))
  68
  69 #define SCM_I_MAX_LENGTH  ((unsigned long) (-1L) >> 8)
  70
  71 #define SCM_UVECTOR_BASE(x) ((void *) (SCM_CELL_WORD_1 (x)))
  72 #define SCM_SET_UVECTOR_BASE(v, b) (SCM_SET_CELL_WORD_1 ((v), (b)))
  73 #define SCM_UVECTOR_MAX_LENGTH SCM_I_MAX_LENGTH
  74 #define SCM_UVECTOR_LENGTH(x) (((unsigned long) SCM_CELL_WORD_0 (x)) >> 8)
  75 #define SCM_MAKE_UVECTOR_TAG(l, t)  (((l) << 8) + (t))
  76 #define SCM_SET_UVECTOR_LENGTH(v, l, t) (SCM_SET_CELL_WORD_0 ((v), SCM_MAKE_UVECTOR_TAG(l, t)))
  77
  78 #define SCM_BITVECTOR_P(x) (!SCM_IMP (x) && (SCM_TYP7 (x) == scm_tc7_bvect))
  79 #define SCM_BITVECTOR_BASE(x) ((unsigned long *) (SCM_CELL_WORD_1 (x)))
  80 #define SCM_SET_BITVECTOR_BASE(v, b) (SCM_SET_CELL_WORD_1 ((v), (b)))
  81 #define SCM_BITVECTOR_MAX_LENGTH SCM_I_MAX_LENGTH
  82 #define SCM_BITVECTOR_LENGTH(x) (((unsigned long) SCM_CELL_WORD_0 (x)) >> 8)
  83 #define SCM_MAKE_BITVECTOR_TAG(l)  (((l) << 8) + scm_tc7_bvect)
  84 #define SCM_SET_BITVECTOR_LENGTH(v, l) (SCM_SET_CELL_WORD_0 ((v), SCM_MAKE_BITVECTOR_TAG (l)))
  85
  86 \f
  87
  88 SCM_API size_t scm_uniform_element_size (SCM obj);
  89 SCM_API SCM scm_make_uve (long k, SCM prot);
  90 SCM_API SCM scm_uniform_vector_length (SCM v);
  91 SCM_API SCM scm_array_p (SCM v, SCM prot);
  92 SCM_API SCM scm_array_rank (SCM ra);
  93 SCM_API SCM scm_array_dimensions (SCM ra);
  94 SCM_API SCM scm_shared_array_root (SCM ra);
  95 SCM_API SCM scm_shared_array_offset (SCM ra);
  96 SCM_API SCM scm_shared_array_increments (SCM ra);
  97 SCM_API long scm_aind (SCM ra, SCM args, const char *what);
  98 SCM_API SCM scm_make_ra (int ndim);
  99 SCM_API SCM scm_shap2ra (SCM args, const char *what);
 100 SCM_API SCM scm_dimensions_to_uniform_array (SCM dims, SCM prot, SCM fill);
 101 SCM_API void scm_ra_set_contp (SCM ra);
 102 SCM_API SCM scm_make_shared_array (SCM oldra, SCM mapfunc, SCM dims);
 103 SCM_API SCM scm_transpose_array (SCM ra, SCM args);
 104 SCM_API SCM scm_enclose_array (SCM ra, SCM axes);
 105 SCM_API SCM scm_array_in_bounds_p (SCM v, SCM args);
 106 SCM_API SCM scm_uniform_vector_ref (SCM v, SCM args);
 107 SCM_API SCM scm_cvref (SCM v, unsigned long pos, SCM last);
 108 SCM_API SCM scm_array_set_x (SCM v, SCM obj, SCM args);
 109 SCM_API SCM scm_array_contents (SCM ra, SCM strict);
 110 SCM_API SCM scm_ra2contig (SCM ra, int copy);
 111 SCM_API SCM scm_uniform_array_read_x (SCM ra, SCM port_or_fd, SCM start, SCM end);
 112 SCM_API SCM scm_uniform_array_write (SCM v, SCM port_or_fd, SCM start, SCM end);
 113 SCM_API SCM scm_bit_count (SCM item, SCM seq);
 114 SCM_API SCM scm_bit_position (SCM item, SCM v, SCM k);
 115 SCM_API SCM scm_bit_set_star_x (SCM v, SCM kv, SCM obj);
 116 SCM_API SCM scm_bit_count_star (SCM v, SCM kv, SCM obj);
 117 SCM_API SCM scm_bit_invert_x (SCM v);
 118 SCM_API SCM scm_istr2bve (char *str, long len);
 119 SCM_API SCM scm_array_to_list (SCM v);
 120 SCM_API SCM scm_list_to_uniform_array (SCM ndim, SCM prot, SCM lst);
 121 SCM_API int scm_raprin1 (SCM exp, SCM port, scm_print_state *pstate);
 122 SCM_API SCM scm_array_prototype (SCM ra);
 123 SCM_API void scm_init_unif (void);
 124
 125 #endif  /* SCM_UNIF_H */
 126
 127 /*
 128   Local Variables:
 129   c-file-style: "gnu"
 130   End:
 131 */