* weaks.c: Use new vector elements API or simple vector
[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 *
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"
6e708ef2 24#include "libguile/unif.h"
f8579182 25
e0e49670
MV
26/* Generic procedures.
27 */
28
29SCM_API SCM scm_uniform_vector_p (SCM v);
30SCM_API SCM scm_uniform_vector_length (SCM v);
31SCM_API SCM scm_uniform_vector_ref (SCM v, SCM idx);
32SCM_API SCM scm_uniform_vector_set_x (SCM v, SCM idx, SCM val);
33SCM_API SCM scm_uniform_vector_to_list (SCM v);
69730f92
MV
34SCM_API SCM scm_uniform_vector_read_x (SCM v, SCM port_or_fd,
35 SCM start, SCM end);
36SCM_API SCM scm_uniform_vector_write (SCM v, SCM port_or_fd,
37 SCM start, SCM end);
e0e49670
MV
38
39SCM_API int scm_is_uniform_vector (SCM obj);
40SCM_API size_t scm_c_uniform_vector_length (SCM v);
41SCM_API size_t scm_c_uniform_vector_size (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);
6e708ef2
MV
44SCM_API size_t scm_uniform_vector_element_size (SCM v);
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);
faa00365 60SCM_API SCM scm_take_u8vector (const 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);
faa00365 80SCM_API SCM scm_take_s8vector (const 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);
faa00365 100SCM_API SCM scm_take_u16vector (const 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);
faa00365 121SCM_API SCM scm_take_s16vector (const 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);
faa00365 141SCM_API SCM scm_take_u32vector (const 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);
faa00365 162SCM_API SCM scm_take_s32vector (const 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);
faa00365 182SCM_API SCM scm_take_u64vector (const scm_t_uint64 *data, size_t n);
f8579182
MV
183SCM_API SCM scm_u64vector (SCM l);
184SCM_API SCM scm_u64vector_length (SCM uvec);
185SCM_API SCM scm_u64vector_ref (SCM uvec, SCM index);
186SCM_API SCM scm_u64vector_set_x (SCM uvec, SCM index, SCM value);
187SCM_API SCM scm_u64vector_to_list (SCM uvec);
188SCM_API SCM scm_list_to_u64vector (SCM l);
90d4368c 189SCM_API SCM scm_any_to_u64vector (SCM obj);
6e708ef2
MV
190SCM_API const scm_t_uint64 *scm_array_handle_u64_elements (scm_t_array_handle *h);
191SCM_API scm_t_uint64 *scm_array_handle_u64_writable_elements (scm_t_array_handle *h);
192SCM_API const scm_t_uint64 *scm_u64vector_elements (SCM uvec,
193 scm_t_array_handle *h,
194 size_t *lenp,
195 ssize_t *incp);
196SCM_API scm_t_uint64 *scm_u64vector_writable_elements (SCM uvec,
197 scm_t_array_handle *h,
198 size_t *lenp,
199 ssize_t *incp);
f8579182
MV
200
201SCM_API SCM scm_s64vector_p (SCM obj);
202SCM_API SCM scm_make_s64vector (SCM n, SCM fill);
faa00365 203SCM_API SCM scm_take_s64vector (const scm_t_int64 *data, size_t n);
f8579182
MV
204SCM_API SCM scm_s64vector (SCM l);
205SCM_API SCM scm_s64vector_length (SCM uvec);
206SCM_API SCM scm_s64vector_ref (SCM uvec, SCM index);
207SCM_API SCM scm_s64vector_set_x (SCM uvec, SCM index, SCM value);
208SCM_API SCM scm_s64vector_to_list (SCM uvec);
209SCM_API SCM scm_list_to_s64vector (SCM l);
90d4368c 210SCM_API SCM scm_any_to_s64vector (SCM obj);
6e708ef2
MV
211SCM_API const scm_t_int64 *scm_array_handle_s64_elements (scm_t_array_handle *h);
212SCM_API scm_t_int64 *scm_array_handle_s64_writable_elements (scm_t_array_handle *h);
213SCM_API const scm_t_int64 *scm_s64vector_elements (SCM uvec,
214 scm_t_array_handle *h,
215 size_t *lenp, ssize_t *incp);
216SCM_API scm_t_int64 *scm_s64vector_writable_elements (SCM uvec,
217 scm_t_array_handle *h,
218 size_t *lenp,
219 ssize_t *incp);
f8579182
MV
220
221SCM_API SCM scm_f32vector_p (SCM obj);
222SCM_API SCM scm_make_f32vector (SCM n, SCM fill);
faa00365 223SCM_API SCM scm_take_f32vector (const float *data, size_t n);
f8579182
MV
224SCM_API SCM scm_f32vector (SCM l);
225SCM_API SCM scm_f32vector_length (SCM uvec);
226SCM_API SCM scm_f32vector_ref (SCM uvec, SCM index);
227SCM_API SCM scm_f32vector_set_x (SCM uvec, SCM index, SCM value);
228SCM_API SCM scm_f32vector_to_list (SCM uvec);
229SCM_API SCM scm_list_to_f32vector (SCM l);
90d4368c 230SCM_API SCM scm_any_to_f32vector (SCM obj);
6e708ef2
MV
231SCM_API const float *scm_array_handle_f32_elements (scm_t_array_handle *h);
232SCM_API float *scm_array_handle_f32_writable_elements (scm_t_array_handle *h);
233SCM_API const float *scm_f32vector_elements (SCM uvec,
234 scm_t_array_handle *h,
235 size_t *lenp, ssize_t *incp);
236SCM_API float *scm_f32vector_writable_elements (SCM uvec,
237 scm_t_array_handle *h,
238 size_t *lenp,
239 ssize_t *incp);
f8579182
MV
240
241SCM_API SCM scm_f64vector_p (SCM obj);
242SCM_API SCM scm_make_f64vector (SCM n, SCM fill);
faa00365 243SCM_API SCM scm_take_f64vector (const double *data, size_t n);
f8579182
MV
244SCM_API SCM scm_f64vector (SCM l);
245SCM_API SCM scm_f64vector_length (SCM uvec);
246SCM_API SCM scm_f64vector_ref (SCM uvec, SCM index);
247SCM_API SCM scm_f64vector_set_x (SCM uvec, SCM index, SCM value);
248SCM_API SCM scm_f64vector_to_list (SCM uvec);
249SCM_API SCM scm_list_to_f64vector (SCM l);
90d4368c 250SCM_API SCM scm_any_to_f64vector (SCM obj);
6e708ef2
MV
251SCM_API const double *scm_array_handle_f64_elements (scm_t_array_handle *h);
252SCM_API double *scm_array_handle_f64_writable_elements (scm_t_array_handle *h);
253SCM_API const double *scm_f64vector_elements (SCM uvec,
254 scm_t_array_handle *h,
255 size_t *lenp, ssize_t *incp);
256SCM_API double *scm_f64vector_writable_elements (SCM uvec,
257 scm_t_array_handle *h,
258 size_t *lenp,
259 ssize_t *incp);
f8579182 260
cbdc8379
MV
261SCM_API SCM scm_c32vector_p (SCM obj);
262SCM_API SCM scm_make_c32vector (SCM n, SCM fill);
263SCM_API SCM scm_take_c32vector (const float *data, size_t n);
264SCM_API SCM scm_c32vector (SCM l);
265SCM_API SCM scm_c32vector_length (SCM uvec);
266SCM_API SCM scm_c32vector_ref (SCM uvec, SCM index);
267SCM_API SCM scm_c32vector_set_x (SCM uvec, SCM index, SCM value);
268SCM_API SCM scm_c32vector_to_list (SCM uvec);
269SCM_API SCM scm_list_to_c32vector (SCM l);
90d4368c 270SCM_API SCM scm_any_to_c32vector (SCM obj);
6e708ef2
MV
271SCM_API const float *scm_array_handle_c32_elements (scm_t_array_handle *h);
272SCM_API float *scm_array_handle_c32_writable_elements (scm_t_array_handle *h);
273SCM_API const float *scm_c32vector_elements (SCM uvec,
274 scm_t_array_handle *h,
275 size_t *lenp, ssize_t *incp);
276SCM_API float *scm_c32vector_writable_elements (SCM uvec,
277 scm_t_array_handle *h,
278 size_t *lenp,
279 ssize_t *incp);
cbdc8379
MV
280
281SCM_API SCM scm_c64vector_p (SCM obj);
282SCM_API SCM scm_make_c64vector (SCM n, SCM fill);
283SCM_API SCM scm_take_c64vector (const double *data, size_t n);
284SCM_API SCM scm_c64vector (SCM l);
285SCM_API SCM scm_c64vector_length (SCM uvec);
286SCM_API SCM scm_c64vector_ref (SCM uvec, SCM index);
287SCM_API SCM scm_c64vector_set_x (SCM uvec, SCM index, SCM value);
288SCM_API SCM scm_c64vector_to_list (SCM uvec);
289SCM_API SCM scm_list_to_c64vector (SCM l);
90d4368c 290SCM_API SCM scm_any_to_c64vector (SCM obj);
6e708ef2
MV
291SCM_API const double *scm_array_handle_c64_elements (scm_t_array_handle *h);
292SCM_API double *scm_array_handle_c64_writable_elements (scm_t_array_handle *h);
293SCM_API const double *scm_c64vector_elements (SCM uvec,
294 scm_t_array_handle *h,
295 size_t *lenp, ssize_t *incp);
296SCM_API double *scm_c64vector_writable_elements (SCM uvec,
297 scm_t_array_handle *h,
298 size_t *lenp,
299 ssize_t *incp);
cbdc8379 300
f301dbf3 301SCM_API SCM scm_i_generalized_vector_type (SCM vec);
e0e49670
MV
302SCM_API const char *scm_i_uniform_vector_tag (SCM uvec);
303
811eb6d0 304/* deprecated */
e0e49670 305SCM_API size_t scm_uniform_element_size (SCM obj);
f8579182
MV
306
307SCM_API void scm_init_srfi_4 (void);
308
309#endif /* SCM_SRFI_4_H */