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 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
   9  * License as published by the Free Software Foundation; either
  10  * version 2.1 of the License, or (at your option) any later version.
  11  *
  12  * This library 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 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  20  */
  21 \f
  22
  23 #include "libguile/__scm.h"
  24
  25 /* Generic procedures.
  26  */
  27
  28 SCM_API SCM scm_uniform_vector_p (SCM v);
  29 SCM_API SCM scm_uniform_vector_length (SCM v);
  30 SCM_API SCM scm_uniform_vector_ref (SCM v, SCM idx);
  31 SCM_API SCM scm_uniform_vector_set_x (SCM v, SCM idx, SCM val);
  32 SCM_API SCM scm_uniform_vector_to_list (SCM v);
  33 SCM_API SCM scm_uniform_vector_read_x (SCM v, SCM port_or_fd,
  34                                        SCM start, SCM end);
  35 SCM_API SCM scm_uniform_vector_write (SCM v, SCM port_or_fd,
  36                                       SCM start, SCM end);
  37
  38 SCM_API int scm_is_uniform_vector (SCM obj);
  39 SCM_API size_t scm_c_uniform_vector_length (SCM v);
  40 SCM_API size_t scm_c_uniform_vector_size (SCM v);
  41 SCM_API SCM scm_c_uniform_vector_ref (SCM v, size_t idx);
  42 SCM_API void scm_c_uniform_vector_set_x (SCM v, size_t idx, SCM val);
  43
  44 SCM_API size_t scm_uniform_vector_element_size (SCM uvec);
  45 SCM_API const void *scm_uniform_vector_elements (SCM uvec);
  46 SCM_API void scm_uniform_vector_release_elements (SCM uvec);
  47 SCM_API void scm_frame_uniform_vector_release_elements (SCM uvec);
  48 SCM_API void *scm_uniform_vector_writable_elements (SCM uvec);
  49 SCM_API void scm_uniform_vector_release_writable_elements (SCM uvec);
  50 SCM_API void scm_frame_uniform_vector_release_writable_elements (SCM uvec);
  51
  52 /* Specific procedures.
  53  */
  54
  55 SCM_API SCM scm_u8vector_p (SCM obj);
  56 SCM_API SCM scm_make_u8vector (SCM n, SCM fill);
  57 SCM_API SCM scm_take_u8vector (const scm_t_uint8 *data, size_t n);
  58 SCM_API SCM scm_u8vector (SCM l);
  59 SCM_API SCM scm_u8vector_length (SCM uvec);
  60 SCM_API SCM scm_u8vector_ref (SCM uvec, SCM index);
  61 SCM_API SCM scm_u8vector_set_x (SCM uvec, SCM index, SCM value);
  62 SCM_API SCM scm_u8vector_to_list (SCM uvec);
  63 SCM_API SCM scm_list_to_u8vector (SCM l);
  64 SCM_API SCM scm_any_to_u8vector (SCM obj);
  65 SCM_API const scm_t_uint8 *scm_u8vector_elements (SCM uvec);
  66 SCM_API scm_t_uint8 *scm_u8vector_writable_elements (SCM uvec);
  67
  68 SCM_API SCM scm_s8vector_p (SCM obj);
  69 SCM_API SCM scm_make_s8vector (SCM n, SCM fill);
  70 SCM_API SCM scm_take_s8vector (const scm_t_int8 *data, size_t n);
  71 SCM_API SCM scm_s8vector (SCM l);
  72 SCM_API SCM scm_s8vector_length (SCM uvec);
  73 SCM_API SCM scm_s8vector_ref (SCM uvec, SCM index);
  74 SCM_API SCM scm_s8vector_set_x (SCM uvec, SCM index, SCM value);
  75 SCM_API SCM scm_s8vector_to_list (SCM uvec);
  76 SCM_API SCM scm_list_to_s8vector (SCM l);
  77 SCM_API SCM scm_any_to_s8vector (SCM obj);
  78 SCM_API const scm_t_int8 *scm_s8vector_elements (SCM uvec);
  79 SCM_API scm_t_int8 *scm_s8vector_writable_elements (SCM uvec);
  80
  81 SCM_API SCM scm_u16vector_p (SCM obj);
  82 SCM_API SCM scm_make_u16vector (SCM n, SCM fill);
  83 SCM_API SCM scm_take_u16vector (const scm_t_uint16 *data, size_t n);
  84 SCM_API SCM scm_u16vector (SCM l);
  85 SCM_API SCM scm_u16vector_length (SCM uvec);
  86 SCM_API SCM scm_u16vector_ref (SCM uvec, SCM index);
  87 SCM_API SCM scm_u16vector_set_x (SCM uvec, SCM index, SCM value);
  88 SCM_API SCM scm_u16vector_to_list (SCM uvec);
  89 SCM_API SCM scm_list_to_u16vector (SCM l);
  90 SCM_API SCM scm_any_to_u16vector (SCM obj);
  91 SCM_API const scm_t_uint16 *scm_u16vector_elements (SCM uvec);
  92 SCM_API scm_t_uint16 *scm_u16vector_writable_elements (SCM uvec);
  93
  94 SCM_API SCM scm_s16vector_p (SCM obj);
  95 SCM_API SCM scm_make_s16vector (SCM n, SCM fill);
  96 SCM_API SCM scm_take_s16vector (const scm_t_int16 *data, size_t n);
  97 SCM_API SCM scm_s16vector (SCM l);
  98 SCM_API SCM scm_s16vector_length (SCM uvec);
  99 SCM_API SCM scm_s16vector_ref (SCM uvec, SCM index);
 100 SCM_API SCM scm_s16vector_set_x (SCM uvec, SCM index, SCM value);
 101 SCM_API SCM scm_s16vector_to_list (SCM uvec);
 102 SCM_API SCM scm_list_to_s16vector (SCM l);
 103 SCM_API SCM scm_any_to_s16vector (SCM obj);
 104 SCM_API const scm_t_int16 *scm_s16vector_elements (SCM uvec);
 105 SCM_API scm_t_int16 *scm_s16vector_writable_elements (SCM uvec);
 106
 107 SCM_API SCM scm_u32vector_p (SCM obj);
 108 SCM_API SCM scm_make_u32vector (SCM n, SCM fill);
 109 SCM_API SCM scm_take_u32vector (const scm_t_uint32 *data, size_t n);
 110 SCM_API SCM scm_u32vector (SCM l);
 111 SCM_API SCM scm_u32vector_length (SCM uvec);
 112 SCM_API SCM scm_u32vector_ref (SCM uvec, SCM index);
 113 SCM_API SCM scm_u32vector_set_x (SCM uvec, SCM index, SCM value);
 114 SCM_API SCM scm_u32vector_to_list (SCM uvec);
 115 SCM_API SCM scm_list_to_u32vector (SCM l);
 116 SCM_API SCM scm_any_to_u32vector (SCM obj);
 117 SCM_API const scm_t_uint32 *scm_u32vector_elements (SCM uvec);
 118 SCM_API scm_t_uint32 *scm_u32vector_writable_elements (SCM uvec);
 119
 120 SCM_API SCM scm_s32vector_p (SCM obj);
 121 SCM_API SCM scm_make_s32vector (SCM n, SCM fill);
 122 SCM_API SCM scm_take_s32vector (const scm_t_int32 *data, size_t n);
 123 SCM_API SCM scm_s32vector (SCM l);
 124 SCM_API SCM scm_s32vector_length (SCM uvec);
 125 SCM_API SCM scm_s32vector_ref (SCM uvec, SCM index);
 126 SCM_API SCM scm_s32vector_set_x (SCM uvec, SCM index, SCM value);
 127 SCM_API SCM scm_s32vector_to_list (SCM uvec);
 128 SCM_API SCM scm_list_to_s32vector (SCM l);
 129 SCM_API SCM scm_any_to_s32vector (SCM obj);
 130 SCM_API const scm_t_int32 *scm_s32vector_elements (SCM uvec);
 131 SCM_API scm_t_int32 *scm_s32vector_writable_elements (SCM uvec);
 132
 133 SCM_API SCM scm_u64vector_p (SCM obj);
 134 SCM_API SCM scm_make_u64vector (SCM n, SCM fill);
 135 SCM_API SCM scm_take_u64vector (const scm_t_uint64 *data, size_t n);
 136 SCM_API SCM scm_u64vector (SCM l);
 137 SCM_API SCM scm_u64vector_length (SCM uvec);
 138 SCM_API SCM scm_u64vector_ref (SCM uvec, SCM index);
 139 SCM_API SCM scm_u64vector_set_x (SCM uvec, SCM index, SCM value);
 140 SCM_API SCM scm_u64vector_to_list (SCM uvec);
 141 SCM_API SCM scm_list_to_u64vector (SCM l);
 142 SCM_API SCM scm_any_to_u64vector (SCM obj);
 143 SCM_API const scm_t_uint64 *scm_u64vector_elements (SCM uvec);
 144 SCM_API scm_t_uint64 *scm_u64vector_writable_elements (SCM uvec);
 145
 146 SCM_API SCM scm_s64vector_p (SCM obj);
 147 SCM_API SCM scm_make_s64vector (SCM n, SCM fill);
 148 SCM_API SCM scm_take_s64vector (const scm_t_int64 *data, size_t n);
 149 SCM_API SCM scm_s64vector (SCM l);
 150 SCM_API SCM scm_s64vector_length (SCM uvec);
 151 SCM_API SCM scm_s64vector_ref (SCM uvec, SCM index);
 152 SCM_API SCM scm_s64vector_set_x (SCM uvec, SCM index, SCM value);
 153 SCM_API SCM scm_s64vector_to_list (SCM uvec);
 154 SCM_API SCM scm_list_to_s64vector (SCM l);
 155 SCM_API SCM scm_any_to_s64vector (SCM obj);
 156 SCM_API const scm_t_int64 *scm_s64vector_elements (SCM uvec);
 157 SCM_API scm_t_int64 *scm_s64vector_writable_elements (SCM uvec);
 158
 159 SCM_API SCM scm_f32vector_p (SCM obj);
 160 SCM_API SCM scm_make_f32vector (SCM n, SCM fill);
 161 SCM_API SCM scm_take_f32vector (const float *data, size_t n);
 162 SCM_API SCM scm_f32vector (SCM l);
 163 SCM_API SCM scm_f32vector_length (SCM uvec);
 164 SCM_API SCM scm_f32vector_ref (SCM uvec, SCM index);
 165 SCM_API SCM scm_f32vector_set_x (SCM uvec, SCM index, SCM value);
 166 SCM_API SCM scm_f32vector_to_list (SCM uvec);
 167 SCM_API SCM scm_list_to_f32vector (SCM l);
 168 SCM_API SCM scm_any_to_f32vector (SCM obj);
 169 SCM_API const float *scm_f32vector_elements (SCM uvec);
 170 SCM_API float *scm_f32vector_writable_elements (SCM uvec);
 171
 172 SCM_API SCM scm_f64vector_p (SCM obj);
 173 SCM_API SCM scm_make_f64vector (SCM n, SCM fill);
 174 SCM_API SCM scm_take_f64vector (const double *data, size_t n);
 175 SCM_API SCM scm_f64vector (SCM l);
 176 SCM_API SCM scm_f64vector_length (SCM uvec);
 177 SCM_API SCM scm_f64vector_ref (SCM uvec, SCM index);
 178 SCM_API SCM scm_f64vector_set_x (SCM uvec, SCM index, SCM value);
 179 SCM_API SCM scm_f64vector_to_list (SCM uvec);
 180 SCM_API SCM scm_list_to_f64vector (SCM l);
 181 SCM_API SCM scm_any_to_f64vector (SCM obj);
 182 SCM_API const double *scm_f64vector_elements (SCM uvec);
 183 SCM_API double *scm_f64vector_writable_elements (SCM uvec);
 184
 185 SCM_API SCM scm_c32vector_p (SCM obj);
 186 SCM_API SCM scm_make_c32vector (SCM n, SCM fill);
 187 SCM_API SCM scm_take_c32vector (const float *data, size_t n);
 188 SCM_API SCM scm_c32vector (SCM l);
 189 SCM_API SCM scm_c32vector_length (SCM uvec);
 190 SCM_API SCM scm_c32vector_ref (SCM uvec, SCM index);
 191 SCM_API SCM scm_c32vector_set_x (SCM uvec, SCM index, SCM value);
 192 SCM_API SCM scm_c32vector_to_list (SCM uvec);
 193 SCM_API SCM scm_list_to_c32vector (SCM l);
 194 SCM_API SCM scm_any_to_c32vector (SCM obj);
 195 SCM_API const float *scm_c32vector_elements (SCM uvec);
 196 SCM_API float *scm_c32vector_writable_elements (SCM uvec);
 197
 198 SCM_API SCM scm_c64vector_p (SCM obj);
 199 SCM_API SCM scm_make_c64vector (SCM n, SCM fill);
 200 SCM_API SCM scm_take_c64vector (const double *data, size_t n);
 201 SCM_API SCM scm_c64vector (SCM l);
 202 SCM_API SCM scm_c64vector_length (SCM uvec);
 203 SCM_API SCM scm_c64vector_ref (SCM uvec, SCM index);
 204 SCM_API SCM scm_c64vector_set_x (SCM uvec, SCM index, SCM value);
 205 SCM_API SCM scm_c64vector_to_list (SCM uvec);
 206 SCM_API SCM scm_list_to_c64vector (SCM l);
 207 SCM_API SCM scm_any_to_c64vector (SCM obj);
 208 SCM_API const double *scm_c64vector_elements (SCM uvec);
 209 SCM_API double *scm_c64vector_writable_elements (SCM uvec);
 210
 211 SCM_API SCM scm_i_generalized_vector_type (SCM vec);
 212 SCM_API const char *scm_i_uniform_vector_tag (SCM uvec);
 213
 214 /* deprecated */
 215 SCM_API size_t scm_uniform_element_size (SCM obj);
 216
 217 SCM_API void scm_init_srfi_4 (void);
 218
 219 #endif /* SCM_SRFI_4_H */