1
Fork 0
mirror of https://git.savannah.gnu.org/git/guile.git synced 2025-04-29 19:30:36 +02:00
guile/libguile/vectors.c
Daniel Llorens 6be51f9bbf Provide xxvector-copy and xxvector-copy! for srfi-4 vectors
These use the argument conventions of vector-copy!, string-copy!,
etc. and not that of bytevector-copy! (which is from r6rs).

* module/srfi/srfi-4/gnu.scm: As stated.
* test-suite/tests/srfi-4.test: Tests.
* doc/ref/srfi-modules.texi: Documentation.
* libguile/bytevectors.c (bytevector-copy!): Add overlap note to
  docstring.
* libguile/vectors.c (vector-copy!): Reuse text for the overlap note.
2021-10-21 15:05:46 +02:00

606 lines
18 KiB
C
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

/* Copyright 1995-1996,1998-2001,2006,2008-2012,2014,2018-2020
Free Software Foundation, Inc.
This file is part of Guile.
Guile is free software: you can redistribute it and/or modify it
under the terms of the GNU Lesser General Public License as published
by the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
Guile is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
License for more details.
You should have received a copy of the GNU Lesser General Public
License along with Guile. If not, see
<https://www.gnu.org/licenses/>. */
#ifdef HAVE_CONFIG_H
# include <config.h>
#endif
#include <string.h>
#include "array-handle.h"
#include "bdw-gc.h"
#include "boolean.h"
#include "deprecation.h"
#include "eq.h"
#include "generalized-vectors.h"
#include "gsubr.h"
#include "list.h"
#include "numbers.h"
#include "pairs.h"
#include "vectors.h"
#define VECTOR_MAX_LENGTH (SCM_T_BITS_MAX >> 8)
#define SCM_VALIDATE_MUTABLE_VECTOR(pos, v) \
do { \
SCM_ASSERT_TYPE (SCM_I_IS_MUTABLE_VECTOR (v), v, pos, FUNC_NAME, \
"mutable vector"); \
} while (0)
int
scm_is_vector (SCM obj)
{
return SCM_I_IS_VECTOR (obj);
}
const SCM *
scm_vector_elements (SCM array, scm_t_array_handle *h,
size_t *lenp, ssize_t *incp)
{
scm_array_get_handle (array, h);
if (1 != scm_array_handle_rank (h))
{
scm_array_handle_release (h);
scm_wrong_type_arg_msg (NULL, 0, array, "rank 1 array of Scheme values");
}
if (lenp)
{
scm_t_array_dim *dim = scm_array_handle_dims (h);
*lenp = dim->ubnd - dim->lbnd + 1;
*incp = dim->inc;
}
return scm_array_handle_elements (h);
}
SCM *
scm_vector_writable_elements (SCM array, scm_t_array_handle *h,
size_t *lenp, ssize_t *incp)
{
const SCM *ret = scm_vector_elements (array, h, lenp, incp);
if (h->writable_elements != h->elements)
scm_wrong_type_arg_msg (NULL, 0, array, "mutable rank 1 array of Scheme values");
return (SCM *) ret;
}
SCM_DEFINE (scm_vector_p, "vector?", 1, 0, 0,
(SCM obj),
"Return @code{#t} if @var{obj} is a vector, otherwise return\n"
"@code{#f}.")
#define FUNC_NAME s_scm_vector_p
{
return scm_from_bool (scm_is_vector (obj));
}
#undef FUNC_NAME
SCM_DEFINE (scm_vector_length, "vector-length", 1, 0, 0,
(SCM v),
"Returns the number of elements in @var{vector} as an exact integer.")
#define FUNC_NAME s_scm_vector_length
{
return scm_from_size_t (scm_c_vector_length (v));
}
#undef FUNC_NAME
size_t
scm_c_vector_length (SCM v)
#define FUNC_NAME s_scm_vector_length
{
SCM_VALIDATE_VECTOR (1, v);
return SCM_I_VECTOR_LENGTH (v);
}
#undef FUNC_NAME
SCM_REGISTER_PROC (s_list_to_vector, "list->vector", 1, 0, 0, scm_vector);
/*
"Return a newly created vector initialized to the elements of"
"the list @var{list}.\n\n"
"@lisp\n"
"(vector->list '#(dah dah didah)) @result{} (dah dah didah)\n"
"(list->vector '(dididit dah)) @result{} #(dididit dah)\n"
"@end lisp")
*/
SCM_DEFINE (scm_vector, "vector", 0, 0, 1,
(SCM l),
"@deffnx {Scheme Procedure} list->vector l\n"
"Return a newly allocated vector composed of the\n"
"given arguments. Analogous to @code{list}.\n"
"\n"
"@lisp\n"
"(vector 'a 'b 'c) @result{} #(a b c)\n"
"@end lisp")
#define FUNC_NAME s_scm_vector
{
SCM res;
SCM *data;
long i, len;
SCM_VALIDATE_LIST_COPYLEN (1, l, len);
res = scm_c_make_vector (len, SCM_UNSPECIFIED);
data = SCM_I_VECTOR_WELTS (res);
i = 0;
while (scm_is_pair (l) && i < len)
{
data[i] = SCM_CAR (l);
l = SCM_CDR (l);
i += 1;
}
return res;
}
#undef FUNC_NAME
SCM_DEFINE (scm_vector_ref, "vector-ref", 2, 0, 0,
(SCM vector, SCM k),
"@var{k} must be a valid index of @var{vector}.\n"
"@samp{Vector-ref} returns the contents of element @var{k} of\n"
"@var{vector}.\n\n"
"@lisp\n"
"(vector-ref '#(1 1 2 3 5 8 13 21) 5) @result{} 8\n"
"(vector-ref '#(1 1 2 3 5 8 13 21)\n"
" (let ((i (round (* 2 (acos -1)))))\n"
" (if (inexact? i)\n"
" (inexact->exact i)\n"
" i))) @result{} 13\n"
"@end lisp")
#define FUNC_NAME s_scm_vector_ref
{
return scm_c_vector_ref (vector, scm_to_size_t (k));
}
#undef FUNC_NAME
SCM
scm_c_vector_ref (SCM v, size_t k)
#define FUNC_NAME s_scm_vector_ref
{
SCM_VALIDATE_VECTOR (1, v);
if (k >= SCM_I_VECTOR_LENGTH (v))
scm_out_of_range (NULL, scm_from_size_t (k));
return SCM_SIMPLE_VECTOR_REF (v, k);
}
#undef FUNC_NAME
SCM_DEFINE (scm_vector_set_x, "vector-set!", 3, 0, 0,
(SCM vector, SCM k, SCM obj),
"@var{k} must be a valid index of @var{vector}.\n"
"@code{Vector-set!} stores @var{obj} in element @var{k} of @var{vector}.\n"
"The value returned by @samp{vector-set!} is unspecified.\n"
"@lisp\n"
"(let ((vec (vector 0 '(2 2 2 2) \"Anna\")))\n"
" (vector-set! vec 1 '(\"Sue\" \"Sue\"))\n"
" vec) @result{} #(0 (\"Sue\" \"Sue\") \"Anna\")\n"
"(vector-set! '#(0 1 2) 1 \"doe\") @result{} @emph{error} ; constant vector\n"
"@end lisp")
#define FUNC_NAME s_scm_vector_set_x
{
scm_c_vector_set_x (vector, scm_to_size_t (k), obj);
return SCM_UNSPECIFIED;
}
#undef FUNC_NAME
void
scm_c_vector_set_x (SCM v, size_t k, SCM obj)
#define FUNC_NAME s_scm_vector_set_x
{
SCM_VALIDATE_MUTABLE_VECTOR (1, v);
if (k >= SCM_I_VECTOR_LENGTH (v))
scm_out_of_range (NULL, scm_from_size_t (k));
SCM_SIMPLE_VECTOR_SET (v, k, obj);
}
#undef FUNC_NAME
SCM_DEFINE (scm_make_vector, "make-vector", 1, 1, 0,
(SCM k, SCM fill),
"Return a newly allocated vector of @var{k} elements. If a\n"
"second argument is given, then each position is initialized to\n"
"@var{fill}. Otherwise the initial contents of each position is\n"
"unspecified.")
#define FUNC_NAME s_scm_make_vector
{
size_t l = scm_to_unsigned_integer (k, 0, VECTOR_MAX_LENGTH);
if (SCM_UNBNDP (fill))
fill = SCM_UNSPECIFIED;
return scm_c_make_vector (l, fill);
}
#undef FUNC_NAME
static SCM
make_vector (size_t size)
{
return scm_words ((size << 8) | scm_tc7_vector, size + 1);
}
SCM
scm_c_make_vector (size_t k, SCM fill)
#define FUNC_NAME s_scm_make_vector
{
SCM vector;
size_t j;
SCM_ASSERT_RANGE (1, scm_from_size_t (k), k <= VECTOR_MAX_LENGTH);
vector = make_vector (k);
for (j = 0; j < k; ++j)
SCM_SIMPLE_VECTOR_SET (vector, j, fill);
return vector;
}
#undef FUNC_NAME
SCM_DEFINE (scm_vector_copy_partial, "vector-copy", 1, 2, 0,
(SCM vec, SCM start, SCM end),
"Returns a freshly allocated vector containing the elements\n"
"of @var{vec} between @var{start} and @var{end}.\n\n"
"@var{start} defaults to 0 and @var{end} defaults to the\n"
"length of @var{vec}.")
#define FUNC_NAME s_scm_vector_copy_partial
{
SCM result;
if (SCM_I_IS_VECTOR (vec))
{
size_t cstart = 0, cend = SCM_I_VECTOR_LENGTH (vec);
if (!SCM_UNBNDP (start))
{
cstart = scm_to_size_t (start);
SCM_ASSERT_RANGE (SCM_ARG2, start, cstart<=cend);
if (!SCM_UNBNDP (end))
{
size_t e = scm_to_size_t (end);
SCM_ASSERT_RANGE (SCM_ARG3, end, e>=cstart && e<=cend);
cend = e;
}
}
size_t len = cend-cstart;
result = make_vector (len);
memcpy (SCM_I_VECTOR_WELTS (result), SCM_I_VECTOR_ELTS (vec) + cstart,
len * sizeof(SCM));
}
else
{
scm_t_array_handle handle;
size_t i, len;
ssize_t inc;
const SCM *src;
SCM *dst;
src = scm_vector_elements (vec, &handle, &len, &inc);
scm_c_issue_deprecation_warning
("Using vector-copy on arrays is deprecated. "
"Use array-copy instead.");
if (SCM_UNBNDP (start))
scm_misc_error (s_scm_vector_copy_partial, "Too many arguments", SCM_EOL);
result = make_vector (len);
dst = SCM_I_VECTOR_WELTS (result);
for (i = 0; i < len; i++, src += inc)
dst[i] = *src;
scm_array_handle_release (&handle);
}
return result;
}
#undef FUNC_NAME
SCM
scm_vector_copy (SCM vec)
{
return scm_vector_copy_partial (vec, SCM_UNDEFINED, SCM_UNDEFINED);
}
SCM_DEFINE (scm_vector_copy_x, "vector-copy!", 3, 2, 0,
(SCM dst, SCM at, SCM src, SCM start, SCM end),
"Copy a block of elements from @var{src} to @var{dst}, both of which must be\n"
"vectors, starting in @var{dst} at @var{at} and starting in @var{src} at\n"
"@var{start} and ending at @var{end}.\n\n"
"It is an error for @var{dst} to have a length less than\n"
"@var{at} + (@var{end} - @var{start}). @var{at} and @var{start} default\n"
"to 0 and @var{end} defaults to the length of @var{src}.\n\n"
"If source and destination overlap, copying takes place as if the source\n"
"is first copied into a temporary vector and then into the destination.")
#define FUNC_NAME s_scm_vector_copy_x
{
SCM_VALIDATE_MUTABLE_VECTOR (1, dst);
SCM_VALIDATE_VECTOR (3, src);
size_t src_org = 0;
size_t dst_org = scm_to_size_t (at);
size_t src_end = SCM_I_VECTOR_LENGTH (src);
size_t dst_end = SCM_I_VECTOR_LENGTH (dst);
if (!SCM_UNBNDP (start))
{
src_org = scm_to_size_t (start);
SCM_ASSERT_RANGE (SCM_ARG4, start, src_org<=src_end);
if (!SCM_UNBNDP (end))
{
size_t e = scm_to_size_t (end);
SCM_ASSERT_RANGE (SCM_ARG5, end, e>=src_org && e<=src_end);
src_end = e;
}
}
size_t len = src_end-src_org;
SCM_ASSERT_RANGE (SCM_ARG2, at, dst_org<=dst_end && len<=dst_end-dst_org);
memmove (SCM_I_VECTOR_WELTS (dst) + dst_org, SCM_I_VECTOR_ELTS (src) + src_org,
len * sizeof(SCM));
return SCM_UNSPECIFIED;
}
#undef FUNC_NAME
SCM_DEFINE (scm_vector_to_list, "vector->list", 1, 0, 0,
(SCM vec),
"Return a newly allocated list composed of the elements of @var{vec}.\n"
"\n"
"@lisp\n"
"(vector->list '#(dah dah didah)) @result{} (dah dah didah)\n"
"(list->vector '(dididit dah)) @result{} #(dididit dah)\n"
"@end lisp")
#define FUNC_NAME s_scm_vector_to_list
{
SCM res = SCM_EOL;
if (SCM_I_IS_VECTOR (vec))
{
ssize_t len = SCM_I_VECTOR_LENGTH (vec);
const SCM * data = SCM_I_VECTOR_ELTS (vec);
for (ssize_t i = len-1; i >= 0; --i)
res = scm_cons (data[i], res);
}
else
{
const SCM *data;
scm_t_array_handle handle;
size_t i, count, len;
ssize_t inc;
data = scm_vector_elements (vec, &handle, &len, &inc);
scm_c_issue_deprecation_warning
("Using vector->list on arrays is deprecated. "
"Use array->list instead.");
for (i = (len - 1) * inc, count = 0;
count < len;
i -= inc, count++)
res = scm_cons (data[i], res);
scm_array_handle_release (&handle);
}
return res;
}
#undef FUNC_NAME
static SCM scm_vector_fill_partial_x (SCM vec, SCM fill, SCM start, SCM end);
SCM_DEFINE_STATIC (scm_vector_fill_partial_x, "vector-fill!", 2, 2, 0,
(SCM vec, SCM fill, SCM start, SCM end),
"Assign the value of every location in vector @var{vec} in the range\n"
"[@var{start} ... @var{end}) to @var{fill}. @var{start} defaults\n"
"to 0 and @var{end} defaults to the length of @var{vec}. The value\n"
"returned by @code{vector-fill!} is unspecified.")
#define FUNC_NAME s_scm_vector_fill_partial_x
{
SCM_VALIDATE_MUTABLE_VECTOR(1, vec);
size_t i = 0;
size_t c_end = SCM_I_VECTOR_LENGTH (vec);
SCM *data = SCM_I_VECTOR_WELTS (vec);
if (!SCM_UNBNDP (start))
i = scm_to_unsigned_integer (start, 0, c_end);
if (!SCM_UNBNDP (end))
c_end = scm_to_unsigned_integer (end, i, c_end);
for (; i < c_end; ++i)
data[i] = fill;
return SCM_UNSPECIFIED;
}
#undef FUNC_NAME
SCM
scm_vector_fill_x (SCM vec, SCM fill)
#define FUNC_NAME s_scm_vector_fill_x
{
return scm_vector_fill_partial_x (vec, fill, SCM_UNDEFINED, SCM_UNDEFINED);
}
#undef FUNC_NAME
SCM
scm_i_vector_equal_p (SCM x, SCM y)
{
long i;
for (i = SCM_I_VECTOR_LENGTH (x) - 1; i >= 0; i--)
if (scm_is_false (scm_equal_p (SCM_I_VECTOR_ELTS (x)[i],
SCM_I_VECTOR_ELTS (y)[i])))
return SCM_BOOL_F;
return SCM_BOOL_T;
}
SCM_DEFINE (scm_vector_move_left_x, "vector-move-left!", 5, 0, 0,
(SCM vec1, SCM start1, SCM end1, SCM vec2, SCM start2),
"Copy elements from @var{vec1}, positions @var{start1} to @var{end1},\n"
"to @var{vec2} starting at position @var{start2}. @var{start1} and\n"
"@var{start2} are inclusive indices; @var{end1} is exclusive.\n\n"
"@code{vector-move-left!} copies elements in leftmost order.\n"
"Therefore, in the case where @var{vec1} and @var{vec2} refer to the\n"
"same vector, @code{vector-move-left!} is usually appropriate when\n"
"@var{start1} is greater than @var{start2}.")
#define FUNC_NAME s_scm_vector_move_left_x
{
if (SCM_I_IS_VECTOR (vec1) && SCM_I_IS_VECTOR (vec2))
{
SCM_VALIDATE_MUTABLE_VECTOR (1, vec2);
const SCM *elts1 = SCM_I_VECTOR_ELTS (vec1);
SCM *elts2 = SCM_I_VECTOR_WELTS (vec2);
size_t len1 = SCM_I_VECTOR_LENGTH (vec1);
size_t len2 = SCM_I_VECTOR_LENGTH (vec2);
size_t i, j, e;
i = scm_to_unsigned_integer (start1, 0, len1);
e = scm_to_unsigned_integer (end1, i, len1);
SCM_ASSERT_RANGE (SCM_ARG3, end1, (e-i) <= len2);
j = scm_to_unsigned_integer (start2, 0, len2);
SCM_ASSERT_RANGE (SCM_ARG5, start2, j <= len2 - (e - i));
for (; i < e; ++i, ++j)
elts2[j] = elts1[i];
}
else
{
scm_t_array_handle handle1, handle2;
const SCM *elts1;
SCM *elts2;
size_t len1, len2;
ssize_t inc1, inc2;
size_t i, j, e;
elts1 = scm_vector_elements (vec1, &handle1, &len1, &inc1);
elts2 = scm_vector_writable_elements (vec2, &handle2, &len2, &inc2);
scm_c_issue_deprecation_warning
("Using vector-move-left! on arrays is deprecated. "
"Use array-copy-in-order! instead.");
i = scm_to_unsigned_integer (start1, 0, len1);
e = scm_to_unsigned_integer (end1, i, len1);
SCM_ASSERT_RANGE (SCM_ARG3, end1, (e-i) <= len2);
j = scm_to_unsigned_integer (start2, 0, len2);
SCM_ASSERT_RANGE (SCM_ARG5, start2, j <= len2 - (e - i));
i *= inc1;
e *= inc1;
j *= inc2;
for (; i < e; i += inc1, j += inc2)
elts2[j] = elts1[i];
scm_array_handle_release (&handle2);
scm_array_handle_release (&handle1);
}
return SCM_UNSPECIFIED;
}
#undef FUNC_NAME
SCM_DEFINE (scm_vector_move_right_x, "vector-move-right!", 5, 0, 0,
(SCM vec1, SCM start1, SCM end1, SCM vec2, SCM start2),
"Copy elements from @var{vec1}, positions @var{start1} to @var{end1},\n"
"to @var{vec2} starting at position @var{start2}. @var{start1} and\n"
"@var{start2} are inclusive indices; @var{end1} is exclusive.\n\n"
"@code{vector-move-right!} copies elements in rightmost order.\n"
"Therefore, in the case where @var{vec1} and @var{vec2} refer to the\n"
"same vector, @code{vector-move-right!} is usually appropriate when\n"
"@var{start1} is less than @var{start2}.")
#define FUNC_NAME s_scm_vector_move_right_x
{
if (SCM_I_IS_VECTOR (vec1) && SCM_I_IS_VECTOR (vec2))
{
SCM_VALIDATE_MUTABLE_VECTOR (1, vec2);
const SCM *elts1 = SCM_I_VECTOR_ELTS (vec1);
SCM *elts2 = SCM_I_VECTOR_WELTS (vec2);
size_t len1 = SCM_I_VECTOR_LENGTH (vec1);
size_t len2 = SCM_I_VECTOR_LENGTH (vec2);
size_t i, j, e;
i = scm_to_unsigned_integer (start1, 0, len1);
e = scm_to_unsigned_integer (end1, i, len1);
SCM_ASSERT_RANGE (SCM_ARG3, end1, (e-i) <= len2);
j = scm_to_unsigned_integer (start2, 0, len2);
SCM_ASSERT_RANGE (SCM_ARG5, start2, j <= len2 - (e - i));
j += (e - i);
while (i < e)
{
--e;
--j;
elts2[j] = elts1[e];
}
}
else
{
scm_t_array_handle handle1, handle2;
const SCM *elts1;
SCM *elts2;
size_t len1, len2;
ssize_t inc1, inc2;
size_t i, j, e;
elts1 = scm_vector_elements (vec1, &handle1, &len1, &inc1);
elts2 = scm_vector_writable_elements (vec2, &handle2, &len2, &inc2);
scm_c_issue_deprecation_warning
("Using vector-move-right! on arrays is deprecated. "
"Use array-copy-in-order! instead.");
i = scm_to_unsigned_integer (start1, 0, len1);
e = scm_to_unsigned_integer (end1, i, len1);
SCM_ASSERT_RANGE (SCM_ARG3, end1, (e-i) <= len2);
j = scm_to_unsigned_integer (start2, 0, len2);
SCM_ASSERT_RANGE (SCM_ARG5, start2, j <= len2 - (e - i));
j += (e - i);
i *= inc1;
e *= inc1;
j *= inc2;
while (i < e)
{
e -= inc1;
j -= inc2;
elts2[j] = elts1[e];
}
scm_array_handle_release (&handle2);
scm_array_handle_release (&handle1);
}
return SCM_UNSPECIFIED;
}
#undef FUNC_NAME
SCM_VECTOR_IMPLEMENTATION (SCM_ARRAY_ELEMENT_TYPE_SCM, scm_make_vector)
void
scm_init_vectors ()
{
#include "vectors.x"
}