1 /* Copyright (C) 1995,1996,1998,1999,2000,2001, 2006, 2008, 2009, 2010, 2011 Free Software Foundation, Inc.
3 * This library is free software; you can redistribute it and/or
4 * modify it under the terms of the GNU Lesser General Public License
5 * as published by the Free Software Foundation; either version 3 of
6 * the License, or (at your option) any later version.
8 * This library is distributed in the hope that it will be useful, but
9 * WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 * Lesser General Public License for more details.
13 * You should have received a copy of the GNU Lesser General Public
14 * License along with this library; if not, write to the Free Software
15 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
25 #include "libguile/_scm.h"
26 #include "libguile/eq.h"
27 #include "libguile/root.h"
28 #include "libguile/strings.h"
30 #include "libguile/validate.h"
31 #include "libguile/vectors.h"
32 #include "libguile/arrays.h" /* Hit me with the ugly stick */
33 #include "libguile/generalized-vectors.h"
34 #include "libguile/strings.h"
35 #include "libguile/srfi-13.h"
36 #include "libguile/dynwind.h"
37 #include "libguile/deprecation.h"
39 #include "libguile/bdw-gc.h"
44 #define VECTOR_MAX_LENGTH (SCM_T_BITS_MAX >> 8)
47 scm_is_vector (SCM obj
)
49 if (SCM_I_IS_VECTOR (obj
))
51 if (SCM_I_ARRAYP (obj
) && SCM_I_ARRAY_NDIM (obj
) == 1)
53 SCM v
= SCM_I_ARRAY_V (obj
);
54 return SCM_I_IS_VECTOR (v
);
60 scm_is_simple_vector (SCM obj
)
62 return SCM_I_IS_VECTOR (obj
);
66 scm_vector_elements (SCM vec
, scm_t_array_handle
*h
,
67 size_t *lenp
, ssize_t
*incp
)
69 if (SCM_I_WVECTP (vec
))
70 scm_wrong_type_arg_msg (NULL
, 0, vec
, "non-weak vector");
72 scm_generalized_vector_get_handle (vec
, h
);
75 scm_t_array_dim
*dim
= scm_array_handle_dims (h
);
76 *lenp
= dim
->ubnd
- dim
->lbnd
+ 1;
79 return scm_array_handle_elements (h
);
83 scm_vector_writable_elements (SCM vec
, scm_t_array_handle
*h
,
84 size_t *lenp
, ssize_t
*incp
)
86 if (SCM_I_WVECTP (vec
))
87 scm_wrong_type_arg_msg (NULL
, 0, vec
, "non-weak vector");
89 scm_generalized_vector_get_handle (vec
, h
);
92 scm_t_array_dim
*dim
= scm_array_handle_dims (h
);
93 *lenp
= dim
->ubnd
- dim
->lbnd
+ 1;
96 return scm_array_handle_writable_elements (h
);
99 SCM_DEFINE (scm_vector_p
, "vector?", 1, 0, 0,
101 "Return @code{#t} if @var{obj} is a vector, otherwise return\n"
103 #define FUNC_NAME s_scm_vector_p
105 return scm_from_bool (scm_is_vector (obj
));
109 SCM_GPROC (s_vector_length
, "vector-length", 1, 0, 0, scm_vector_length
, g_vector_length
);
110 /* Returns the number of elements in @var{vector} as an exact integer. */
112 scm_vector_length (SCM v
)
114 if (SCM_I_IS_VECTOR (v
))
115 return scm_from_size_t (SCM_I_VECTOR_LENGTH (v
));
116 else if (SCM_I_ARRAYP (v
) && SCM_I_ARRAY_NDIM (v
) == 1)
118 scm_t_array_dim
*dim
= SCM_I_ARRAY_DIMS (v
);
119 return scm_from_size_t (dim
->ubnd
- dim
->lbnd
+ 1);
122 return scm_wta_dispatch_1 (g_vector_length
, v
, 1, "vector-length");
126 scm_c_vector_length (SCM v
)
128 if (SCM_I_IS_VECTOR (v
))
129 return SCM_I_VECTOR_LENGTH (v
);
131 return scm_to_size_t (scm_vector_length (v
));
134 SCM_REGISTER_PROC (s_list_to_vector
, "list->vector", 1, 0, 0, scm_vector
);
136 "Return a newly created vector initialized to the elements of"
137 "the list @var{list}.\n\n"
139 "(vector->list '#(dah dah didah)) @result{} (dah dah didah)\n"
140 "(list->vector '(dididit dah)) @result{} #(dididit dah)\n"
143 SCM_DEFINE (scm_vector
, "vector", 0, 0, 1,
145 "@deffnx {Scheme Procedure} list->vector l\n"
146 "Return a newly allocated vector composed of the\n"
147 "given arguments. Analogous to @code{list}.\n"
150 "(vector 'a 'b 'c) @result{} #(a b c)\n"
152 #define FUNC_NAME s_scm_vector
157 scm_t_array_handle handle
;
159 SCM_VALIDATE_LIST_COPYLEN (1, l
, len
);
161 res
= scm_c_make_vector (len
, SCM_UNSPECIFIED
);
162 data
= scm_vector_writable_elements (res
, &handle
, NULL
, NULL
);
164 while (scm_is_pair (l
) && i
< len
)
166 data
[i
] = SCM_CAR (l
);
171 scm_array_handle_release (&handle
);
177 SCM_GPROC (s_vector_ref
, "vector-ref", 2, 0, 0, scm_vector_ref
, g_vector_ref
);
180 "@var{k} must be a valid index of @var{vector}.\n"
181 "@samp{Vector-ref} returns the contents of element @var{k} of\n"
184 "(vector-ref '#(1 1 2 3 5 8 13 21) 5) @result{} 8\n"
185 "(vector-ref '#(1 1 2 3 5 8 13 21)\n"
186 " (let ((i (round (* 2 (acos -1)))))\n"
187 " (if (inexact? i)\n"
188 " (inexact->exact i)\n"
189 " i))) @result{} 13\n"
194 scm_vector_ref (SCM v
, SCM k
)
195 #define FUNC_NAME s_vector_ref
197 return scm_c_vector_ref (v
, scm_to_size_t (k
));
202 scm_c_vector_ref (SCM v
, size_t k
)
204 if (SCM_I_IS_NONWEAK_VECTOR (v
))
206 if (k
>= SCM_I_VECTOR_LENGTH (v
))
207 scm_out_of_range (NULL
, scm_from_size_t (k
));
208 return SCM_SIMPLE_VECTOR_REF (v
, k
);
210 else if (SCM_I_WVECTP (v
))
211 return scm_c_weak_vector_ref (v
, k
);
212 else if (SCM_I_ARRAYP (v
) && SCM_I_ARRAY_NDIM (v
) == 1)
214 scm_t_array_dim
*dim
= SCM_I_ARRAY_DIMS (v
);
215 SCM vv
= SCM_I_ARRAY_V (v
);
217 k
= SCM_I_ARRAY_BASE (v
) + k
*dim
->inc
;
218 if (k
>= dim
->ubnd
- dim
->lbnd
+ 1)
219 scm_out_of_range (NULL
, scm_from_size_t (k
));
221 if (SCM_I_IS_NONWEAK_VECTOR (vv
))
222 return SCM_SIMPLE_VECTOR_REF (vv
, k
);
223 else if (SCM_I_WVECTP (vv
))
224 return scm_c_weak_vector_ref (vv
, k
);
226 scm_wrong_type_arg_msg (NULL
, 0, v
, "non-uniform vector");
229 return scm_wta_dispatch_2 (g_vector_ref
, v
, scm_from_size_t (k
), 2,
233 SCM_GPROC (s_vector_set_x
, "vector-set!", 3, 0, 0, scm_vector_set_x
, g_vector_set_x
);
235 /* "@var{k} must be a valid index of @var{vector}.\n"
236 "@code{Vector-set!} stores @var{obj} in element @var{k} of @var{vector}.\n"
237 "The value returned by @samp{vector-set!} is unspecified.\n"
239 "(let ((vec (vector 0 '(2 2 2 2) "Anna")))\n"
240 " (vector-set! vec 1 '("Sue" "Sue"))\n"
241 " vec) @result{} #(0 ("Sue" "Sue") "Anna")\n"
242 "(vector-set! '#(0 1 2) 1 "doe") @result{} @emph{error} ; constant vector\n"
247 scm_vector_set_x (SCM v
, SCM k
, SCM obj
)
248 #define FUNC_NAME s_vector_set_x
250 scm_c_vector_set_x (v
, scm_to_size_t (k
), obj
);
251 return SCM_UNSPECIFIED
;
256 scm_c_vector_set_x (SCM v
, size_t k
, SCM obj
)
258 if (SCM_I_IS_NONWEAK_VECTOR (v
))
260 if (k
>= SCM_I_VECTOR_LENGTH (v
))
261 scm_out_of_range (NULL
, scm_from_size_t (k
));
262 SCM_SIMPLE_VECTOR_SET (v
, k
, obj
);
264 else if (SCM_I_WVECTP (v
))
265 scm_c_weak_vector_set_x (v
, k
, obj
);
266 else if (SCM_I_ARRAYP (v
) && SCM_I_ARRAY_NDIM (v
) == 1)
268 scm_t_array_dim
*dim
= SCM_I_ARRAY_DIMS (v
);
269 SCM vv
= SCM_I_ARRAY_V (v
);
271 k
= SCM_I_ARRAY_BASE (v
) + k
*dim
->inc
;
272 if (k
>= dim
->ubnd
- dim
->lbnd
+ 1)
273 scm_out_of_range (NULL
, scm_from_size_t (k
));
275 if (SCM_I_IS_NONWEAK_VECTOR (vv
))
276 SCM_SIMPLE_VECTOR_SET (vv
, k
, obj
);
277 else if (SCM_I_WVECTP (vv
))
278 scm_c_weak_vector_set_x (vv
, k
, obj
);
280 scm_wrong_type_arg_msg (NULL
, 0, v
, "non-uniform vector");
284 if (SCM_UNPACK (g_vector_set_x
))
285 scm_wta_dispatch_n (g_vector_set_x
,
286 scm_list_3 (v
, scm_from_size_t (k
), obj
),
290 scm_wrong_type_arg_msg (NULL
, 0, v
, "vector");
294 SCM_DEFINE (scm_make_vector
, "make-vector", 1, 1, 0,
296 "Return a newly allocated vector of @var{k} elements. If a\n"
297 "second argument is given, then each position is initialized to\n"
298 "@var{fill}. Otherwise the initial contents of each position is\n"
300 #define FUNC_NAME s_scm_make_vector
302 size_t l
= scm_to_unsigned_integer (k
, 0, VECTOR_MAX_LENGTH
);
304 if (SCM_UNBNDP (fill
))
305 fill
= SCM_UNSPECIFIED
;
307 return scm_c_make_vector (l
, fill
);
313 scm_c_make_vector (size_t k
, SCM fill
)
314 #define FUNC_NAME s_scm_make_vector
319 SCM_ASSERT_RANGE (1, scm_from_size_t (k
), k
<= VECTOR_MAX_LENGTH
);
321 vector
= scm_words ((k
<< 8) | scm_tc7_vector
, k
+ 1);
323 for (j
= 0; j
< k
; ++j
)
324 SCM_SIMPLE_VECTOR_SET (vector
, j
, fill
);
330 SCM_DEFINE (scm_vector_copy
, "vector-copy", 1, 0, 0,
332 "Return a copy of @var{vec}.")
333 #define FUNC_NAME s_scm_vector_copy
335 scm_t_array_handle handle
;
341 src
= scm_vector_elements (vec
, &handle
, &len
, &inc
);
343 result
= scm_c_make_vector (len
, SCM_UNDEFINED
);
344 dst
= SCM_I_VECTOR_WELTS (result
);
345 for (i
= 0; i
< len
; i
++, src
+= inc
)
348 scm_array_handle_release (&handle
);
355 SCM_DEFINE (scm_vector_to_list
, "vector->list", 1, 0, 0,
357 "Return a newly allocated list composed of the elements of @var{v}.\n"
360 "(vector->list '#(dah dah didah)) @result{} (dah dah didah)\n"
361 "(list->vector '(dididit dah)) @result{} #(dididit dah)\n"
363 #define FUNC_NAME s_scm_vector_to_list
367 scm_t_array_handle handle
;
368 size_t i
, count
, len
;
371 data
= scm_vector_elements (v
, &handle
, &len
, &inc
);
372 for (i
= (len
- 1) * inc
, count
= 0;
375 res
= scm_cons (data
[i
], res
);
377 scm_array_handle_release (&handle
);
383 SCM_DEFINE (scm_vector_fill_x
, "vector-fill!", 2, 0, 0,
385 "Store @var{fill} in every position of @var{vector}. The value\n"
386 "returned by @code{vector-fill!} is unspecified.")
387 #define FUNC_NAME s_scm_vector_fill_x
389 scm_t_array_handle handle
;
394 data
= scm_vector_writable_elements (v
, &handle
, &len
, &inc
);
395 for (i
= 0; i
< len
; i
+= inc
)
397 scm_array_handle_release (&handle
);
398 return SCM_UNSPECIFIED
;
404 scm_i_vector_equal_p (SCM x
, SCM y
)
407 for (i
= SCM_I_VECTOR_LENGTH (x
) - 1; i
>= 0; i
--)
408 if (scm_is_false (scm_equal_p (SCM_I_VECTOR_ELTS (x
)[i
],
409 SCM_I_VECTOR_ELTS (y
)[i
])))
415 SCM_DEFINE (scm_vector_move_left_x
, "vector-move-left!", 5, 0, 0,
416 (SCM vec1
, SCM start1
, SCM end1
, SCM vec2
, SCM start2
),
417 "Copy elements from @var{vec1}, positions @var{start1} to @var{end1},\n"
418 "to @var{vec2} starting at position @var{start2}. @var{start1} and\n"
419 "@var{start2} are inclusive indices; @var{end1} is exclusive.\n\n"
420 "@code{vector-move-left!} copies elements in leftmost order.\n"
421 "Therefore, in the case where @var{vec1} and @var{vec2} refer to the\n"
422 "same vector, @code{vector-move-left!} is usually appropriate when\n"
423 "@var{start1} is greater than @var{start2}.")
424 #define FUNC_NAME s_scm_vector_move_left_x
426 scm_t_array_handle handle1
, handle2
;
433 elts1
= scm_vector_elements (vec1
, &handle1
, &len1
, &inc1
);
434 elts2
= scm_vector_writable_elements (vec2
, &handle2
, &len2
, &inc2
);
436 i
= scm_to_unsigned_integer (start1
, 0, len1
);
437 e
= scm_to_unsigned_integer (end1
, i
, len1
);
438 SCM_ASSERT_RANGE (SCM_ARG3
, end1
, (e
-i
) <= len2
);
439 j
= scm_to_unsigned_integer (start2
, 0, len2
);
440 SCM_ASSERT_RANGE (SCM_ARG5
, start2
, j
<= len2
- (e
- i
));
445 for (; i
< e
; i
+= inc1
, j
+= inc2
)
448 scm_array_handle_release (&handle2
);
449 scm_array_handle_release (&handle1
);
451 return SCM_UNSPECIFIED
;
455 SCM_DEFINE (scm_vector_move_right_x
, "vector-move-right!", 5, 0, 0,
456 (SCM vec1
, SCM start1
, SCM end1
, SCM vec2
, SCM start2
),
457 "Copy elements from @var{vec1}, positions @var{start1} to @var{end1},\n"
458 "to @var{vec2} starting at position @var{start2}. @var{start1} and\n"
459 "@var{start2} are inclusive indices; @var{end1} is exclusive.\n\n"
460 "@code{vector-move-right!} copies elements in rightmost order.\n"
461 "Therefore, in the case where @var{vec1} and @var{vec2} refer to the\n"
462 "same vector, @code{vector-move-right!} is usually appropriate when\n"
463 "@var{start1} is less than @var{start2}.")
464 #define FUNC_NAME s_scm_vector_move_right_x
466 scm_t_array_handle handle1
, handle2
;
473 elts1
= scm_vector_elements (vec1
, &handle1
, &len1
, &inc1
);
474 elts2
= scm_vector_writable_elements (vec2
, &handle2
, &len2
, &inc2
);
476 i
= scm_to_unsigned_integer (start1
, 0, len1
);
477 e
= scm_to_unsigned_integer (end1
, i
, len1
);
478 SCM_ASSERT_RANGE (SCM_ARG3
, end1
, (e
-i
) <= len2
);
479 j
= scm_to_unsigned_integer (start2
, 0, len2
);
480 SCM_ASSERT_RANGE (SCM_ARG5
, start2
, j
<= len2
- (e
- i
));
494 scm_array_handle_release (&handle2
);
495 scm_array_handle_release (&handle1
);
497 return SCM_UNSPECIFIED
;
503 vector_handle_ref (scm_t_array_handle
*h
, size_t idx
)
505 if (idx
> h
->dims
[0].ubnd
)
506 scm_out_of_range ("vector-handle-ref", scm_from_size_t (idx
));
507 return ((SCM
*)h
->elements
)[idx
];
511 vector_handle_set (scm_t_array_handle
*h
, size_t idx
, SCM val
)
513 if (idx
> h
->dims
[0].ubnd
)
514 scm_out_of_range ("vector-handle-set!", scm_from_size_t (idx
));
515 ((SCM
*)h
->writable_elements
)[idx
] = val
;
519 vector_get_handle (SCM v
, scm_t_array_handle
*h
)
525 h
->dim0
.ubnd
= SCM_I_VECTOR_LENGTH (v
) - 1;
527 h
->element_type
= SCM_ARRAY_ELEMENT_TYPE_SCM
;
528 h
->elements
= h
->writable_elements
= SCM_I_VECTOR_WELTS (v
);
531 /* the & ~2 allows catching scm_tc7_wvect as well. needs changing if you change
533 SCM_ARRAY_IMPLEMENTATION (scm_tc7_vector
, 0x7f & ~2,
534 vector_handle_ref
, vector_handle_set
,
536 SCM_VECTOR_IMPLEMENTATION (SCM_ARRAY_ELEMENT_TYPE_SCM
, scm_make_vector
)
542 #include "libguile/vectors.x"