Commit | Line | Data |
---|---|---|
0f2d19dd JB |
1 | /* classes: h_files */ |
2 | ||
b29058ff DH |
3 | #ifndef SCM_UNIF_H |
4 | #define SCM_UNIF_H | |
5 | ||
21959222 | 6 | /* Copyright (C) 1995,1996,1997,1999,2000,2001, 2004 Free Software Foundation, Inc. |
b29058ff | 7 | * |
73be1d9e MV |
8 | * This library is free software; you can redistribute it and/or |
9 | * modify it under the terms of the GNU Lesser General Public | |
10 | * License as published by the Free Software Foundation; either | |
11 | * version 2.1 of the License, or (at your option) any later version. | |
b29058ff | 12 | * |
73be1d9e | 13 | * This library is distributed in the hope that it will be useful, |
0f2d19dd | 14 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
73be1d9e MV |
15 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
16 | * Lesser General Public License for more details. | |
b29058ff | 17 | * |
73be1d9e MV |
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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA | |
21 | */ | |
d3a6bc94 | 22 | |
0f2d19dd JB |
23 | \f |
24 | ||
b4309c3c | 25 | #include "libguile/__scm.h" |
0f2d19dd JB |
26 | |
27 | \f | |
1d7bdb25 | 28 | |
20930f28 MV |
29 | /* This file contains the definitions for arrays and bit vectors. |
30 | Uniform numeric vectors are now in srfi-4.c. | |
31 | */ | |
32 | ||
33 | ||
34 | /** Arrays */ | |
35 | ||
1d7bdb25 | 36 | /* |
2dbec7b5 | 37 | an array SCM is a non-immediate pointing to a heap cell where: |
1d7bdb25 | 38 | |
2dbec7b5 GH |
39 | CAR: bits 0-15 hold the smob type id: scm_tc16_array |
40 | bit 16 is the SCM_ARRAY_FLAG_CONTIGUOUS flag | |
41 | bits 17-31 hold the dimension (0 -- 32767) | |
42 | CDR: pointer to a malloced block containing an scm_t_array structure | |
92c2555f | 43 | followed by an scm_t_array_dim structure for each dimension. |
1d7bdb25 GH |
44 | */ |
45 | ||
92c2555f | 46 | typedef struct scm_t_array |
0f2d19dd | 47 | { |
1d7bdb25 | 48 | SCM v; /* the contents of the array, e.g., a vector or uniform vector. */ |
c014a02e | 49 | unsigned long base; |
92c2555f | 50 | } scm_t_array; |
0f2d19dd | 51 | |
92c2555f | 52 | typedef struct scm_t_array_dim |
0f2d19dd | 53 | { |
c014a02e ML |
54 | long lbnd; |
55 | long ubnd; | |
56 | long inc; | |
92c2555f | 57 | } scm_t_array_dim; |
1be6b49c | 58 | |
33b001fd | 59 | SCM_API scm_t_bits scm_tc16_array; |
02339e5b | 60 | SCM_API scm_t_bits scm_tc16_enclosed_array; |
e038c042 DH |
61 | |
62 | #define SCM_ARRAY_FLAG_CONTIGUOUS (1 << 16) | |
63 | ||
64 | #define SCM_ARRAYP(a) SCM_TYP16_PREDICATE (scm_tc16_array, a) | |
02339e5b | 65 | #define SCM_ENCLOSED_ARRAYP(a) SCM_TYP16_PREDICATE (scm_tc16_enclosed_array, a) |
2635d5ef | 66 | #define SCM_ARRAY_NDIM(x) ((size_t) (SCM_CELL_WORD_0 (x) >> 17)) |
e038c042 DH |
67 | #define SCM_ARRAY_CONTP(x) (SCM_CELL_WORD_0 (x) & SCM_ARRAY_FLAG_CONTIGUOUS) |
68 | #define SCM_SET_ARRAY_CONTIGUOUS_FLAG(x) \ | |
69 | (SCM_SET_CELL_WORD_0 ((x), SCM_CELL_WORD_0 (x) | SCM_ARRAY_FLAG_CONTIGUOUS)) | |
70 | #define SCM_CLR_ARRAY_CONTIGUOUS_FLAG(x) \ | |
71 | (SCM_SET_CELL_WORD_0 ((x), SCM_CELL_WORD_0 (x) & ~SCM_ARRAY_FLAG_CONTIGUOUS)) | |
0f2d19dd | 72 | |
92c2555f | 73 | #define SCM_ARRAY_MEM(a) ((scm_t_array *) SCM_CELL_WORD_1 (a)) |
405aaef9 DH |
74 | #define SCM_ARRAY_V(a) (SCM_ARRAY_MEM (a)->v) |
75 | #define SCM_ARRAY_BASE(a) (SCM_ARRAY_MEM (a)->base) | |
92c2555f | 76 | #define SCM_ARRAY_DIMS(a) ((scm_t_array_dim *)((char *) SCM_ARRAY_MEM (a) + sizeof (scm_t_array))) |
1be6b49c | 77 | |
33b001fd | 78 | SCM_API SCM scm_array_p (SCM v, SCM prot); |
f301dbf3 MV |
79 | SCM_API SCM scm_typed_array_p (SCM v, SCM type); |
80 | SCM_API SCM scm_make_array (SCM fill, SCM bounds); | |
81 | SCM_API SCM scm_make_typed_array (SCM type, SCM fill, SCM bounds); | |
33b001fd MV |
82 | SCM_API SCM scm_array_rank (SCM ra); |
83 | SCM_API SCM scm_array_dimensions (SCM ra); | |
84 | SCM_API SCM scm_shared_array_root (SCM ra); | |
85 | SCM_API SCM scm_shared_array_offset (SCM ra); | |
86 | SCM_API SCM scm_shared_array_increments (SCM ra); | |
33b001fd MV |
87 | SCM_API SCM scm_make_shared_array (SCM oldra, SCM mapfunc, SCM dims); |
88 | SCM_API SCM scm_transpose_array (SCM ra, SCM args); | |
89 | SCM_API SCM scm_enclose_array (SCM ra, SCM axes); | |
90 | SCM_API SCM scm_array_in_bounds_p (SCM v, SCM args); | |
e0e49670 | 91 | SCM_API SCM scm_array_ref (SCM v, SCM args); |
33b001fd MV |
92 | SCM_API SCM scm_array_set_x (SCM v, SCM obj, SCM args); |
93 | SCM_API SCM scm_array_contents (SCM ra, SCM strict); | |
02339e5b MV |
94 | SCM_API SCM scm_uniform_array_read_x (SCM ra, SCM port_or_fd, |
95 | SCM start, SCM end); | |
96 | SCM_API SCM scm_uniform_array_write (SCM v, SCM port_or_fd, | |
97 | SCM start, SCM end); | |
20930f28 | 98 | SCM_API SCM scm_array_to_list (SCM v); |
f301dbf3 MV |
99 | SCM_API SCM scm_list_to_array (SCM ndim, SCM lst); |
100 | SCM_API SCM scm_list_to_typed_array (SCM type, SCM ndim, SCM lst); | |
101 | SCM_API SCM scm_array_type (SCM ra); | |
102 | ||
103 | SCM_API int scm_is_array (SCM obj); | |
104 | SCM_API int scm_is_typed_array (SCM obj, SCM type); | |
20930f28 MV |
105 | |
106 | SCM_API SCM scm_i_read_array (SCM port, int c); | |
107 | ||
6e708ef2 MV |
108 | typedef struct { |
109 | SCM array; | |
110 | size_t base; | |
111 | scm_t_array_dim *dims; | |
112 | scm_t_array_dim dim0; | |
113 | } scm_t_array_handle; | |
114 | ||
115 | SCM_API void scm_array_get_handle (SCM array, scm_t_array_handle *h); | |
116 | SCM_API size_t scm_array_handle_rank (scm_t_array_handle *h); | |
117 | SCM_API scm_t_array_dim *scm_array_handle_dims (scm_t_array_handle *h); | |
cdd6e0a8 MV |
118 | SCM_API SCM scm_array_handle_ref (scm_t_array_handle *h, ssize_t pos); |
119 | SCM_API void scm_array_handle_set (scm_t_array_handle *h, ssize_t pos, SCM val); | |
6e708ef2 MV |
120 | SCM_API const SCM *scm_array_handle_elements (scm_t_array_handle *h); |
121 | SCM_API SCM *scm_array_handle_writable_elements (scm_t_array_handle *h); | |
cdd6e0a8 | 122 | SCM_API void scm_array_handle_release (scm_t_array_handle *h); |
6e708ef2 | 123 | |
20930f28 MV |
124 | \f |
125 | /** Bit vectors */ | |
126 | ||
127 | SCM_API SCM scm_bitvector_p (SCM vec); | |
128 | SCM_API SCM scm_bitvector (SCM bits); | |
129 | SCM_API SCM scm_make_bitvector (SCM len, SCM fill); | |
130 | SCM_API SCM scm_bitvector_length (SCM vec); | |
131 | SCM_API SCM scm_bitvector_ref (SCM vec, SCM idx); | |
132 | SCM_API SCM scm_bitvector_set_x (SCM vec, SCM idx, SCM val); | |
133 | SCM_API SCM scm_list_to_bitvector (SCM list); | |
134 | SCM_API SCM scm_bitvector_to_list (SCM vec); | |
135 | SCM_API SCM scm_bitvector_fill_x (SCM vec, SCM val); | |
136 | ||
33b001fd MV |
137 | SCM_API SCM scm_bit_count (SCM item, SCM seq); |
138 | SCM_API SCM scm_bit_position (SCM item, SCM v, SCM k); | |
139 | SCM_API SCM scm_bit_set_star_x (SCM v, SCM kv, SCM obj); | |
140 | SCM_API SCM scm_bit_count_star (SCM v, SCM kv, SCM obj); | |
141 | SCM_API SCM scm_bit_invert_x (SCM v); | |
21959222 | 142 | |
20930f28 MV |
143 | SCM_API int scm_is_bitvector (SCM obj); |
144 | SCM_API SCM scm_c_make_bitvector (size_t len, SCM fill); | |
145 | SCM_API size_t scm_c_bitvector_length (SCM vec); | |
146 | SCM_API SCM scm_c_bitvector_ref (SCM vec, size_t idx); | |
147 | SCM_API void scm_c_bitvector_set_x (SCM vec, size_t idx, SCM val); | |
f0b91039 MV |
148 | SCM_API const scm_t_uint32 *scm_array_handle_bit_elements (scm_t_array_handle *h); |
149 | SCM_API scm_t_uint32 *scm_array_handle_bit_writable_elements (scm_t_array_handle *h); | |
150 | SCM_API size_t scm_array_handle_bit_elements_offset (scm_t_array_handle *h); | |
151 | SCM_API const scm_t_uint32 *scm_bitvector_elements (SCM vec, | |
152 | scm_t_array_handle *h, | |
cdd6e0a8 | 153 | size_t *offp, |
f0b91039 MV |
154 | size_t *lenp, |
155 | ssize_t *incp); | |
156 | SCM_API scm_t_uint32 *scm_bitvector_writable_elements (SCM vec, | |
157 | scm_t_array_handle *h, | |
cdd6e0a8 | 158 | size_t *offp, |
f0b91039 MV |
159 | size_t *lenp, |
160 | ssize_t *incp); | |
bfad4005 | 161 | |
21959222 MV |
162 | /* deprecated. */ |
163 | ||
6e708ef2 MV |
164 | #if SCM_ENABLE_DEPRECATED |
165 | ||
21959222 | 166 | SCM_API SCM scm_make_uve (long k, SCM prot); |
6e708ef2 MV |
167 | SCM_API SCM scm_array_prototype (SCM ra); |
168 | SCM_API SCM scm_list_to_uniform_array (SCM ndim, SCM prot, SCM lst); | |
169 | SCM_API SCM scm_dimensions_to_uniform_array (SCM dims, SCM prot, SCM fill); | |
170 | ||
171 | #endif | |
172 | ||
21959222 MV |
173 | SCM_API SCM scm_make_ra (int ndim); |
174 | SCM_API void scm_ra_set_contp (SCM ra); | |
175 | SCM_API SCM scm_cvref (SCM v, unsigned long pos, SCM last); | |
176 | SCM_API SCM scm_istr2bve (SCM str); | |
177 | SCM_API int scm_raprin1 (SCM exp, SCM port, scm_print_state *pstate); | |
02339e5b MV |
178 | SCM_API long scm_aind (SCM ra, SCM args, const char *what); |
179 | SCM_API SCM scm_shap2ra (SCM args, const char *what); | |
02339e5b | 180 | SCM_API SCM scm_ra2contig (SCM ra, int copy); |
21959222 | 181 | |
2d4d7f27 | 182 | SCM_API SCM scm_i_cvref (SCM v, size_t p, int enclosed); |
20930f28 | 183 | |
33b001fd | 184 | SCM_API void scm_init_unif (void); |
0f2d19dd | 185 | |
b29058ff | 186 | #endif /* SCM_UNIF_H */ |
89e00824 ML |
187 | |
188 | /* | |
189 | Local Variables: | |
190 | c-file-style: "gnu" | |
191 | End: | |
192 | */ |