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