uniform vector functions to their own file
[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 *
476b894c 5 * Copyright (C) 2001, 2004, 2006, 2008, 2009 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"
e0e49670
MV
25
26/* Specific procedures.
27 */
28
f8579182
MV
29SCM_API SCM scm_u8vector_p (SCM obj);
30SCM_API SCM scm_make_u8vector (SCM n, SCM fill);
ab7acbb7 31SCM_API SCM scm_take_u8vector (scm_t_uint8 *data, size_t n);
f8579182
MV
32SCM_API SCM scm_u8vector (SCM l);
33SCM_API SCM scm_u8vector_length (SCM uvec);
34SCM_API SCM scm_u8vector_ref (SCM uvec, SCM index);
35SCM_API SCM scm_u8vector_set_x (SCM uvec, SCM index, SCM value);
36SCM_API SCM scm_u8vector_to_list (SCM uvec);
37SCM_API SCM scm_list_to_u8vector (SCM l);
90d4368c 38SCM_API SCM scm_any_to_u8vector (SCM obj);
6e708ef2
MV
39SCM_API const scm_t_uint8 *scm_array_handle_u8_elements (scm_t_array_handle *h);
40SCM_API scm_t_uint8 *scm_array_handle_u8_writable_elements (scm_t_array_handle *h);
41SCM_API const scm_t_uint8 *scm_u8vector_elements (SCM uvec,
42 scm_t_array_handle *h,
43 size_t *lenp, ssize_t *incp);
44SCM_API scm_t_uint8 *scm_u8vector_writable_elements (SCM uvec,
45 scm_t_array_handle *h,
46 size_t *lenp,
47 ssize_t *incp);
f8579182
MV
48
49SCM_API SCM scm_s8vector_p (SCM obj);
50SCM_API SCM scm_make_s8vector (SCM n, SCM fill);
ab7acbb7 51SCM_API SCM scm_take_s8vector (scm_t_int8 *data, size_t n);
f8579182
MV
52SCM_API SCM scm_s8vector (SCM l);
53SCM_API SCM scm_s8vector_length (SCM uvec);
54SCM_API SCM scm_s8vector_ref (SCM uvec, SCM index);
55SCM_API SCM scm_s8vector_set_x (SCM uvec, SCM index, SCM value);
56SCM_API SCM scm_s8vector_to_list (SCM uvec);
57SCM_API SCM scm_list_to_s8vector (SCM l);
90d4368c 58SCM_API SCM scm_any_to_s8vector (SCM obj);
6e708ef2
MV
59SCM_API const scm_t_int8 *scm_array_handle_s8_elements (scm_t_array_handle *h);
60SCM_API scm_t_int8 *scm_array_handle_s8_writable_elements (scm_t_array_handle *h);
61SCM_API const scm_t_int8 *scm_s8vector_elements (SCM uvec,
62 scm_t_array_handle *h,
63 size_t *lenp, ssize_t *incp);
64SCM_API scm_t_int8 *scm_s8vector_writable_elements (SCM uvec,
65 scm_t_array_handle *h,
66 size_t *lenp,
67 ssize_t *incp);
f8579182
MV
68
69SCM_API SCM scm_u16vector_p (SCM obj);
70SCM_API SCM scm_make_u16vector (SCM n, SCM fill);
ab7acbb7 71SCM_API SCM scm_take_u16vector (scm_t_uint16 *data, size_t n);
f8579182
MV
72SCM_API SCM scm_u16vector (SCM l);
73SCM_API SCM scm_u16vector_length (SCM uvec);
74SCM_API SCM scm_u16vector_ref (SCM uvec, SCM index);
75SCM_API SCM scm_u16vector_set_x (SCM uvec, SCM index, SCM value);
76SCM_API SCM scm_u16vector_to_list (SCM uvec);
77SCM_API SCM scm_list_to_u16vector (SCM l);
90d4368c 78SCM_API SCM scm_any_to_u16vector (SCM obj);
6e708ef2
MV
79SCM_API const scm_t_uint16 *scm_array_handle_u16_elements (scm_t_array_handle *h);
80SCM_API scm_t_uint16 *scm_array_handle_u16_writable_elements (scm_t_array_handle *h);
81SCM_API const scm_t_uint16 *scm_u16vector_elements (SCM uvec,
82 scm_t_array_handle *h,
83 size_t *lenp,
84 ssize_t *incp);
85SCM_API scm_t_uint16 *scm_u16vector_writable_elements (SCM uvec,
86 scm_t_array_handle *h,
87 size_t *lenp,
88 ssize_t *incp);
f8579182
MV
89
90SCM_API SCM scm_s16vector_p (SCM obj);
91SCM_API SCM scm_make_s16vector (SCM n, SCM fill);
ab7acbb7 92SCM_API SCM scm_take_s16vector (scm_t_int16 *data, size_t n);
f8579182
MV
93SCM_API SCM scm_s16vector (SCM l);
94SCM_API SCM scm_s16vector_length (SCM uvec);
95SCM_API SCM scm_s16vector_ref (SCM uvec, SCM index);
96SCM_API SCM scm_s16vector_set_x (SCM uvec, SCM index, SCM value);
97SCM_API SCM scm_s16vector_to_list (SCM uvec);
98SCM_API SCM scm_list_to_s16vector (SCM l);
90d4368c 99SCM_API SCM scm_any_to_s16vector (SCM obj);
6e708ef2
MV
100SCM_API const scm_t_int16 *scm_array_handle_s16_elements (scm_t_array_handle *h);
101SCM_API scm_t_int16 *scm_array_handle_s16_writable_elements (scm_t_array_handle *h);
102SCM_API const scm_t_int16 *scm_s16vector_elements (SCM uvec,
103 scm_t_array_handle *h,
104 size_t *lenp, ssize_t *incp);
105SCM_API scm_t_int16 *scm_s16vector_writable_elements (SCM uvec,
106 scm_t_array_handle *h,
107 size_t *lenp,
108 ssize_t *incp);
f8579182
MV
109
110SCM_API SCM scm_u32vector_p (SCM obj);
111SCM_API SCM scm_make_u32vector (SCM n, SCM fill);
ab7acbb7 112SCM_API SCM scm_take_u32vector (scm_t_uint32 *data, size_t n);
f8579182
MV
113SCM_API SCM scm_u32vector (SCM l);
114SCM_API SCM scm_u32vector_length (SCM uvec);
115SCM_API SCM scm_u32vector_ref (SCM uvec, SCM index);
116SCM_API SCM scm_u32vector_set_x (SCM uvec, SCM index, SCM value);
117SCM_API SCM scm_u32vector_to_list (SCM uvec);
118SCM_API SCM scm_list_to_u32vector (SCM l);
90d4368c 119SCM_API SCM scm_any_to_u32vector (SCM obj);
6e708ef2
MV
120SCM_API const scm_t_uint32 *scm_array_handle_u32_elements (scm_t_array_handle *h);
121SCM_API scm_t_uint32 *scm_array_handle_u32_writable_elements (scm_t_array_handle *h);
122SCM_API const scm_t_uint32 *scm_u32vector_elements (SCM uvec,
123 scm_t_array_handle *h,
124 size_t *lenp,
125 ssize_t *incp);
126SCM_API scm_t_uint32 *scm_u32vector_writable_elements (SCM uvec,
127 scm_t_array_handle *h,
128 size_t *lenp,
129 ssize_t *incp);
f8579182
MV
130
131SCM_API SCM scm_s32vector_p (SCM obj);
132SCM_API SCM scm_make_s32vector (SCM n, SCM fill);
ab7acbb7 133SCM_API SCM scm_take_s32vector (scm_t_int32 *data, size_t n);
f8579182
MV
134SCM_API SCM scm_s32vector (SCM l);
135SCM_API SCM scm_s32vector_length (SCM uvec);
136SCM_API SCM scm_s32vector_ref (SCM uvec, SCM index);
137SCM_API SCM scm_s32vector_set_x (SCM uvec, SCM index, SCM value);
138SCM_API SCM scm_s32vector_to_list (SCM uvec);
139SCM_API SCM scm_list_to_s32vector (SCM l);
90d4368c 140SCM_API SCM scm_any_to_s32vector (SCM obj);
6e708ef2
MV
141SCM_API const scm_t_int32 *scm_array_handle_s32_elements (scm_t_array_handle *h);
142SCM_API scm_t_int32 *scm_array_handle_s32_writable_elements (scm_t_array_handle *h);
143SCM_API const scm_t_int32 *scm_s32vector_elements (SCM uvec,
144 scm_t_array_handle *h,
145 size_t *lenp, ssize_t *incp);
146SCM_API scm_t_int32 *scm_s32vector_writable_elements (SCM uvec,
147 scm_t_array_handle *h,
148 size_t *lenp,
149 ssize_t *incp);
f8579182
MV
150
151SCM_API SCM scm_u64vector_p (SCM obj);
152SCM_API SCM scm_make_u64vector (SCM n, SCM fill);
153SCM_API SCM scm_u64vector (SCM l);
154SCM_API SCM scm_u64vector_length (SCM uvec);
155SCM_API SCM scm_u64vector_ref (SCM uvec, SCM index);
156SCM_API SCM scm_u64vector_set_x (SCM uvec, SCM index, SCM value);
157SCM_API SCM scm_u64vector_to_list (SCM uvec);
158SCM_API SCM scm_list_to_u64vector (SCM l);
90d4368c 159SCM_API SCM scm_any_to_u64vector (SCM obj);
00c17d45
MV
160
161#if SCM_HAVE_T_UINT64
ab7acbb7 162SCM_API SCM scm_take_u64vector (scm_t_uint64 *data, size_t n);
6e708ef2
MV
163SCM_API const scm_t_uint64 *scm_array_handle_u64_elements (scm_t_array_handle *h);
164SCM_API scm_t_uint64 *scm_array_handle_u64_writable_elements (scm_t_array_handle *h);
165SCM_API const scm_t_uint64 *scm_u64vector_elements (SCM uvec,
166 scm_t_array_handle *h,
167 size_t *lenp,
168 ssize_t *incp);
169SCM_API scm_t_uint64 *scm_u64vector_writable_elements (SCM uvec,
170 scm_t_array_handle *h,
171 size_t *lenp,
172 ssize_t *incp);
00c17d45 173#endif
f8579182
MV
174
175SCM_API SCM scm_s64vector_p (SCM obj);
176SCM_API SCM scm_make_s64vector (SCM n, SCM fill);
177SCM_API SCM scm_s64vector (SCM l);
178SCM_API SCM scm_s64vector_length (SCM uvec);
179SCM_API SCM scm_s64vector_ref (SCM uvec, SCM index);
180SCM_API SCM scm_s64vector_set_x (SCM uvec, SCM index, SCM value);
181SCM_API SCM scm_s64vector_to_list (SCM uvec);
182SCM_API SCM scm_list_to_s64vector (SCM l);
90d4368c 183SCM_API SCM scm_any_to_s64vector (SCM obj);
00c17d45
MV
184
185#if SCM_HAVE_T_INT64
ab7acbb7 186SCM_API SCM scm_take_s64vector (scm_t_int64 *data, size_t n);
6e708ef2
MV
187SCM_API const scm_t_int64 *scm_array_handle_s64_elements (scm_t_array_handle *h);
188SCM_API scm_t_int64 *scm_array_handle_s64_writable_elements (scm_t_array_handle *h);
189SCM_API const scm_t_int64 *scm_s64vector_elements (SCM uvec,
190 scm_t_array_handle *h,
191 size_t *lenp, ssize_t *incp);
192SCM_API scm_t_int64 *scm_s64vector_writable_elements (SCM uvec,
193 scm_t_array_handle *h,
194 size_t *lenp,
195 ssize_t *incp);
00c17d45 196#endif
f8579182
MV
197
198SCM_API SCM scm_f32vector_p (SCM obj);
199SCM_API SCM scm_make_f32vector (SCM n, SCM fill);
ab7acbb7 200SCM_API SCM scm_take_f32vector (float *data, size_t n);
f8579182
MV
201SCM_API SCM scm_f32vector (SCM l);
202SCM_API SCM scm_f32vector_length (SCM uvec);
203SCM_API SCM scm_f32vector_ref (SCM uvec, SCM index);
204SCM_API SCM scm_f32vector_set_x (SCM uvec, SCM index, SCM value);
205SCM_API SCM scm_f32vector_to_list (SCM uvec);
206SCM_API SCM scm_list_to_f32vector (SCM l);
90d4368c 207SCM_API SCM scm_any_to_f32vector (SCM obj);
6e708ef2
MV
208SCM_API const float *scm_array_handle_f32_elements (scm_t_array_handle *h);
209SCM_API float *scm_array_handle_f32_writable_elements (scm_t_array_handle *h);
210SCM_API const float *scm_f32vector_elements (SCM uvec,
211 scm_t_array_handle *h,
212 size_t *lenp, ssize_t *incp);
213SCM_API float *scm_f32vector_writable_elements (SCM uvec,
214 scm_t_array_handle *h,
215 size_t *lenp,
216 ssize_t *incp);
f8579182
MV
217
218SCM_API SCM scm_f64vector_p (SCM obj);
219SCM_API SCM scm_make_f64vector (SCM n, SCM fill);
ab7acbb7 220SCM_API SCM scm_take_f64vector (double *data, size_t n);
f8579182
MV
221SCM_API SCM scm_f64vector (SCM l);
222SCM_API SCM scm_f64vector_length (SCM uvec);
223SCM_API SCM scm_f64vector_ref (SCM uvec, SCM index);
224SCM_API SCM scm_f64vector_set_x (SCM uvec, SCM index, SCM value);
225SCM_API SCM scm_f64vector_to_list (SCM uvec);
226SCM_API SCM scm_list_to_f64vector (SCM l);
90d4368c 227SCM_API SCM scm_any_to_f64vector (SCM obj);
6e708ef2
MV
228SCM_API const double *scm_array_handle_f64_elements (scm_t_array_handle *h);
229SCM_API double *scm_array_handle_f64_writable_elements (scm_t_array_handle *h);
230SCM_API const double *scm_f64vector_elements (SCM uvec,
231 scm_t_array_handle *h,
232 size_t *lenp, ssize_t *incp);
233SCM_API double *scm_f64vector_writable_elements (SCM uvec,
234 scm_t_array_handle *h,
235 size_t *lenp,
236 ssize_t *incp);
f8579182 237
cbdc8379
MV
238SCM_API SCM scm_c32vector_p (SCM obj);
239SCM_API SCM scm_make_c32vector (SCM n, SCM fill);
ab7acbb7 240SCM_API SCM scm_take_c32vector (float *data, size_t n);
cbdc8379
MV
241SCM_API SCM scm_c32vector (SCM l);
242SCM_API SCM scm_c32vector_length (SCM uvec);
243SCM_API SCM scm_c32vector_ref (SCM uvec, SCM index);
244SCM_API SCM scm_c32vector_set_x (SCM uvec, SCM index, SCM value);
245SCM_API SCM scm_c32vector_to_list (SCM uvec);
246SCM_API SCM scm_list_to_c32vector (SCM l);
90d4368c 247SCM_API SCM scm_any_to_c32vector (SCM obj);
6e708ef2
MV
248SCM_API const float *scm_array_handle_c32_elements (scm_t_array_handle *h);
249SCM_API float *scm_array_handle_c32_writable_elements (scm_t_array_handle *h);
250SCM_API const float *scm_c32vector_elements (SCM uvec,
251 scm_t_array_handle *h,
252 size_t *lenp, ssize_t *incp);
253SCM_API float *scm_c32vector_writable_elements (SCM uvec,
254 scm_t_array_handle *h,
255 size_t *lenp,
256 ssize_t *incp);
cbdc8379
MV
257
258SCM_API SCM scm_c64vector_p (SCM obj);
259SCM_API SCM scm_make_c64vector (SCM n, SCM fill);
ab7acbb7 260SCM_API SCM scm_take_c64vector (double *data, size_t n);
cbdc8379
MV
261SCM_API SCM scm_c64vector (SCM l);
262SCM_API SCM scm_c64vector_length (SCM uvec);
263SCM_API SCM scm_c64vector_ref (SCM uvec, SCM index);
264SCM_API SCM scm_c64vector_set_x (SCM uvec, SCM index, SCM value);
265SCM_API SCM scm_c64vector_to_list (SCM uvec);
266SCM_API SCM scm_list_to_c64vector (SCM l);
90d4368c 267SCM_API SCM scm_any_to_c64vector (SCM obj);
6e708ef2
MV
268SCM_API const double *scm_array_handle_c64_elements (scm_t_array_handle *h);
269SCM_API double *scm_array_handle_c64_writable_elements (scm_t_array_handle *h);
270SCM_API const double *scm_c64vector_elements (SCM uvec,
271 scm_t_array_handle *h,
272 size_t *lenp, ssize_t *incp);
273SCM_API double *scm_c64vector_writable_elements (SCM uvec,
274 scm_t_array_handle *h,
275 size_t *lenp,
276 ssize_t *incp);
cbdc8379 277
102dbb6f
LC
278SCM_INTERNAL SCM scm_i_generalized_vector_type (SCM vec);
279SCM_INTERNAL const char *scm_i_uniform_vector_tag (SCM uvec);
280SCM_INTERNAL scm_i_t_array_ref scm_i_uniform_vector_ref_proc (SCM uvec);
281SCM_INTERNAL scm_i_t_array_set scm_i_uniform_vector_set_proc (SCM uvec);
e0e49670 282
ec313f0e
MV
283#if SCM_ENABLE_DEPRECATED
284
285/* Deprecated because we want people to use the scm_t_array_handle
286 interface.
287*/
288
e0e49670 289SCM_API size_t scm_uniform_element_size (SCM obj);
f8579182 290
ec313f0e
MV
291#endif
292
102dbb6f 293SCM_INTERNAL void scm_init_srfi_4 (void);
f8579182
MV
294
295#endif /* SCM_SRFI_4_H */