1 /* Copyright (C) 1995,1996,1998,1999,2000,2001 Free Software Foundation, Inc.
3 * This program is free software; you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License as published by
5 * the Free Software Foundation; either version 2, or (at your option)
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License
14 * along with this software; see the file COPYING. If not, write to
15 * the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
16 * Boston, MA 02111-1307 USA
18 * As a special exception, the Free Software Foundation gives permission
19 * for additional uses of the text contained in its release of GUILE.
21 * The exception is that, if you link the GUILE library with other files
22 * to produce an executable, this does not by itself cause the
23 * resulting executable to be covered by the GNU General Public License.
24 * Your use of that executable is in no way restricted on account of
25 * linking the GUILE library code into it.
27 * This exception does not however invalidate any other reasons why
28 * the executable file might be covered by the GNU General Public License.
30 * This exception applies only to the code released by the
31 * Free Software Foundation under the name GUILE. If you copy
32 * code from other Free Software Foundation releases into a copy of
33 * GUILE, as the General Public License permits, the exception does
34 * not apply to the code that you add in this way. To avoid misleading
35 * anyone as to the status of such modified files, you must delete
36 * this exception notice from them.
38 * If you write modifications of your own for GUILE, it is your choice
39 * whether to permit this exception to apply to your modifications.
40 * If you do not wish that, delete this exception notice. */
45 #include "libguile/_scm.h"
46 #include "libguile/eq.h"
47 #include "libguile/root.h"
48 #include "libguile/strings.h"
49 #include "libguile/lang.h"
51 #include "libguile/validate.h"
52 #include "libguile/vectors.h"
53 #include "libguile/unif.h"
56 SCM_DEFINE (scm_vector_p
, "vector?", 1, 0, 0,
58 "Return @code{#t} if @var{obj} is a vector, otherwise return\n"
60 #define FUNC_NAME s_scm_vector_p
62 return SCM_BOOL (SCM_VECTORP (obj
));
66 SCM_GPROC (s_vector_length
, "vector-length", 1, 0, 0, scm_vector_length
, g_vector_length
);
67 /* Returns the number of elements in @var{vector} as an exact integer. */
69 scm_vector_length (SCM v
)
71 SCM_GASSERT1 (SCM_VECTORP(v
),
72 g_vector_length
, v
, SCM_ARG1
, s_vector_length
);
73 return SCM_MAKINUM (SCM_VECTOR_LENGTH (v
));
76 SCM_REGISTER_PROC (s_list_to_vector
, "list->vector", 1, 0, 0, scm_vector
);
78 "Return a newly created vector initialized to the elements of"
79 "the list @var{list}.\n\n"
81 "(vector->list '#(dah dah didah)) @result{} (dah dah didah)\n"
82 "(list->vector '(dididit dah)) @result{} #(dididit dah)\n"
85 SCM_DEFINE (scm_vector
, "vector", 0, 0, 1,
87 "@deffnx {Scheme Procedure} list->vector l\n"
88 "Return a newly allocated vector composed of the\n"
89 "given arguments. Analogous to @code{list}.\n"
92 "(vector 'a 'b 'c) @result{} #(a b c)\n"
94 #define FUNC_NAME s_scm_vector
100 /* Dirk:FIXME:: In case of multiple threads, the list might get corrupted
101 while the vector is being created. */
102 SCM_VALIDATE_LIST_COPYLEN (1, l
, i
);
103 res
= scm_c_make_vector (i
, SCM_UNSPECIFIED
);
104 data
= SCM_VELTS (res
);
105 while (!SCM_NULL_OR_NIL_P (l
))
107 *data
++ = SCM_CAR (l
);
115 SCM_GPROC (s_vector_ref
, "vector-ref", 2, 0, 0, scm_vector_ref
, g_vector_ref
);
118 "@var{k} must be a valid index of @var{vector}.\n"
119 "@samp{Vector-ref} returns the contents of element @var{k} of\n"
122 "(vector-ref '#(1 1 2 3 5 8 13 21) 5) @result{} 8\n"
123 "(vector-ref '#(1 1 2 3 5 8 13 21)\n"
124 " (let ((i (round (* 2 (acos -1)))))\n"
125 " (if (inexact? i)\n"
126 " (inexact->exact i)\n"
127 " i))) @result{} 13\n"
132 scm_vector_ref (SCM v
, SCM k
)
133 #define FUNC_NAME s_vector_ref
135 SCM_GASSERT2 (SCM_VECTORP (v
),
136 g_vector_ref
, v
, k
, SCM_ARG1
, s_vector_ref
);
137 SCM_GASSERT2 (SCM_INUMP (k
),
138 g_vector_ref
, v
, k
, SCM_ARG2
, s_vector_ref
);
139 SCM_ASSERT_RANGE (2, k
, SCM_INUM (k
) < SCM_VECTOR_LENGTH (v
) && SCM_INUM (k
) >= 0);
140 return SCM_VELTS (v
)[(long) SCM_INUM (k
)];
144 SCM_GPROC (s_vector_set_x
, "vector-set!", 3, 0, 0, scm_vector_set_x
, g_vector_set_x
);
146 /* "@var{k} must be a valid index of @var{vector}.\n"
147 "@code{Vector-set!} stores @var{obj} in element @var{k} of @var{vector}.\n"
148 "The value returned by @samp{vector-set!} is unspecified.\n"
150 "(let ((vec (vector 0 '(2 2 2 2) "Anna")))\n"
151 " (vector-set! vec 1 '("Sue" "Sue"))\n"
152 " vec) @result{} #(0 ("Sue" "Sue") "Anna")\n"
153 "(vector-set! '#(0 1 2) 1 "doe") @result{} @emph{error} ; constant vector\n"
158 scm_vector_set_x (SCM v
, SCM k
, SCM obj
)
159 #define FUNC_NAME s_vector_set_x
161 SCM_GASSERTn (SCM_VECTORP (v
),
162 g_vector_set_x
, scm_list_3 (v
, k
, obj
),
163 SCM_ARG1
, s_vector_set_x
);
164 SCM_GASSERTn (SCM_INUMP (k
),
165 g_vector_set_x
, scm_list_3 (v
, k
, obj
),
166 SCM_ARG2
, s_vector_set_x
);
167 SCM_ASSERT_RANGE (2, k
, SCM_INUM (k
) < SCM_VECTOR_LENGTH (v
) && SCM_INUM (k
) >= 0);
168 SCM_VELTS(v
)[(long) SCM_INUM(k
)] = obj
;
169 return SCM_UNSPECIFIED
;
174 SCM_DEFINE (scm_make_vector
, "make-vector", 1, 1, 0,
176 "Return a newly allocated vector of @var{k} elements. If a\n"
177 "second argument is given, then each position is initialized to\n"
178 "@var{fill}. Otherwise the initial contents of each position is\n"
180 #define FUNC_NAME s_scm_make_vector
182 if (SCM_UNBNDP (fill
))
183 fill
= SCM_UNSPECIFIED
;
187 SCM_ASSERT_RANGE (1, k
, SCM_INUM (k
) >= 0);
188 return scm_c_make_vector (SCM_INUM (k
), fill
);
190 else if (SCM_BIGP (k
))
191 SCM_OUT_OF_RANGE (1, k
);
193 SCM_WRONG_TYPE_ARG (1, k
);
199 scm_c_make_vector (unsigned long int k
, SCM fill
)
200 #define FUNC_NAME s_scm_make_vector
209 SCM_ASSERT_RANGE (1, scm_ulong2num (k
), k
<= SCM_VECTOR_MAX_LENGTH
);
211 base
= scm_gc_malloc (k
* sizeof (scm_t_bits
), "vector");
212 for (j
= 0; j
!= k
; ++j
)
213 base
[j
] = SCM_UNPACK (fill
);
218 v
= scm_cell (SCM_MAKE_VECTOR_TAG (k
, scm_tc7_vector
), (scm_t_bits
) base
);
219 scm_remember_upto_here_1 (fill
);
226 SCM_DEFINE (scm_vector_to_list
, "vector->list", 1, 0, 0,
228 "Return a newly allocated list composed of the elements of @var{v}.\n"
231 "(vector->list '#(dah dah didah)) @result{} (dah dah didah)\n"
232 "(list->vector '(dididit dah)) @result{} #(dididit dah)\n"
234 #define FUNC_NAME s_scm_vector_to_list
239 SCM_VALIDATE_VECTOR (1,v
);
241 for(i
= SCM_VECTOR_LENGTH(v
)-1;i
>= 0;i
--) res
= scm_cons(data
[i
], res
);
247 SCM_DEFINE (scm_vector_fill_x
, "vector-fill!", 2, 0, 0,
249 "Store @var{fill} in every position of @var{vector}. The value\n"
250 "returned by @code{vector-fill!} is unspecified.")
251 #define FUNC_NAME s_scm_vector_fill_x
255 SCM_VALIDATE_VECTOR (1, v
);
256 data
= SCM_VELTS (v
);
257 for(i
= SCM_VECTOR_LENGTH (v
) - 1; i
>= 0; i
--)
259 return SCM_UNSPECIFIED
;
265 scm_vector_equal_p(SCM x
, SCM y
)
268 for(i
= SCM_VECTOR_LENGTH (x
) - 1; i
>= 0; i
--)
269 if (SCM_FALSEP (scm_equal_p (SCM_VELTS (x
)[i
], SCM_VELTS (y
)[i
])))
275 SCM_DEFINE (scm_vector_move_left_x
, "vector-move-left!", 5, 0, 0,
276 (SCM vec1
, SCM start1
, SCM end1
, SCM vec2
, SCM start2
),
277 "Copy elements from @var{vec1}, positions @var{start1} to @var{end1},\n"
278 "to @var{vec2} starting at position @var{start2}. @var{start1} and\n"
279 "@var{start2} are inclusive indices; @var{end1} is exclusive.\n\n"
280 "@code{vector-move-left!} copies elements in leftmost order.\n"
281 "Therefore, in the case where @var{vec1} and @var{vec2} refer to the\n"
282 "same vector, @code{vector-move-left!} is usually appropriate when\n"
283 "@var{start1} is greater than @var{start2}.")
284 #define FUNC_NAME s_scm_vector_move_left_x
290 SCM_VALIDATE_VECTOR (1,vec1
);
291 SCM_VALIDATE_INUM_COPY (2,start1
,i
);
292 SCM_VALIDATE_INUM_COPY (3,end1
,e
);
293 SCM_VALIDATE_VECTOR (4,vec2
);
294 SCM_VALIDATE_INUM_COPY (5,start2
,j
);
295 SCM_ASSERT_RANGE (2, start1
, i
<= SCM_VECTOR_LENGTH (vec1
) && i
>= 0);
296 SCM_ASSERT_RANGE (5, start2
, j
<= SCM_VECTOR_LENGTH (vec2
) && j
>= 0);
297 SCM_ASSERT_RANGE (3, end1
, e
<= SCM_VECTOR_LENGTH (vec1
) && e
>= 0);
298 SCM_ASSERT_RANGE (5, start2
, e
-i
+j
<= SCM_VECTOR_LENGTH (vec2
));
299 while (i
<e
) SCM_VELTS (vec2
)[j
++] = SCM_VELTS (vec1
)[i
++];
300 return SCM_UNSPECIFIED
;
304 SCM_DEFINE (scm_vector_move_right_x
, "vector-move-right!", 5, 0, 0,
305 (SCM vec1
, SCM start1
, SCM end1
, SCM vec2
, SCM start2
),
306 "Copy elements from @var{vec1}, positions @var{start1} to @var{end1},\n"
307 "to @var{vec2} starting at position @var{start2}. @var{start1} and\n"
308 "@var{start2} are inclusive indices; @var{end1} is exclusive.\n\n"
309 "@code{vector-move-right!} copies elements in rightmost order.\n"
310 "Therefore, in the case where @var{vec1} and @var{vec2} refer to the\n"
311 "same vector, @code{vector-move-right!} is usually appropriate when\n"
312 "@var{start1} is less than @var{start2}.")
313 #define FUNC_NAME s_scm_vector_move_right_x
319 SCM_VALIDATE_VECTOR (1,vec1
);
320 SCM_VALIDATE_INUM_COPY (2,start1
,i
);
321 SCM_VALIDATE_INUM_COPY (3,end1
,e
);
322 SCM_VALIDATE_VECTOR (4,vec2
);
323 SCM_VALIDATE_INUM_COPY (5,start2
,j
);
324 SCM_ASSERT_RANGE (2, start1
, i
<= SCM_VECTOR_LENGTH (vec1
) && i
>= 0);
325 SCM_ASSERT_RANGE (5, start2
, j
<= SCM_VECTOR_LENGTH (vec2
) && j
>= 0);
326 SCM_ASSERT_RANGE (3, end1
, e
<= SCM_VECTOR_LENGTH (vec1
) && e
>= 0);
328 SCM_ASSERT_RANGE (5, start2
, j
<= SCM_VECTOR_LENGTH (vec2
));
330 SCM_VELTS (vec2
)[--j
] = SCM_VELTS (vec1
)[--e
];
331 return SCM_UNSPECIFIED
;
340 scm_nullvect
= scm_c_make_vector (0, SCM_UNDEFINED
);
342 #include "libguile/vectors.x"