libguile/generalized-arrays.h

   1 /* classes: h_files */
   2
   3 #ifndef SCM_GENERALIZED_ARRAYS_H
   4 #define SCM_GENERALIZED_ARRAYS_H
   5
   6 /* Copyright (C) 1995,1996,1997,1999,2000,2001, 2004, 2006, 2008, 2009, 2013, 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 #include "libguile/array-handle.h"
  28
  29 \f
  30
  31 /* These functions operate on all kinds of arrays that Guile knows about.
  32  */
  33
  34
  35 /** Arrays */
  36
  37 SCM_API int scm_is_array (SCM obj);
  38 SCM_API SCM scm_array_p (SCM v, SCM unused);
  39 SCM_INTERNAL SCM scm_array_p_2 (SCM);
  40
  41 SCM_API int scm_is_typed_array (SCM obj, SCM type);
  42 SCM_API SCM scm_typed_array_p (SCM v, SCM type);
  43
  44 SCM_API size_t scm_c_array_rank (SCM ra);
  45 SCM_API SCM scm_array_rank (SCM ra);
  46
  47 SCM_API size_t scm_c_array_length (SCM ra);
  48 SCM_API SCM scm_array_length (SCM ra);
  49
  50 SCM_API SCM scm_array_dimensions (SCM ra);
  51 SCM_API SCM scm_array_type (SCM ra);
  52 SCM_API SCM scm_array_type_code (SCM ra);
  53 SCM_API SCM scm_array_in_bounds_p (SCM v, SCM args);
  54
  55 SCM_API SCM scm_c_array_ref_1 (SCM v, ssize_t idx0);
  56 SCM_API SCM scm_c_array_ref_2 (SCM v, ssize_t idx0, ssize_t idx1);
  57
  58 SCM_API void scm_c_array_set_1_x (SCM v, SCM obj, ssize_t idx0);
  59 SCM_API void scm_c_array_set_2_x (SCM v, SCM obj, ssize_t idx0, ssize_t idx1);
  60
  61 SCM_API SCM scm_array_ref (SCM v, SCM args);
  62 SCM_API SCM scm_array_set_x (SCM v, SCM obj, SCM args);
  63 SCM_API SCM scm_array_to_list (SCM v);
  64
  65 SCM_INTERNAL void scm_init_generalized_arrays (void);
  66
  67
  68 #endif  /* SCM_GENERALIZED_ARRAYS_H */
  69
  70 /*
  71   Local Variables:
  72   c-file-style: "gnu"
  73   End:
  74 */