libguile/vectors.h

   1 /* classes: h_files */
   2
   3 #ifndef SCM_VECTORS_H
   4 #define SCM_VECTORS_H
   5
   6 /* Copyright (C) 1995,1996,1998,2000,2001,2002,2004,2005, 2006, 2008, 2009, 2011, 2014 Free Software Foundation, Inc.
   7  *
   8  * This library is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU Lesser General Public License
  10  * as published by the Free Software Foundation; either version 3 of
  11  * the License, or (at your option) any later version.
  12  *
  13  * This library is distributed in the hope that it will be useful, but
  14  * WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * Lesser General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Lesser General Public
  19  * License along with this library; if not, write to the Free Software
  20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  21  * 02110-1301 USA
  22  */
  23
  24 \f
  25
  26 #include "libguile/__scm.h"
  27
  28 \f
  29
  30 SCM_API SCM scm_vector_p (SCM x);
  31 SCM_API SCM scm_vector_length (SCM v);
  32 SCM_API SCM scm_vector (SCM l);
  33 SCM_API SCM scm_vector_ref (SCM v, SCM k);
  34 SCM_API SCM scm_vector_set_x (SCM v, SCM k, SCM obj);
  35 SCM_API SCM scm_make_vector (SCM k, SCM fill);
  36 SCM_API SCM scm_vector_to_list (SCM v);
  37 SCM_API SCM scm_vector_fill_x (SCM v, SCM fill_x);
  38 SCM_API SCM scm_vector_move_left_x (SCM vec1, SCM start1, SCM end1,
  39                                     SCM vec2, SCM start2);
  40 SCM_API SCM scm_vector_move_right_x (SCM vec1, SCM start1, SCM end1,
  41                                      SCM vec2, SCM start2);
  42 SCM_API SCM scm_vector_copy (SCM vec);
  43
  44 SCM_API int scm_is_vector (SCM obj);
  45 SCM_API int scm_is_simple_vector (SCM obj);
  46 SCM_API SCM scm_c_make_vector (size_t len, SCM fill);
  47 SCM_API size_t scm_c_vector_length (SCM vec);
  48 SCM_API SCM scm_c_vector_ref (SCM vec, size_t k);
  49 SCM_API void scm_c_vector_set_x (SCM vec, size_t k, SCM obj);
  50 SCM_API const SCM *scm_vector_elements (SCM vec,
  51                                         scm_t_array_handle *h,
  52                                         size_t *lenp, ssize_t *incp);
  53 SCM_API SCM *scm_vector_writable_elements (SCM vec,
  54                                            scm_t_array_handle *h,
  55                                            size_t *lenp, ssize_t *incp);
  56
  57 /* Fast, non-checking accessors for simple vectors.
  58  */
  59 #define SCM_SIMPLE_VECTOR_LENGTH(x)      SCM_I_VECTOR_LENGTH(x)
  60 #define SCM_SIMPLE_VECTOR_REF(x,idx)     ((SCM_I_VECTOR_ELTS(x))[idx])
  61 #define SCM_SIMPLE_VECTOR_SET(x,idx,val) ((SCM_I_VECTOR_WELTS(x))[idx]=(val))
  62
  63 \f
  64 /* Internals */
  65
  66 #define SCM_I_IS_VECTOR(x)     (SCM_HAS_TYP7 (x, scm_tc7_vector))
  67 #define SCM_I_VECTOR_ELTS(x)   ((const SCM *) SCM_I_VECTOR_WELTS (x))
  68 #define SCM_I_VECTOR_WELTS(x)  (SCM_CELL_OBJECT_LOC (x, 1))
  69 #define SCM_I_VECTOR_LENGTH(x) (((size_t) SCM_CELL_WORD_0 (x)) >> 8)
  70
  71 SCM_INTERNAL SCM  scm_i_vector_equal_p (SCM x, SCM y);
  72
  73
  74 SCM_INTERNAL void scm_init_vectors (void);
  75
  76 #endif  /* SCM_VECTORS_H */
  77
  78 /*
  79   Local Variables:
  80   c-file-style: "gnu"
  81   End:
  82 */