libguile/srfi-4.h

   1 #ifndef SCM_SRFI_4_H
   2 #define SCM_SRFI_4_H
   3 /* srfi-4.c --- Homogeneous numeric vector datatypes.
   4  *
   5  *      Copyright (C) 2001, 2004, 2006, 2008 Free Software Foundation, Inc.
   6  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Lesser General Public License
   9  * as published by the Free Software Foundation; either version 3 of
  10  * the License, or (at your option) any later version.
  11  *
  12  * This library is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Lesser General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Lesser General Public
  18  * License along with this library; if not, write to the Free Software
  19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  20  * 02110-1301 USA
  21  */
  22 \f
  23
  24 #include "libguile/__scm.h"
  25 #include "libguile/unif.h"
  26
  27 /* Generic procedures.
  28  */
  29
  30 SCM_API SCM scm_uniform_vector_p (SCM v);
  31 SCM_API SCM scm_uniform_vector_length (SCM v);
  32 SCM_API SCM scm_uniform_vector_ref (SCM v, SCM idx);
  33 SCM_API SCM scm_uniform_vector_set_x (SCM v, SCM idx, SCM val);
  34 SCM_API SCM scm_uniform_vector_to_list (SCM v);
  35 SCM_API SCM scm_uniform_vector_read_x (SCM v, SCM port_or_fd,
  36                                        SCM start, SCM end);
  37 SCM_API SCM scm_uniform_vector_write (SCM v, SCM port_or_fd,
  38                                       SCM start, SCM end);
  39
  40 SCM_API int scm_is_uniform_vector (SCM obj);
  41 SCM_API size_t scm_c_uniform_vector_length (SCM v);
  42 SCM_API SCM scm_c_uniform_vector_ref (SCM v, size_t idx);
  43 SCM_API void scm_c_uniform_vector_set_x (SCM v, size_t idx, SCM val);
  44 SCM_API size_t scm_array_handle_uniform_element_size (scm_t_array_handle *h);
  45 SCM_API const void *scm_array_handle_uniform_elements (scm_t_array_handle *h);
  46 SCM_API void *scm_array_handle_uniform_writable_elements (scm_t_array_handle *h);
  47 SCM_API const void *scm_uniform_vector_elements (SCM uvec,
  48                                                  scm_t_array_handle *h,
  49                                                  size_t *lenp, ssize_t *incp);
  50 SCM_API void *scm_uniform_vector_writable_elements (SCM uvec,
  51                                                     scm_t_array_handle *h,
  52                                                     size_t *lenp,
  53                                                     ssize_t *incp);
  54
  55 /* Specific procedures.
  56  */
  57
  58 SCM_API SCM scm_u8vector_p (SCM obj);
  59 SCM_API SCM scm_make_u8vector (SCM n, SCM fill);
  60 SCM_API SCM scm_take_u8vector (scm_t_uint8 *data, size_t n);
  61 SCM_API SCM scm_u8vector (SCM l);
  62 SCM_API SCM scm_u8vector_length (SCM uvec);
  63 SCM_API SCM scm_u8vector_ref (SCM uvec, SCM index);
  64 SCM_API SCM scm_u8vector_set_x (SCM uvec, SCM index, SCM value);
  65 SCM_API SCM scm_u8vector_to_list (SCM uvec);
  66 SCM_API SCM scm_list_to_u8vector (SCM l);
  67 SCM_API SCM scm_any_to_u8vector (SCM obj);
  68 SCM_API const scm_t_uint8 *scm_array_handle_u8_elements (scm_t_array_handle *h);
  69 SCM_API scm_t_uint8 *scm_array_handle_u8_writable_elements (scm_t_array_handle *h);
  70 SCM_API const scm_t_uint8 *scm_u8vector_elements (SCM uvec,
  71                                                   scm_t_array_handle *h,
  72                                                   size_t *lenp, ssize_t *incp);
  73 SCM_API scm_t_uint8 *scm_u8vector_writable_elements (SCM uvec,
  74                                                      scm_t_array_handle *h,
  75                                                      size_t *lenp,
  76                                                      ssize_t *incp);
  77
  78 SCM_API SCM scm_s8vector_p (SCM obj);
  79 SCM_API SCM scm_make_s8vector (SCM n, SCM fill);
  80 SCM_API SCM scm_take_s8vector (scm_t_int8 *data, size_t n);
  81 SCM_API SCM scm_s8vector (SCM l);
  82 SCM_API SCM scm_s8vector_length (SCM uvec);
  83 SCM_API SCM scm_s8vector_ref (SCM uvec, SCM index);
  84 SCM_API SCM scm_s8vector_set_x (SCM uvec, SCM index, SCM value);
  85 SCM_API SCM scm_s8vector_to_list (SCM uvec);
  86 SCM_API SCM scm_list_to_s8vector (SCM l);
  87 SCM_API SCM scm_any_to_s8vector (SCM obj);
  88 SCM_API const scm_t_int8 *scm_array_handle_s8_elements (scm_t_array_handle *h);
  89 SCM_API scm_t_int8 *scm_array_handle_s8_writable_elements (scm_t_array_handle *h);
  90 SCM_API const scm_t_int8 *scm_s8vector_elements (SCM uvec,
  91                                                  scm_t_array_handle *h,
  92                                                  size_t *lenp, ssize_t *incp);
  93 SCM_API scm_t_int8 *scm_s8vector_writable_elements (SCM uvec,
  94                                                     scm_t_array_handle *h,
  95                                                     size_t *lenp,
  96                                                     ssize_t *incp);
  97
  98 SCM_API SCM scm_u16vector_p (SCM obj);
  99 SCM_API SCM scm_make_u16vector (SCM n, SCM fill);
 100 SCM_API SCM scm_take_u16vector (scm_t_uint16 *data, size_t n);
 101 SCM_API SCM scm_u16vector (SCM l);
 102 SCM_API SCM scm_u16vector_length (SCM uvec);
 103 SCM_API SCM scm_u16vector_ref (SCM uvec, SCM index);
 104 SCM_API SCM scm_u16vector_set_x (SCM uvec, SCM index, SCM value);
 105 SCM_API SCM scm_u16vector_to_list (SCM uvec);
 106 SCM_API SCM scm_list_to_u16vector (SCM l);
 107 SCM_API SCM scm_any_to_u16vector (SCM obj);
 108 SCM_API const scm_t_uint16 *scm_array_handle_u16_elements (scm_t_array_handle *h);
 109 SCM_API scm_t_uint16 *scm_array_handle_u16_writable_elements (scm_t_array_handle *h);
 110 SCM_API const scm_t_uint16 *scm_u16vector_elements (SCM uvec,
 111                                                     scm_t_array_handle *h,
 112                                                     size_t *lenp,
 113                                                     ssize_t *incp);
 114 SCM_API scm_t_uint16 *scm_u16vector_writable_elements (SCM uvec,
 115                                                        scm_t_array_handle *h,
 116                                                        size_t *lenp,
 117                                                        ssize_t *incp);
 118
 119 SCM_API SCM scm_s16vector_p (SCM obj);
 120 SCM_API SCM scm_make_s16vector (SCM n, SCM fill);
 121 SCM_API SCM scm_take_s16vector (scm_t_int16 *data, size_t n);
 122 SCM_API SCM scm_s16vector (SCM l);
 123 SCM_API SCM scm_s16vector_length (SCM uvec);
 124 SCM_API SCM scm_s16vector_ref (SCM uvec, SCM index);
 125 SCM_API SCM scm_s16vector_set_x (SCM uvec, SCM index, SCM value);
 126 SCM_API SCM scm_s16vector_to_list (SCM uvec);
 127 SCM_API SCM scm_list_to_s16vector (SCM l);
 128 SCM_API SCM scm_any_to_s16vector (SCM obj);
 129 SCM_API const scm_t_int16 *scm_array_handle_s16_elements (scm_t_array_handle *h);
 130 SCM_API scm_t_int16 *scm_array_handle_s16_writable_elements (scm_t_array_handle *h);
 131 SCM_API const scm_t_int16 *scm_s16vector_elements (SCM uvec,
 132                                                    scm_t_array_handle *h,
 133                                                    size_t *lenp, ssize_t *incp);
 134 SCM_API scm_t_int16 *scm_s16vector_writable_elements (SCM uvec,
 135                                                       scm_t_array_handle *h,
 136                                                       size_t *lenp,
 137                                                       ssize_t *incp);
 138
 139 SCM_API SCM scm_u32vector_p (SCM obj);
 140 SCM_API SCM scm_make_u32vector (SCM n, SCM fill);
 141 SCM_API SCM scm_take_u32vector (scm_t_uint32 *data, size_t n);
 142 SCM_API SCM scm_u32vector (SCM l);
 143 SCM_API SCM scm_u32vector_length (SCM uvec);
 144 SCM_API SCM scm_u32vector_ref (SCM uvec, SCM index);
 145 SCM_API SCM scm_u32vector_set_x (SCM uvec, SCM index, SCM value);
 146 SCM_API SCM scm_u32vector_to_list (SCM uvec);
 147 SCM_API SCM scm_list_to_u32vector (SCM l);
 148 SCM_API SCM scm_any_to_u32vector (SCM obj);
 149 SCM_API const scm_t_uint32 *scm_array_handle_u32_elements (scm_t_array_handle *h);
 150 SCM_API scm_t_uint32 *scm_array_handle_u32_writable_elements (scm_t_array_handle *h);
 151 SCM_API const scm_t_uint32 *scm_u32vector_elements (SCM uvec,
 152                                                     scm_t_array_handle *h,
 153                                                     size_t *lenp,
 154                                                     ssize_t *incp);
 155 SCM_API scm_t_uint32 *scm_u32vector_writable_elements (SCM uvec,
 156                                                        scm_t_array_handle *h,
 157                                                        size_t *lenp,
 158                                                        ssize_t *incp);
 159
 160 SCM_API SCM scm_s32vector_p (SCM obj);
 161 SCM_API SCM scm_make_s32vector (SCM n, SCM fill);
 162 SCM_API SCM scm_take_s32vector (scm_t_int32 *data, size_t n);
 163 SCM_API SCM scm_s32vector (SCM l);
 164 SCM_API SCM scm_s32vector_length (SCM uvec);
 165 SCM_API SCM scm_s32vector_ref (SCM uvec, SCM index);
 166 SCM_API SCM scm_s32vector_set_x (SCM uvec, SCM index, SCM value);
 167 SCM_API SCM scm_s32vector_to_list (SCM uvec);
 168 SCM_API SCM scm_list_to_s32vector (SCM l);
 169 SCM_API SCM scm_any_to_s32vector (SCM obj);
 170 SCM_API const scm_t_int32 *scm_array_handle_s32_elements (scm_t_array_handle *h);
 171 SCM_API scm_t_int32 *scm_array_handle_s32_writable_elements (scm_t_array_handle *h);
 172 SCM_API const scm_t_int32 *scm_s32vector_elements (SCM uvec,
 173                                                    scm_t_array_handle *h,
 174                                                    size_t *lenp, ssize_t *incp);
 175 SCM_API scm_t_int32 *scm_s32vector_writable_elements (SCM uvec,
 176                                                       scm_t_array_handle *h,
 177                                                       size_t *lenp,
 178                                                       ssize_t *incp);
 179
 180 SCM_API SCM scm_u64vector_p (SCM obj);
 181 SCM_API SCM scm_make_u64vector (SCM n, SCM fill);
 182 SCM_API SCM scm_u64vector (SCM l);
 183 SCM_API SCM scm_u64vector_length (SCM uvec);
 184 SCM_API SCM scm_u64vector_ref (SCM uvec, SCM index);
 185 SCM_API SCM scm_u64vector_set_x (SCM uvec, SCM index, SCM value);
 186 SCM_API SCM scm_u64vector_to_list (SCM uvec);
 187 SCM_API SCM scm_list_to_u64vector (SCM l);
 188 SCM_API SCM scm_any_to_u64vector (SCM obj);
 189
 190 #if SCM_HAVE_T_UINT64
 191 SCM_API SCM scm_take_u64vector (scm_t_uint64 *data, size_t n);
 192 SCM_API const scm_t_uint64 *scm_array_handle_u64_elements (scm_t_array_handle *h);
 193 SCM_API scm_t_uint64 *scm_array_handle_u64_writable_elements (scm_t_array_handle *h);
 194 SCM_API const scm_t_uint64 *scm_u64vector_elements (SCM uvec,
 195                                                     scm_t_array_handle *h,
 196                                                     size_t *lenp,
 197                                                     ssize_t *incp);
 198 SCM_API scm_t_uint64 *scm_u64vector_writable_elements (SCM uvec,
 199                                                        scm_t_array_handle *h,
 200                                                        size_t *lenp,
 201                                                        ssize_t *incp);
 202 #endif
 203
 204 SCM_API SCM scm_s64vector_p (SCM obj);
 205 SCM_API SCM scm_make_s64vector (SCM n, SCM fill);
 206 SCM_API SCM scm_s64vector (SCM l);
 207 SCM_API SCM scm_s64vector_length (SCM uvec);
 208 SCM_API SCM scm_s64vector_ref (SCM uvec, SCM index);
 209 SCM_API SCM scm_s64vector_set_x (SCM uvec, SCM index, SCM value);
 210 SCM_API SCM scm_s64vector_to_list (SCM uvec);
 211 SCM_API SCM scm_list_to_s64vector (SCM l);
 212 SCM_API SCM scm_any_to_s64vector (SCM obj);
 213
 214 #if SCM_HAVE_T_INT64
 215 SCM_API SCM scm_take_s64vector (scm_t_int64 *data, size_t n);
 216 SCM_API const scm_t_int64 *scm_array_handle_s64_elements (scm_t_array_handle *h);
 217 SCM_API scm_t_int64 *scm_array_handle_s64_writable_elements (scm_t_array_handle *h);
 218 SCM_API const scm_t_int64 *scm_s64vector_elements (SCM uvec,
 219                                                    scm_t_array_handle *h,
 220                                                    size_t *lenp, ssize_t *incp);
 221 SCM_API scm_t_int64 *scm_s64vector_writable_elements (SCM uvec,
 222                                                       scm_t_array_handle *h,
 223                                                       size_t *lenp,
 224                                                       ssize_t *incp);
 225 #endif
 226
 227 SCM_API SCM scm_f32vector_p (SCM obj);
 228 SCM_API SCM scm_make_f32vector (SCM n, SCM fill);
 229 SCM_API SCM scm_take_f32vector (float *data, size_t n);
 230 SCM_API SCM scm_f32vector (SCM l);
 231 SCM_API SCM scm_f32vector_length (SCM uvec);
 232 SCM_API SCM scm_f32vector_ref (SCM uvec, SCM index);
 233 SCM_API SCM scm_f32vector_set_x (SCM uvec, SCM index, SCM value);
 234 SCM_API SCM scm_f32vector_to_list (SCM uvec);
 235 SCM_API SCM scm_list_to_f32vector (SCM l);
 236 SCM_API SCM scm_any_to_f32vector (SCM obj);
 237 SCM_API const float *scm_array_handle_f32_elements (scm_t_array_handle *h);
 238 SCM_API float *scm_array_handle_f32_writable_elements (scm_t_array_handle *h);
 239 SCM_API const float *scm_f32vector_elements (SCM uvec,
 240                                             scm_t_array_handle *h,
 241                                             size_t *lenp, ssize_t *incp);
 242 SCM_API float *scm_f32vector_writable_elements (SCM uvec,
 243                                                 scm_t_array_handle *h,
 244                                                 size_t *lenp,
 245                                                 ssize_t *incp);
 246
 247 SCM_API SCM scm_f64vector_p (SCM obj);
 248 SCM_API SCM scm_make_f64vector (SCM n, SCM fill);
 249 SCM_API SCM scm_take_f64vector (double *data, size_t n);
 250 SCM_API SCM scm_f64vector (SCM l);
 251 SCM_API SCM scm_f64vector_length (SCM uvec);
 252 SCM_API SCM scm_f64vector_ref (SCM uvec, SCM index);
 253 SCM_API SCM scm_f64vector_set_x (SCM uvec, SCM index, SCM value);
 254 SCM_API SCM scm_f64vector_to_list (SCM uvec);
 255 SCM_API SCM scm_list_to_f64vector (SCM l);
 256 SCM_API SCM scm_any_to_f64vector (SCM obj);
 257 SCM_API const double *scm_array_handle_f64_elements (scm_t_array_handle *h);
 258 SCM_API double *scm_array_handle_f64_writable_elements (scm_t_array_handle *h);
 259 SCM_API const double *scm_f64vector_elements (SCM uvec,
 260                                               scm_t_array_handle *h,
 261                                               size_t *lenp, ssize_t *incp);
 262 SCM_API double *scm_f64vector_writable_elements (SCM uvec,
 263                                                  scm_t_array_handle *h,
 264                                                  size_t *lenp,
 265                                                  ssize_t *incp);
 266
 267 SCM_API SCM scm_c32vector_p (SCM obj);
 268 SCM_API SCM scm_make_c32vector (SCM n, SCM fill);
 269 SCM_API SCM scm_take_c32vector (float *data, size_t n);
 270 SCM_API SCM scm_c32vector (SCM l);
 271 SCM_API SCM scm_c32vector_length (SCM uvec);
 272 SCM_API SCM scm_c32vector_ref (SCM uvec, SCM index);
 273 SCM_API SCM scm_c32vector_set_x (SCM uvec, SCM index, SCM value);
 274 SCM_API SCM scm_c32vector_to_list (SCM uvec);
 275 SCM_API SCM scm_list_to_c32vector (SCM l);
 276 SCM_API SCM scm_any_to_c32vector (SCM obj);
 277 SCM_API const float *scm_array_handle_c32_elements (scm_t_array_handle *h);
 278 SCM_API float *scm_array_handle_c32_writable_elements (scm_t_array_handle *h);
 279 SCM_API const float *scm_c32vector_elements (SCM uvec,
 280                                              scm_t_array_handle *h,
 281                                              size_t *lenp, ssize_t *incp);
 282 SCM_API float *scm_c32vector_writable_elements (SCM uvec,
 283                                                 scm_t_array_handle *h,
 284                                                 size_t *lenp,
 285                                                 ssize_t *incp);
 286
 287 SCM_API SCM scm_c64vector_p (SCM obj);
 288 SCM_API SCM scm_make_c64vector (SCM n, SCM fill);
 289 SCM_API SCM scm_take_c64vector (double *data, size_t n);
 290 SCM_API SCM scm_c64vector (SCM l);
 291 SCM_API SCM scm_c64vector_length (SCM uvec);
 292 SCM_API SCM scm_c64vector_ref (SCM uvec, SCM index);
 293 SCM_API SCM scm_c64vector_set_x (SCM uvec, SCM index, SCM value);
 294 SCM_API SCM scm_c64vector_to_list (SCM uvec);
 295 SCM_API SCM scm_list_to_c64vector (SCM l);
 296 SCM_API SCM scm_any_to_c64vector (SCM obj);
 297 SCM_API const double *scm_array_handle_c64_elements (scm_t_array_handle *h);
 298 SCM_API double *scm_array_handle_c64_writable_elements (scm_t_array_handle *h);
 299 SCM_API const double *scm_c64vector_elements (SCM uvec,
 300                                               scm_t_array_handle *h,
 301                                               size_t *lenp, ssize_t *incp);
 302 SCM_API double *scm_c64vector_writable_elements (SCM uvec,
 303                                                  scm_t_array_handle *h,
 304                                                  size_t *lenp,
 305                                                  ssize_t *incp);
 306
 307 SCM_INTERNAL SCM scm_i_generalized_vector_type (SCM vec);
 308 SCM_INTERNAL const char *scm_i_uniform_vector_tag (SCM uvec);
 309 SCM_INTERNAL scm_i_t_array_ref scm_i_uniform_vector_ref_proc (SCM uvec);
 310 SCM_INTERNAL scm_i_t_array_set scm_i_uniform_vector_set_proc (SCM uvec);
 311
 312 #if SCM_ENABLE_DEPRECATED
 313
 314 /* Deprecated because we want people to use the scm_t_array_handle
 315    interface.
 316 */
 317
 318 SCM_API size_t scm_uniform_element_size (SCM obj);
 319
 320 #endif
 321
 322 SCM_INTERNAL void scm_init_srfi_4 (void);
 323
 324 #endif /* SCM_SRFI_4_H */