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, 2004, 2006 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 21 */ 22 23 24 25 #include "libguile/__scm.h" 26 #include "libguile/print.h" 27 28 29 30 /* This file contains the definitions for arrays and bit vectors. 31 Uniform numeric vectors are now in srfi-4.c. 32 */ 33 34 35 /** Arrays */ 36 37 typedef struct scm_t_array_dim 38 { 39 ssize_t lbnd; 40 ssize_t ubnd; 41 ssize_t inc; 42 } scm_t_array_dim; 43 44 SCM_API SCM scm_array_p (SCM v, SCM prot); 45 SCM_API SCM scm_typed_array_p (SCM v, SCM type); 46 SCM_API SCM scm_make_array (SCM fill, SCM bounds); 47 SCM_API SCM scm_make_typed_array (SCM type, SCM fill, SCM bounds); 48 SCM_API SCM scm_array_rank (SCM ra); 49 SCM_API size_t scm_c_array_rank (SCM ra); 50 SCM_API SCM scm_array_dimensions (SCM ra); 51 SCM_API SCM scm_shared_array_root (SCM ra); 52 SCM_API SCM scm_shared_array_offset (SCM ra); 53 SCM_API SCM scm_shared_array_increments (SCM ra); 54 SCM_API SCM scm_make_shared_array (SCM oldra, SCM mapfunc, SCM dims); 55 SCM_API SCM scm_transpose_array (SCM ra, SCM args); 56 SCM_API SCM scm_enclose_array (SCM ra, SCM axes); 57 SCM_API SCM scm_array_in_bounds_p (SCM v, SCM args); 58 SCM_API SCM scm_array_ref (SCM v, SCM args); 59 SCM_API SCM scm_array_set_x (SCM v, SCM obj, SCM args); 60 SCM_API SCM scm_array_contents (SCM ra, SCM strict); 61 SCM_API SCM scm_uniform_array_read_x (SCM ra, SCM port_or_fd, 62 SCM start, SCM end); 63 SCM_API SCM scm_uniform_array_write (SCM v, SCM port_or_fd, 64 SCM start, SCM end); 65 SCM_API SCM scm_array_to_list (SCM v); 66 SCM_API SCM scm_list_to_array (SCM ndim, SCM lst); 67 SCM_API SCM scm_list_to_typed_array (SCM type, SCM ndim, SCM lst); 68 SCM_API SCM scm_array_type (SCM ra); 69 70 SCM_API int scm_is_array (SCM obj); 71 SCM_API int scm_is_typed_array (SCM obj, SCM type); 72 73 SCM_API SCM scm_ra2contig (SCM ra, int copy); 74 75 struct scm_t_array_handle; 76 77 typedef SCM (*scm_i_t_array_ref) (struct scm_t_array_handle *, ssize_t); 78 typedef void (*scm_i_t_array_set) (struct scm_t_array_handle *, ssize_t, SCM); 79 80 typedef struct scm_t_array_handle { 81 SCM array; 82 size_t base; 83 scm_t_array_dim *dims; 84 scm_t_array_dim dim0; 85 scm_i_t_array_ref ref; 86 scm_i_t_array_set set; 87 const void *elements; 88 void *writable_elements; 89 } scm_t_array_handle; 90 91 SCM_API void scm_array_get_handle (SCM array, scm_t_array_handle *h); 92 SCM_API size_t scm_array_handle_rank (scm_t_array_handle *h); 93 SCM_API scm_t_array_dim *scm_array_handle_dims (scm_t_array_handle *h); 94 SCM_API ssize_t scm_array_handle_pos (scm_t_array_handle *h, SCM indices); 95 SCM_API const SCM *scm_array_handle_elements (scm_t_array_handle *h); 96 SCM_API SCM *scm_array_handle_writable_elements (scm_t_array_handle *h); 97 SCM_API void scm_array_handle_release (scm_t_array_handle *h); 98 99 /* See inline.h for scm_array_handle_ref and scm_array_handle_set */ 100 101 102 /** Bit vectors */ 103 104 SCM_API SCM scm_bitvector_p (SCM vec); 105 SCM_API SCM scm_bitvector (SCM bits); 106 SCM_API SCM scm_make_bitvector (SCM len, SCM fill); 107 SCM_API SCM scm_bitvector_length (SCM vec); 108 SCM_API SCM scm_bitvector_ref (SCM vec, SCM idx); 109 SCM_API SCM scm_bitvector_set_x (SCM vec, SCM idx, SCM val); 110 SCM_API SCM scm_list_to_bitvector (SCM list); 111 SCM_API SCM scm_bitvector_to_list (SCM vec); 112 SCM_API SCM scm_bitvector_fill_x (SCM vec, SCM val); 113 114 SCM_API SCM scm_bit_count (SCM item, SCM seq); 115 SCM_API SCM scm_bit_position (SCM item, SCM v, SCM k); 116 SCM_API SCM scm_bit_set_star_x (SCM v, SCM kv, SCM obj); 117 SCM_API SCM scm_bit_count_star (SCM v, SCM kv, SCM obj); 118 SCM_API SCM scm_bit_invert_x (SCM v); 119 SCM_API SCM scm_istr2bve (SCM str); 120 121 SCM_API int scm_is_bitvector (SCM obj); 122 SCM_API SCM scm_c_make_bitvector (size_t len, SCM fill); 123 SCM_API size_t scm_c_bitvector_length (SCM vec); 124 SCM_API SCM scm_c_bitvector_ref (SCM vec, size_t idx); 125 SCM_API void scm_c_bitvector_set_x (SCM vec, size_t idx, SCM val); 126 SCM_API const scm_t_uint32 *scm_array_handle_bit_elements (scm_t_array_handle *h); 127 SCM_API scm_t_uint32 *scm_array_handle_bit_writable_elements (scm_t_array_handle *h); 128 SCM_API size_t scm_array_handle_bit_elements_offset (scm_t_array_handle *h); 129 SCM_API const scm_t_uint32 *scm_bitvector_elements (SCM vec, 130 scm_t_array_handle *h, 131 size_t *offp, 132 size_t *lenp, 133 ssize_t *incp); 134 SCM_API scm_t_uint32 *scm_bitvector_writable_elements (SCM vec, 135 scm_t_array_handle *h, 136 size_t *offp, 137 size_t *lenp, 138 ssize_t *incp); 139 140 /* internal. */ 141 142 typedef struct scm_i_t_array 143 { 144 SCM v; /* the contents of the array, e.g., a vector or uniform vector. */ 145 unsigned long base; 146 } scm_i_t_array; 147 148 SCM_API scm_t_bits scm_i_tc16_array; 149 SCM_API scm_t_bits scm_i_tc16_enclosed_array; 150 151 #define SCM_I_ARRAY_FLAG_CONTIGUOUS (1 << 16) 152 153 #define SCM_I_ARRAYP(a) SCM_TYP16_PREDICATE (scm_i_tc16_array, a) 154 #define SCM_I_ENCLOSED_ARRAYP(a) \ 155 SCM_TYP16_PREDICATE (scm_i_tc16_enclosed_array, a) 156 #define SCM_I_ARRAY_NDIM(x) ((size_t) (SCM_CELL_WORD_0 (x) >> 17)) 157 #define SCM_I_ARRAY_CONTP(x) (SCM_CELL_WORD_0(x) & SCM_I_ARRAY_FLAG_CONTIGUOUS) 158 159 #define SCM_I_ARRAY_MEM(a) ((scm_i_t_array *) SCM_CELL_WORD_1 (a)) 160 #define SCM_I_ARRAY_V(a) (SCM_I_ARRAY_MEM (a)->v) 161 #define SCM_I_ARRAY_BASE(a) (SCM_I_ARRAY_MEM (a)->base) 162 #define SCM_I_ARRAY_DIMS(a) \ 163 ((scm_t_array_dim *)((char *) SCM_I_ARRAY_MEM (a) + sizeof (scm_i_t_array))) 164 165 SCM_API SCM scm_i_make_ra (int ndim, int enclosed); 166 SCM_API SCM scm_i_cvref (SCM v, size_t p, int enclosed); 167 SCM_API SCM scm_i_read_array (SCM port, int c); 168 169 /* deprecated. */ 170 171 #if SCM_ENABLE_DEPRECATED 172 173 SCM_API SCM scm_make_uve (long k, SCM prot); 174 SCM_API SCM scm_array_prototype (SCM ra); 175 SCM_API SCM scm_list_to_uniform_array (SCM ndim, SCM prot, SCM lst); 176 SCM_API SCM scm_dimensions_to_uniform_array (SCM dims, SCM prot, SCM fill); 177 SCM_API SCM scm_make_ra (int ndim); 178 SCM_API SCM scm_shap2ra (SCM args, const char *what); 179 SCM_API SCM scm_cvref (SCM v, unsigned long pos, SCM last); 180 SCM_API void scm_ra_set_contp (SCM ra); 181 SCM_API long scm_aind (SCM ra, SCM args, const char *what); 182 SCM_API int scm_raprin1 (SCM exp, SCM port, scm_print_state *pstate); 183 184 #endif 185 186 SCM_API void scm_init_unif (void); 187 188 #endif /* SCM_UNIF_H */ 189 190 /* 191 Local Variables: 192 c-file-style: "gnu" 193 End: 194 */ 195