SCM

SCM Repository

[matrix] Annotation of /pkg/Matrix/src/Mutils.h
ViewVC logotype

Annotation of /pkg/Matrix/src/Mutils.h

Parent Directory Parent Directory | Revision Log Revision Log


Revision 2843 - (view) (download) (as text)

1 : bates 10 #ifndef MATRIX_MUTILS_H
2 :     #define MATRIX_MUTILS_H
3 :    
4 : mmaechler 2583 #undef Matrix_with_SPQR
5 : mmaechler 2336
6 : bates 582 #ifdef __cplusplus
7 :     extern "C" {
8 :     #endif
9 : maechler 890
10 : mmaechler 2685 #include <stdint.h> // C99 for int64_t
11 : bates 2049 #include <ctype.h>
12 :     #include <R.h> /* includes Rconfig.h */
13 : maechler 2121 #include <Rversion.h>
14 : maechler 1394 #include <Rdefines.h> /* Rinternals.h + GET_SLOT etc */
15 : maechler 890
16 : bates 582 #ifdef ENABLE_NLS
17 :     #include <libintl.h>
18 :     #define _(String) dgettext ("Matrix", String)
19 :     #else
20 :     #define _(String) (String)
21 : mmaechler 2392 /* Note that this is not yet supported (for Windows, e.g.) in R 2.9.0 : */
22 :     #define dngettext(pkg, String, StringP, N) (N > 1 ? StringP : String)
23 : bates 582 #endif
24 : maechler 890
25 : bates 2045 #ifdef __GNUC__
26 :     # undef alloca
27 :     # define alloca(x) __builtin_alloca((x))
28 : mmaechler 2298 #elif defined(__sun) || defined(_AIX)
29 :     /* this is necessary (and sufficient) for Solaris 10 and AIX 6: */
30 : maechler 2061 # include <alloca.h>
31 : bates 2045 #endif
32 :    
33 : mmaechler 2843 #ifndef LONG_VECTOR_SUPPORT
34 :     // notably for R <= 2.15.x :
35 :     # define XLENGTH(x) LENGTH(x)
36 :     typedef int R_xlen_t;
37 :     #endif
38 :    
39 : maechler 1960 #define Alloca(n, t) (t *) alloca( (size_t) ( (n) * sizeof(t) ) )
40 :    
41 : maechler 890 SEXP triangularMatrix_validate(SEXP obj);
42 :     SEXP symmetricMatrix_validate(SEXP obj);
43 : maechler 1164 SEXP dense_nonpacked_validate(SEXP obj);
44 : maechler 890
45 : bates 582 /* enum constants from cblas.h and some short forms */
46 :     enum CBLAS_ORDER {CblasRowMajor=101, CblasColMajor=102};
47 :     enum CBLAS_TRANSPOSE {CblasNoTrans=111, CblasTrans=112, CblasConjTrans=113};
48 :     enum CBLAS_UPLO {CblasUpper=121, CblasLower=122};
49 :     enum CBLAS_DIAG {CblasNonUnit=131, CblasUnit=132};
50 :     enum CBLAS_SIDE {CblasLeft=141, CblasRight=142};
51 : bates 447 #define RMJ CblasRowMajor
52 :     #define CMJ CblasColMajor
53 :     #define NTR CblasNoTrans
54 :     #define TRN CblasTrans
55 :     #define CTR CblasConjTrans
56 :     #define UPP CblasUpper
57 :     #define LOW CblasLower
58 :     #define NUN CblasNonUnit
59 :     #define UNT CblasUnit
60 :     #define LFT CblasLeft
61 :     #define RGT CblasRight
62 :    
63 : bates 10 double get_double_by_name(SEXP obj, char *nm);
64 :     SEXP set_double_by_name(SEXP obj, double val, char *nm);
65 :     SEXP as_det_obj(double val, int log, int sign);
66 : bates 476 SEXP get_factors(SEXP obj, char *nm);
67 :     SEXP set_factors(SEXP obj, SEXP val, char *nm);
68 : maechler 2115
69 :     #if 0
70 : bates 478 SEXP dgCMatrix_set_Dim(SEXP x, int nrow);
71 : maechler 2115 #endif /* unused */
72 : maechler 943
73 : bates 1555 /* int csc_unsorted_columns(int ncol, const int p[], const int i[]); */
74 :     /* void csc_sort_columns(int ncol, const int p[], int i[], double x[]); */
75 :     /* SEXP csc_check_column_sorting(SEXP A); */
76 : mmaechler 2449
77 : bates 592 SEXP check_scalar_string(SEXP sP, char *vals, char *nm);
78 : maechler 2113 Rboolean equal_string_vectors(SEXP s1, SEXP s2);
79 :    
80 : maechler 1747 void d_packed_getDiag(double *dest, SEXP x, int n);
81 :     void l_packed_getDiag( int *dest, SEXP x, int n);
82 : mmaechler 2811 SEXP d_packed_setDiag(double *diag, int l_d, SEXP x, int n);
83 :     SEXP l_packed_setDiag( int *diag, int l_d, SEXP x, int n);
84 :     SEXP d_packed_addDiag(double *diag, int l_d, SEXP x, int n);
85 : maechler 1747
86 : mmaechler 2811 void tr_d_packed_getDiag(double *dest, SEXP x, int n);
87 :     void tr_l_packed_getDiag( int *dest, SEXP x, int n);
88 :    
89 :     SEXP tr_d_packed_setDiag(double *diag, int l_d, SEXP x, int n);
90 :     SEXP tr_l_packed_setDiag( int *diag, int l_d, SEXP x, int n);
91 :     SEXP tr_d_packed_addDiag(double *diag, int l_d, SEXP x, int n);
92 :    
93 : bates 862 SEXP Matrix_getElement(SEXP list, char *nm);
94 : bates 592
95 : maechler 952 #define PACKED_TO_FULL(TYPE) \
96 :     TYPE *packed_to_full_ ## TYPE(TYPE *dest, const TYPE *src, \
97 :     int n, enum CBLAS_UPLO uplo)
98 :     PACKED_TO_FULL(double);
99 :     PACKED_TO_FULL(int);
100 :     #undef PACKED_TO_FULL
101 : bates 738
102 : maechler 952 #define FULL_TO_PACKED(TYPE) \
103 :     TYPE *full_to_packed_ ## TYPE(TYPE *dest, const TYPE *src, int n, \
104 :     enum CBLAS_UPLO uplo, enum CBLAS_DIAG diag)
105 :     FULL_TO_PACKED(double);
106 :     FULL_TO_PACKED(int);
107 :     #undef FULL_TO_PACKED
108 :    
109 :    
110 : bates 592 extern /* stored pointers to symbols initialized in R_init_Matrix */
111 : bates 329 #include "Syms.h"
112 : bates 10
113 : bates 432 /* zero an array */
114 : bates 441 #define AZERO(x, n) {int _I_, _SZ_ = (n); for(_I_ = 0; _I_ < _SZ_; _I_++) (x)[_I_] = 0;}
115 : bates 432
116 : bates 597 /* number of elements in one triangle of a square matrix of order n */
117 :     #define PACKED_LENGTH(n) ((n) * ((n) + 1))/2
118 :    
119 : bates 738 /* duplicate the slot with name given by sym from src to dest */
120 : maechler 2120
121 : bates 738 #define slot_dup(dest, src, sym) SET_SLOT(dest, sym, duplicate(GET_SLOT(src, sym)))
122 :    
123 : maechler 2120 /* is not yet used: */
124 : maechler 1736 #define slot_nonNull_dup(dest, src, sym) \
125 :     if(GET_SLOT(src, sym) != R_NilValue) \
126 :     SET_SLOT(dest, sym, duplicate(GET_SLOT(src, sym)))
127 :    
128 : mmaechler 2628 #define slot_dup_if_has(dest, src, sym) \
129 :     if(R_has_slot(src, sym)) \
130 :     SET_SLOT(dest, sym, duplicate(GET_SLOT(src, sym)))
131 :    
132 : maechler 1736 /* TODO: Make this faster for the case where dimnames = list(NULL,NULL)
133 :     * and hence don't have to be set ! */
134 :     #define SET_DimNames(dest, src) slot_dup(dest, src, Matrix_DimNamesSym)
135 :    
136 :    
137 : maechler 951 #define uplo_P(_x_) CHAR(STRING_ELT(GET_SLOT(_x_, Matrix_uploSym), 0))
138 :     #define diag_P(_x_) CHAR(STRING_ELT(GET_SLOT(_x_, Matrix_diagSym), 0))
139 : mmaechler 2811 #define Diag_P(_x_) (R_has_slot(x, Matrix_diagSym) ? \
140 :     CHAR(STRING_ELT(GET_SLOT(_x_, Matrix_diagSym), 0)) : " ")
141 : bates 1461 #define class_P(_x_) CHAR(asChar(getAttrib(_x_, R_ClassSymbol)))
142 : maechler 951
143 : mmaechler 2811
144 : mmaechler 2628 // Define this "Cholmod compatible" to some degree
145 :     enum x_slot_kind {x_pattern=-1, x_double=0, x_logical=1, x_integer=2, x_complex=3};
146 : mmaechler 2684 // n d l i z
147 : mmaechler 2628
148 : maechler 1725 /* should also work for "matrix" matrices: */
149 :     #define Real_KIND(_x_) (IS_S4_OBJECT(_x_) ? Real_kind(_x_) : \
150 : mmaechler 2628 (isReal(_x_) ? x_double : (isLogical(_x_) ? x_logical : -1)))
151 : maechler 2115 /* This one gives '0' also for integer "matrix" :*/
152 :     #define Real_KIND2(_x_) (IS_S4_OBJECT(_x_) ? Real_kind(_x_) : \
153 : mmaechler 2628 (isLogical(_x_) ? x_logical : 0))
154 : maechler 1725
155 :     /* requires 'x' slot: */
156 : maechler 1548 #define Real_kind(_x_) (isReal(GET_SLOT(_x_, Matrix_xSym)) ? 0 : \
157 : maechler 1725 (isLogical(GET_SLOT(_x_, Matrix_xSym)) ? 1 : -1))
158 : maechler 1548
159 : maechler 2115 #define DECLARE_AND_GET_X_SLOT(__C_TYPE, __SEXP) \
160 :     __C_TYPE *xx = __SEXP(GET_SLOT(x, Matrix_xSym))
161 : maechler 1548
162 : maechler 2115
163 : maechler 890 /**
164 : bates 597 * Check for valid length of a packed triangular array and return the
165 :     * corresponding number of columns
166 : maechler 890 *
167 : bates 597 * @param len length of a packed triangular array
168 : maechler 890 *
169 : bates 597 * @return number of columns
170 :     */
171 :     static R_INLINE
172 : maechler 890 int packed_ncol(int len)
173 : bates 597 {
174 :     int disc = 8 * len + 1; /* discriminant */
175 :     int sqrtd = (int) sqrt((double) disc);
176 :    
177 :     if (len < 0 || disc != sqrtd * sqrtd)
178 :     error(_("invalid 'len' = %d in packed_ncol"));
179 :     return (sqrtd - 1)/2;
180 :     }
181 :    
182 : maechler 890 /**
183 : bates 536 * Allocate an SEXP of given type and length, assign it as slot nm in
184 :     * the object, and return the SEXP. The validity of this function
185 :     * depends on SET_SLOT not duplicating val when NAMED(val) == 0. If
186 :     * this behavior changes then ALLOC_SLOT must use SET_SLOT followed by
187 :     * GET_SLOT to ensure that the value returned is indeed the SEXP in
188 :     * the slot.
189 : maechler 1747 * NOTE: GET_SLOT(x, what) :== R_do_slot (x, what)
190 :     * ---- SET_SLOT(x, what, value) :== R_do_slot_assign(x, what, value)
191 :     * and the R_do_slot* are in src/main/attrib.c
192 : maechler 890 *
193 : bates 536 * @param obj object in which to assign the slot
194 :     * @param nm name of the slot, as an R name object
195 :     * @param type type of SEXP to allocate
196 :     * @param length length of SEXP to allocate
197 : maechler 890 *
198 : bates 536 * @return SEXP of given type and length assigned as slot nm in obj
199 :     */
200 :     static R_INLINE
201 :     SEXP ALLOC_SLOT(SEXP obj, SEXP nm, SEXPTYPE type, int length)
202 :     {
203 :     SEXP val = allocVector(type, length);
204 : bates 441
205 : bates 536 SET_SLOT(obj, nm, val);
206 :     return val;
207 :     }
208 :    
209 : maechler 890 /**
210 : bates 679 * Expand compressed pointers in the array mp into a full set of indices
211 : bates 536 * in the array mj.
212 : maechler 890 *
213 : bates 679 * @param ncol number of columns (or rows)
214 : bates 536 * @param mp column pointer vector of length ncol + 1
215 : bates 679 * @param mj vector of length mp[ncol] to hold the result
216 : maechler 890 *
217 : bates 536 * @return mj
218 :     */
219 :     static R_INLINE
220 : bates 679 int* expand_cmprPt(int ncol, const int mp[], int mj[])
221 : bates 536 {
222 :     int j;
223 :     for (j = 0; j < ncol; j++) {
224 :     int j2 = mp[j+1], jj;
225 :     for (jj = mp[j]; jj < j2; jj++) mj[jj] = j;
226 :     }
227 :     return mj;
228 :     }
229 :    
230 : mmaechler 2175 /**
231 : dmbates 2260 * Check if slot(obj, "x") contains any NA (or NaN).
232 : mmaechler 2175 *
233 : mmaechler 2677 * @param obj a 'Matrix' object with a (double precision) 'x' slot.
234 : mmaechler 2175 *
235 : dmbates 2260 * @return Rboolean :== any(is.na(slot(obj, "x") )
236 : mmaechler 2175 */
237 :     static R_INLINE
238 : mmaechler 2453 Rboolean any_NA_in_x(SEXP obj)
239 : mmaechler 2175 {
240 :     double *x = REAL(GET_SLOT(obj, Matrix_xSym));
241 :     int i, n = LENGTH(GET_SLOT(obj, Matrix_xSym));
242 :     for(i=0; i < n; i++)
243 :     if(ISNAN(x[i])) return TRUE;
244 :     /* else */
245 :     return FALSE;
246 :     }
247 :    
248 : mmaechler 2843 SEXP Mmatrix(SEXP args);
249 : mmaechler 2175
250 : maechler 1200 void make_d_matrix_triangular(double *x, SEXP from);
251 :     void make_i_matrix_triangular( int *x, SEXP from);
252 : bates 582
253 : maechler 1200 void make_d_matrix_symmetric(double *to, SEXP from);
254 :     void make_i_matrix_symmetric( int *to, SEXP from);
255 :    
256 : bates 738 SEXP Matrix_expand_pointers(SEXP pP);
257 :    
258 : maechler 1432 SEXP dup_mMatrix_as_dgeMatrix(SEXP A);
259 : maechler 1725 SEXP dup_mMatrix_as_geMatrix (SEXP A);
260 : bates 1395
261 : maechler 1654 SEXP new_dgeMatrix(int nrow, int ncol);
262 : mmaechler 2525 SEXP m_encodeInd (SEXP ij, SEXP di, SEXP chk_bnds);
263 :     SEXP m_encodeInd2(SEXP i, SEXP j, SEXP di, SEXP chk_bnds);
264 : maechler 1654
265 : mmaechler 2203
266 : bates 1461 static R_INLINE SEXP
267 :     mMatrix_as_dgeMatrix(SEXP A)
268 :     {
269 : bates 1463 return strcmp(class_P(A), "dgeMatrix") ? dup_mMatrix_as_dgeMatrix(A) : A;
270 : bates 1461 }
271 : bates 1416
272 : maechler 1725 static R_INLINE SEXP
273 :     mMatrix_as_geMatrix(SEXP A)
274 :     {
275 :     return strcmp(class_P(A) + 1, "geMatrix") ? dup_mMatrix_as_geMatrix(A) : A;
276 :     }
277 :    
278 : mmaechler 2713 // Keep centralized --- *and* in sync with ../inst/include/Matrix.h :
279 :     #define MATRIX_VALID_dense \
280 :     "dmatrix", "dgeMatrix", \
281 :     "lmatrix", "lgeMatrix", \
282 :     "nmatrix", "ngeMatrix", \
283 :     "zmatrix", "zgeMatrix"
284 :    
285 :     #define MATRIX_VALID_Csparse \
286 :     "dgCMatrix", "dsCMatrix", "dtCMatrix", \
287 :     "lgCMatrix", "lsCMatrix", "ltCMatrix", \
288 :     "ngCMatrix", "nsCMatrix", "ntCMatrix", \
289 :     "zgCMatrix", "zsCMatrix", "ztCMatrix"
290 :    
291 :     #define MATRIX_VALID_Tsparse \
292 :     "dgTMatrix", "dsTMatrix", "dtTMatrix", \
293 :     "lgTMatrix", "lsTMatrix", "ltTMatrix", \
294 :     "ngTMatrix", "nsTMatrix", "ntTMatrix", \
295 :     "zgTMatrix", "zsTMatrix", "ztTMatrix"
296 :    
297 :     #define MATRIX_VALID_Rsparse \
298 :     "dgRMatrix", "dsRMatrix", "dtRMatrix", \
299 :     "lgRMatrix", "lsRMatrix", "ltRMatrix", \
300 :     "ngRMatrix", "nsRMatrix", "ntRMatrix", \
301 :     "zgRMatrix", "zsRMatrix", "ztRMatrix"
302 :    
303 :     #define MATRIX_VALID_CHMfactor "dCHMsuper", "dCHMsimpl", "nCHMsuper", "nCHMsimpl"
304 :    
305 : bates 1416 /**
306 :     * Return the 0-based index of a string match in a vector of strings
307 :     * terminated by an empty string. Returns -1 for no match.
308 :     *
309 : bates 2104 * @param class string to match
310 : bates 1416 * @param valid vector of possible matches terminated by an empty string
311 :     *
312 :     * @return index of match or -1 for no match
313 :     */
314 :     static R_INLINE int
315 : mmaechler 2647 Matrix_check_class(char *class, const char **valid)
316 : bates 1416 {
317 :     int ans;
318 :     for (ans = 0; ; ans++) {
319 :     if (!strlen(valid[ans])) return -1;
320 :     if (!strcmp(class, valid[ans])) return ans;
321 :     }
322 :     }
323 :    
324 : mmaechler 2645 /**
325 : mmaechler 2744 * These are the ones "everyone" should use -- is() versions, also looking
326 : mmaechler 2645 * at super classes:
327 :     */
328 : mmaechler 2744 # define Matrix_check_class_etc R_check_class_etc
329 : mmaechler 2645 # define Matrix_check_class_and_super R_check_class_and_super
330 : mmaechler 2203
331 : mmaechler 2677 /** Accessing *sparseVectors : fast (and recycling) v[i] for v = ?sparseVector:
332 :     * -> ./sparseVector.c -> ./t_sparseVector.c :
333 :     */
334 :     // Type_ans sparseVector_sub(int64_t i, int nnz_v, int* v_i, Type_ans* v_x, int len_v):
335 :    
336 :     /* Define all of
337 :     * dsparseVector_sub(....)
338 :     * isparseVector_sub(....)
339 :     * lsparseVector_sub(....)
340 :     * nsparseVector_sub(....)
341 :     * zsparseVector_sub(....)
342 :     */
343 :     #define _dspV_
344 :     #include "t_sparseVector.c"
345 :    
346 :     #define _ispV_
347 :     #include "t_sparseVector.c"
348 :    
349 :     #define _lspV_
350 :     #include "t_sparseVector.c"
351 :    
352 :     #define _nspV_
353 :     #include "t_sparseVector.c"
354 :    
355 :     #define _zspV_
356 :     #include "t_sparseVector.c"
357 :    
358 :    
359 : bates 582 #ifdef __cplusplus
360 :     }
361 : bates 572 #endif
362 : bates 582
363 :     #endif /* MATRIX_MUTILS_H_ */

root@r-forge.r-project.org
ViewVC Help
Powered by ViewVC 1.0.0  
Thanks to:
Vienna University of Economics and Business Powered By FusionForge