*** empty log message ***
[bpt/guile.git] / libguile / vectors.c
index f5f8d4d..efd7434 100644 (file)
@@ -12,7 +12,7 @@
  *
  * You should have received a copy of the GNU Lesser General Public
  * License along with this library; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  */
 
 
 #include "libguile/srfi-4.h"
 #include "libguile/strings.h"
 #include "libguile/srfi-13.h"
+#include "libguile/dynwind.h"
+#include "libguile/deprecation.h"
 
 \f
 
+#define VECTOR_MAX_LENGTH (SCM_T_BITS_MAX >> 8)
+
 int
 scm_is_vector (SCM obj)
 {
-  return (SCM_VECTORP (obj)
-         || (SCM_ARRAYP (obj) && SCM_ARRAY_NDIM (obj) == 1));
+  if (SCM_I_IS_VECTOR (obj))
+    return 1;
+  if  (SCM_I_ARRAYP (obj) && SCM_I_ARRAY_NDIM (obj) == 1)
+    {
+      SCM v = SCM_I_ARRAY_V (obj);
+      return SCM_I_IS_VECTOR (v);
+    }
+  return 0;
+}
+
+int
+scm_is_simple_vector (SCM obj)
+{
+  return SCM_I_IS_VECTOR (obj);
+}
+
+const SCM *
+scm_vector_elements (SCM vec, scm_t_array_handle *h,
+                    size_t *lenp, ssize_t *incp)
+{
+  scm_generalized_vector_get_handle (vec, h);
+  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 vec, scm_t_array_handle *h,
+                             size_t *lenp, ssize_t *incp)
+{
+  scm_generalized_vector_get_handle (vec, h);
+  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_writable_elements (h);
 }
 
 SCM_DEFINE (scm_vector_p, "vector?", 1, 0, 0, 
@@ -56,11 +100,11 @@ SCM_GPROC (s_vector_length, "vector-length", 1, 0, 0, scm_vector_length, g_vecto
 SCM
 scm_vector_length (SCM v)
 {
-  if (SCM_VECTORP (v))
-    return scm_from_size_t (SCM_VECTOR_LENGTH (v));
-  else if (SCM_ARRAYP (v) && SCM_ARRAY_NDIM (v) == 1)
+  if (SCM_I_IS_VECTOR (v))
+    return scm_from_size_t (SCM_I_VECTOR_LENGTH (v));
+  else if (SCM_I_ARRAYP (v) && SCM_I_ARRAY_NDIM (v) == 1)
     {
-      scm_t_array_dim *dim = SCM_ARRAY_DIMS (v);
+      scm_t_array_dim *dim = SCM_I_ARRAY_DIMS (v);
       return scm_from_size_t (dim->ubnd - dim->lbnd + 1);
     }
   else
@@ -70,8 +114,8 @@ scm_vector_length (SCM v)
 size_t
 scm_c_vector_length (SCM v)
 {
-  if (SCM_VECTORP (v))
-    return SCM_VECTOR_LENGTH (v);
+  if (SCM_I_IS_VECTOR (v))
+    return SCM_I_VECTOR_LENGTH (v);
   else
     return scm_to_size_t (scm_vector_length (v));
 }
@@ -98,23 +142,23 @@ SCM_DEFINE (scm_vector, "vector", 0, 0, 1,
 {
   SCM res;
   SCM *data;
-  long i;
+  long i, len;
+  scm_t_array_handle handle;
 
-  /* Dirk:FIXME:: In case of multiple threads, the list might get corrupted
-     while the vector is being created. */
-  SCM_VALIDATE_LIST_COPYLEN (1, l, i);
-  res = scm_c_make_vector (i, SCM_UNSPECIFIED);
+  SCM_VALIDATE_LIST_COPYLEN (1, l, len);
 
-  /*
-    this code doesn't alloc. -- accessing RES is safe. 
-  */
-  data = SCM_WRITABLE_VELTS (res);
-  while (!SCM_NULL_OR_NIL_P (l)) 
+  res = scm_c_make_vector (len, SCM_UNSPECIFIED);
+  data = scm_vector_writable_elements (res, &handle, NULL, NULL);
+  i = 0;
+  while (scm_is_pair (l) && i < len) 
     {
-      *data++ = SCM_CAR (l);
+      data[i] = SCM_CAR (l);
       l = SCM_CDR (l);
+      i += 1;
     }
 
+  scm_array_handle_release (&handle);
+
   return res;
 }
 #undef FUNC_NAME
@@ -146,19 +190,24 @@ scm_vector_ref (SCM v, SCM k)
 SCM
 scm_c_vector_ref (SCM v, size_t k)
 {
-  if (SCM_VECTORP (v))
+  if (SCM_I_IS_VECTOR (v))
     {
-      if (k >= SCM_VECTOR_LENGTH (v))
+      if (k >= SCM_I_VECTOR_LENGTH (v))
        scm_out_of_range (NULL, scm_from_size_t (k)); 
-      return SCM_VECTOR_REF (v, k);
+      return (SCM_I_VECTOR_ELTS(v))[k];
     }
-  else if (SCM_ARRAYP (v) && SCM_ARRAY_NDIM (v) == 1)
+  else if (SCM_I_ARRAYP (v) && SCM_I_ARRAY_NDIM (v) == 1)
     {
-      scm_t_array_dim *dim = SCM_ARRAY_DIMS (v);
-      if (k >= dim->ubnd - dim->lbnd + 1)
-       scm_out_of_range (NULL, scm_from_size_t (k));
-      k = SCM_ARRAY_BASE (v) + k*dim->inc;
-      return scm_c_generalized_vector_ref (SCM_ARRAY_V (v), k);
+      scm_t_array_dim *dim = SCM_I_ARRAY_DIMS (v);
+      SCM vv = SCM_I_ARRAY_V (v);
+      if (SCM_I_IS_VECTOR (vv))
+       {
+         if (k >= dim->ubnd - dim->lbnd + 1)
+           scm_out_of_range (NULL, scm_from_size_t (k));
+         k = SCM_I_ARRAY_BASE (v) + k*dim->inc;
+         return (SCM_I_VECTOR_ELTS (vv))[k];
+       }
+      scm_wrong_type_arg_msg (NULL, 0, v, "non-uniform vector");
     }
   else
     SCM_WTA_DISPATCH_2 (g_vector_ref, v, scm_from_size_t (k), 2, NULL);
@@ -189,19 +238,25 @@ scm_vector_set_x (SCM v, SCM k, SCM obj)
 void
 scm_c_vector_set_x (SCM v, size_t k, SCM obj)
 {
-  if (SCM_VECTORP (v))
+  if (SCM_I_IS_VECTOR (v))
     {
-      if (k >= SCM_VECTOR_LENGTH (v))
+      if (k >= SCM_I_VECTOR_LENGTH (v))
        scm_out_of_range (NULL, scm_from_size_t (k)); 
-      SCM_VECTOR_SET (v, k, obj);
+      (SCM_I_VECTOR_WELTS(v))[k] = obj;
     }
-  else if (SCM_ARRAYP (v) && SCM_ARRAY_NDIM (v) == 1)
+  else if (SCM_I_ARRAYP (v) && SCM_I_ARRAY_NDIM (v) == 1)
     {
-      scm_t_array_dim *dim = SCM_ARRAY_DIMS (v);
-      if (k >= dim->ubnd - dim->lbnd + 1)
-       scm_out_of_range (NULL, scm_from_size_t (k));
-      k = SCM_ARRAY_BASE (v) + k*dim->inc;
-      scm_c_generalized_vector_set_x (SCM_ARRAY_V (v), k, obj);
+      scm_t_array_dim *dim = SCM_I_ARRAY_DIMS (v);
+      SCM vv = SCM_I_ARRAY_V (v);
+      if (SCM_I_IS_VECTOR (vv))
+       {
+         if (k >= dim->ubnd - dim->lbnd + 1)
+           scm_out_of_range (NULL, scm_from_size_t (k));
+         k = SCM_I_ARRAY_BASE (v) + k*dim->inc;
+         (SCM_I_VECTOR_WELTS (vv))[k] = obj;
+       }
+      else
+       scm_wrong_type_arg_msg (NULL, 0, v, "non-uniform vector");
     }
   else
     {
@@ -221,7 +276,7 @@ SCM_DEFINE (scm_make_vector, "make-vector", 1, 1, 0,
            "unspecified.")
 #define FUNC_NAME s_scm_make_vector
 {
-  size_t l = scm_to_unsigned_integer (k, 0, SCM_VECTOR_MAX_LENGTH);
+  size_t l = scm_to_unsigned_integer (k, 0, VECTOR_MAX_LENGTH);
 
   if (SCM_UNBNDP (fill))
     fill = SCM_UNSPECIFIED;
@@ -236,28 +291,93 @@ scm_c_make_vector (size_t k, SCM fill)
 #define FUNC_NAME s_scm_make_vector
 {
   SCM v;
-  scm_t_bits *base;
+  SCM *base;
 
   if (k > 0) 
     {
       unsigned long int j;
 
-      SCM_ASSERT_RANGE (1, scm_from_ulong (k), k <= SCM_VECTOR_MAX_LENGTH);
+      SCM_ASSERT_RANGE (1, scm_from_ulong (k), k <= VECTOR_MAX_LENGTH);
 
-      base = scm_gc_malloc (k * sizeof (scm_t_bits), "vector");
+      base = scm_gc_malloc (k * sizeof (SCM), "vector");
       for (j = 0; j != k; ++j)
-       base[j] = SCM_UNPACK (fill);
+       base[j] = fill;
     }
   else
     base = NULL;
 
-  v = scm_cell (SCM_MAKE_VECTOR_TAG (k, scm_tc7_vector), (scm_t_bits) base);
+  v = scm_cell ((k << 8) | scm_tc7_vector, (scm_t_bits) base);
   scm_remember_upto_here_1 (fill);
 
   return v;
 }
 #undef FUNC_NAME
 
+SCM_DEFINE (scm_vector_copy, "vector-copy", 1, 0, 0,
+           (SCM vec),
+           "Return a copy of @var{vec}.")
+#define FUNC_NAME s_scm_vector_copy
+{
+  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);
+  dst = scm_gc_malloc (len * sizeof (SCM), "vector");
+  for (i = 0; i < len; i++, src += inc)
+    dst[i] = *src;
+  scm_array_handle_release (&handle);
+
+  return scm_cell ((len << 8) | scm_tc7_vector, (scm_t_bits) dst);
+}
+#undef FUNC_NAME
+
+void
+scm_i_vector_free (SCM vec)
+{
+  scm_gc_free (SCM_I_VECTOR_WELTS (vec),
+              SCM_I_VECTOR_LENGTH (vec) * sizeof(SCM),
+              "vector");
+}
+
+/* Allocate memory for a weak vector on behalf of the caller.  The allocated
+ * vector will be of the given weak vector subtype.  It will contain size
+ * elements which are initialized with the 'fill' object, or, if 'fill' is
+ * undefined, with an unspecified object.
+ */
+SCM
+scm_i_allocate_weak_vector (scm_t_bits type, SCM size, SCM fill)
+{
+  size_t c_size;
+  SCM *base;
+  SCM v;
+
+  c_size = scm_to_unsigned_integer (size, 0, VECTOR_MAX_LENGTH);
+
+  if (c_size > 0)
+    {
+      size_t j;
+      
+      if (SCM_UNBNDP (fill))
+       fill = SCM_UNSPECIFIED;
+      
+      base = scm_gc_malloc (c_size * sizeof (SCM), "weak vector");
+      for (j = 0; j != c_size; ++j)
+       base[j] = fill;
+    }
+  else
+    base = NULL;
+
+  v = scm_double_cell ((c_size << 8) | scm_tc7_wvect,
+                      (scm_t_bits) base,
+                      type,
+                      SCM_UNPACK (SCM_EOL));
+  scm_remember_upto_here_1 (fill);
+
+  return v;
+}
 
 SCM_DEFINE (scm_vector_to_list, "vector->list", 1, 0, 0, 
            (SCM v),
@@ -269,20 +389,20 @@ SCM_DEFINE (scm_vector_to_list, "vector->list", 1, 0, 0,
            "@end lisp")
 #define FUNC_NAME s_scm_vector_to_list
 {
-  if (SCM_VECTORP (v))
+  SCM res = SCM_EOL;
+  const SCM *data;
+  scm_t_array_handle handle;
+  size_t i, len;
+  ssize_t inc;
+
+  data = scm_vector_elements (v, &handle, &len, &inc);
+  for (i = len*inc; i > 0;)
     {
-      SCM res = SCM_EOL;
-      long i;
-      SCM const *data;
-      data = SCM_VELTS(v);
-      for(i = SCM_VECTOR_LENGTH(v)-1; i >= 0; i--)
-       res = scm_cons(data[i], res);
-      return res;
+      i -= inc;
+      res = scm_cons (data[i], res);
     }
-  else if (SCM_ARRAYP (v) && SCM_ARRAY_NDIM (v) == 1)
-    return scm_array_to_list (v);
-  else
-    scm_wrong_type_arg_msg (NULL, 0, v, "vector");
+  scm_array_handle_release (&handle);
+  return res;
 }
 #undef FUNC_NAME
 
@@ -293,27 +413,27 @@ SCM_DEFINE (scm_vector_fill_x, "vector-fill!", 2, 0, 0,
            "returned by @code{vector-fill!} is unspecified.")
 #define FUNC_NAME s_scm_vector_fill_x
 {
-  if (SCM_VECTORP (v))
-    {
-      register long i;
-      for (i = SCM_VECTOR_LENGTH (v) - 1; i >= 0; i--)
-       SCM_VECTOR_SET (v, i, fill);
-      return SCM_UNSPECIFIED;
-    }
-  else if (SCM_ARRAYP (v) && SCM_ARRAY_NDIM (v) == 1)
-    return scm_array_fill_x (v, fill);
-  else
-    scm_wrong_type_arg_msg (NULL, 0, v, "vector");
+  scm_t_array_handle handle;
+  SCM *data;
+  size_t i, len;
+  ssize_t inc;
+
+  data = scm_vector_writable_elements (v, &handle, &len, &inc);
+  for (i = 0; i < len; i += inc)
+    data[i] = fill;
+  scm_array_handle_release (&handle);
+  return SCM_UNSPECIFIED;
 }
 #undef FUNC_NAME
 
 
 SCM
-scm_vector_equal_p(SCM x, SCM y)
+scm_i_vector_equal_p (SCM x, SCM y)
 {
   long i;
-  for(i = SCM_VECTOR_LENGTH (x) - 1; i >= 0; i--)
-    if (scm_is_false (scm_equal_p (SCM_VELTS (x)[i], SCM_VELTS (y)[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;
 }
@@ -330,28 +450,29 @@ SCM_DEFINE (scm_vector_move_left_x, "vector-move-left!", 5, 0, 0,
            "@var{start1} is greater than @var{start2}.")
 #define FUNC_NAME s_scm_vector_move_left_x
 {
+  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);
 
-  len1 = scm_c_vector_length (vec1);
-  len2 = scm_c_vector_length (vec2);
   i = scm_to_unsigned_integer (start1, 0, len1);
   e = scm_to_unsigned_integer (end1, i, len1);
   j = scm_to_unsigned_integer (start2, 0, len2 - (i-e));
   
-  /* Optimize common case of two regular vectors. 
-   */
-  if (SCM_VECTORP (vec1) && SCM_VECTORP (vec2))
-    {
-      for (; i < e; i++, j++)
-       SCM_VECTOR_SET (vec2, j, SCM_VECTOR_REF (vec1, i));
-    }
-  else
-    {
-      for (; i < e; i++, j++)
-       scm_c_vector_set_x (vec2, j, scm_c_vector_ref (vec1, 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
@@ -367,35 +488,33 @@ SCM_DEFINE (scm_vector_move_right_x, "vector-move-right!", 5, 0, 0,
            "@var{start1} is less than @var{start2}.")
 #define FUNC_NAME s_scm_vector_move_right_x
 {
+  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);
 
-  len1 = scm_c_vector_length (vec1);
-  len2 = scm_c_vector_length (vec2);
   i = scm_to_unsigned_integer (start1, 0, len1);
   e = scm_to_unsigned_integer (end1, i, len1);
   j = scm_to_unsigned_integer (start2, 0, len2 - (i-e));
   
-  /* Optimize common case of two regular vectors. 
-   */
-  j += e - i;
-  if (SCM_VECTORP (vec1) && SCM_VECTORP (vec2))
+  i *= inc1;
+  e *= inc1;
+  j *= inc2;
+  while (i < e)
     {
-      while (i < e)
-       {
-         e--, j--;
-         SCM_VECTOR_SET (vec2, j, SCM_VECTOR_REF (vec1, e));
-       }
+      e -= inc1;
+      j -= inc2;
+      elts2[j] = elts1[e];
     }
-  else
-    {
-      while (i < e)
-       {
-         e--, j--;
-         scm_c_vector_set_x (vec2, j, scm_c_vector_ref (vec1, e));
-       }
-    }
-  
+
+  scm_array_handle_release (&handle2);
+  scm_array_handle_release (&handle1);
+
   return SCM_UNSPECIFIED;
 }
 #undef FUNC_NAME
@@ -422,6 +541,14 @@ SCM_DEFINE (scm_generalized_vector_p, "generalized-vector?", 1, 0, 0,
 }
 #undef FUNC_NAME
 
+void
+scm_generalized_vector_get_handle (SCM vec, scm_t_array_handle *h)
+{
+  scm_array_get_handle (vec, h);
+  if (scm_array_handle_rank (h) != 1)
+    scm_wrong_type_arg_msg (NULL, 0, vec, "vector");
+}
+
 size_t
 scm_c_generalized_vector_length (SCM v)
 {