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 2628 - (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 : bates 2049 #include <ctype.h>
11 :     #include <R.h> /* includes Rconfig.h */
12 : maechler 2121 #include <Rversion.h>
13 : maechler 1394 #include <Rdefines.h> /* Rinternals.h + GET_SLOT etc */
14 : maechler 890
15 : bates 582 #ifdef ENABLE_NLS
16 :     #include <libintl.h>
17 :     #define _(String) dgettext ("Matrix", String)
18 :     #else
19 :     #define _(String) (String)
20 : mmaechler 2392 /* Note that this is not yet supported (for Windows, e.g.) in R 2.9.0 : */
21 :     #define dngettext(pkg, String, StringP, N) (N > 1 ? StringP : String)
22 : bates 582 #endif
23 : maechler 890
24 : bates 2045 #ifdef __GNUC__
25 :     # undef alloca
26 :     # define alloca(x) __builtin_alloca((x))
27 : mmaechler 2298 #elif defined(__sun) || defined(_AIX)
28 :     /* this is necessary (and sufficient) for Solaris 10 and AIX 6: */
29 : maechler 2061 # include <alloca.h>
30 : bates 2045 #endif
31 :    
32 : maechler 1960 #define Alloca(n, t) (t *) alloca( (size_t) ( (n) * sizeof(t) ) )
33 :    
34 : maechler 890 SEXP triangularMatrix_validate(SEXP obj);
35 :     SEXP symmetricMatrix_validate(SEXP obj);
36 : maechler 1164 SEXP dense_nonpacked_validate(SEXP obj);
37 : maechler 890
38 : bates 582 /* enum constants from cblas.h and some short forms */
39 :     enum CBLAS_ORDER {CblasRowMajor=101, CblasColMajor=102};
40 :     enum CBLAS_TRANSPOSE {CblasNoTrans=111, CblasTrans=112, CblasConjTrans=113};
41 :     enum CBLAS_UPLO {CblasUpper=121, CblasLower=122};
42 :     enum CBLAS_DIAG {CblasNonUnit=131, CblasUnit=132};
43 :     enum CBLAS_SIDE {CblasLeft=141, CblasRight=142};
44 : bates 447 #define RMJ CblasRowMajor
45 :     #define CMJ CblasColMajor
46 :     #define NTR CblasNoTrans
47 :     #define TRN CblasTrans
48 :     #define CTR CblasConjTrans
49 :     #define UPP CblasUpper
50 :     #define LOW CblasLower
51 :     #define NUN CblasNonUnit
52 :     #define UNT CblasUnit
53 :     #define LFT CblasLeft
54 :     #define RGT CblasRight
55 :    
56 : maechler 2120 #if !defined(R_VERSION) || R_VERSION < R_Version(2, 7, 0)
57 : maechler 2117 char La_norm_type(const char *typstr);
58 : maechler 2120 char La_rcond_type(const char *typstr);
59 :     #endif
60 :    
61 : bates 10 double get_double_by_name(SEXP obj, char *nm);
62 :     SEXP set_double_by_name(SEXP obj, double val, char *nm);
63 :     SEXP as_det_obj(double val, int log, int sign);
64 : bates 476 SEXP get_factors(SEXP obj, char *nm);
65 :     SEXP set_factors(SEXP obj, SEXP val, char *nm);
66 : maechler 2115
67 :     #if 0
68 : bates 478 SEXP dgCMatrix_set_Dim(SEXP x, int nrow);
69 : maechler 2115 #endif /* unused */
70 : maechler 943
71 : bates 1555 /* int csc_unsorted_columns(int ncol, const int p[], const int i[]); */
72 :     /* void csc_sort_columns(int ncol, const int p[], int i[], double x[]); */
73 :     /* SEXP csc_check_column_sorting(SEXP A); */
74 : mmaechler 2449 #if R_VERSION < R_Version(2, 10, 0)
75 : mmaechler 2348 SEXP Matrix_make_named(int TYP, const char **names);
76 : mmaechler 2449 #else
77 :     # define Matrix_make_named Rf_mkNamed
78 :     #endif
79 :    
80 : bates 592 SEXP check_scalar_string(SEXP sP, char *vals, char *nm);
81 : maechler 2113 Rboolean equal_string_vectors(SEXP s1, SEXP s2);
82 :    
83 : maechler 1747 void d_packed_getDiag(double *dest, SEXP x, int n);
84 :     void l_packed_getDiag( int *dest, SEXP x, int n);
85 :     void tr_d_packed_getDiag(double *dest, SEXP x);
86 :     void tr_l_packed_getDiag( int *dest, SEXP x);
87 :    
88 : bates 862 SEXP Matrix_getElement(SEXP list, char *nm);
89 : bates 592
90 : maechler 952 #define PACKED_TO_FULL(TYPE) \
91 :     TYPE *packed_to_full_ ## TYPE(TYPE *dest, const TYPE *src, \
92 :     int n, enum CBLAS_UPLO uplo)
93 :     PACKED_TO_FULL(double);
94 :     PACKED_TO_FULL(int);
95 :     #undef PACKED_TO_FULL
96 : bates 738
97 : maechler 952 #define FULL_TO_PACKED(TYPE) \
98 :     TYPE *full_to_packed_ ## TYPE(TYPE *dest, const TYPE *src, int n, \
99 :     enum CBLAS_UPLO uplo, enum CBLAS_DIAG diag)
100 :     FULL_TO_PACKED(double);
101 :     FULL_TO_PACKED(int);
102 :     #undef FULL_TO_PACKED
103 :    
104 :    
105 : bates 592 extern /* stored pointers to symbols initialized in R_init_Matrix */
106 : bates 329 #include "Syms.h"
107 : bates 10
108 : bates 432 /* zero an array */
109 : bates 441 #define AZERO(x, n) {int _I_, _SZ_ = (n); for(_I_ = 0; _I_ < _SZ_; _I_++) (x)[_I_] = 0;}
110 : bates 432
111 : bates 597 /* number of elements in one triangle of a square matrix of order n */
112 :     #define PACKED_LENGTH(n) ((n) * ((n) + 1))/2
113 :    
114 : bates 738 /* duplicate the slot with name given by sym from src to dest */
115 : maechler 2120
116 : bates 738 #define slot_dup(dest, src, sym) SET_SLOT(dest, sym, duplicate(GET_SLOT(src, sym)))
117 :    
118 : maechler 2120 /* is not yet used: */
119 : maechler 1736 #define slot_nonNull_dup(dest, src, sym) \
120 :     if(GET_SLOT(src, sym) != R_NilValue) \
121 :     SET_SLOT(dest, sym, duplicate(GET_SLOT(src, sym)))
122 :    
123 : mmaechler 2628 #define slot_dup_if_has(dest, src, sym) \
124 :     if(R_has_slot(src, sym)) \
125 :     SET_SLOT(dest, sym, duplicate(GET_SLOT(src, sym)))
126 :    
127 : maechler 1736 /* TODO: Make this faster for the case where dimnames = list(NULL,NULL)
128 :     * and hence don't have to be set ! */
129 :     #define SET_DimNames(dest, src) slot_dup(dest, src, Matrix_DimNamesSym)
130 :    
131 :    
132 : maechler 951 #define uplo_P(_x_) CHAR(STRING_ELT(GET_SLOT(_x_, Matrix_uploSym), 0))
133 :     #define diag_P(_x_) CHAR(STRING_ELT(GET_SLOT(_x_, Matrix_diagSym), 0))
134 : bates 1461 #define class_P(_x_) CHAR(asChar(getAttrib(_x_, R_ClassSymbol)))
135 : maechler 951
136 : mmaechler 2628 // Define this "Cholmod compatible" to some degree
137 :     enum x_slot_kind {x_pattern=-1, x_double=0, x_logical=1, x_integer=2, x_complex=3};
138 :    
139 : maechler 1725 /* should also work for "matrix" matrices: */
140 :     #define Real_KIND(_x_) (IS_S4_OBJECT(_x_) ? Real_kind(_x_) : \
141 : mmaechler 2628 (isReal(_x_) ? x_double : (isLogical(_x_) ? x_logical : -1)))
142 : maechler 2115 /* This one gives '0' also for integer "matrix" :*/
143 :     #define Real_KIND2(_x_) (IS_S4_OBJECT(_x_) ? Real_kind(_x_) : \
144 : mmaechler 2628 (isLogical(_x_) ? x_logical : 0))
145 : maechler 1725
146 :     /* requires 'x' slot: */
147 : maechler 1548 #define Real_kind(_x_) (isReal(GET_SLOT(_x_, Matrix_xSym)) ? 0 : \
148 : maechler 1725 (isLogical(GET_SLOT(_x_, Matrix_xSym)) ? 1 : -1))
149 : maechler 1548
150 : maechler 2115 #define DECLARE_AND_GET_X_SLOT(__C_TYPE, __SEXP) \
151 :     __C_TYPE *xx = __SEXP(GET_SLOT(x, Matrix_xSym))
152 : maechler 1548
153 : maechler 2115
154 : maechler 890 /**
155 : bates 597 * Check for valid length of a packed triangular array and return the
156 :     * corresponding number of columns
157 : maechler 890 *
158 : bates 597 * @param len length of a packed triangular array
159 : maechler 890 *
160 : bates 597 * @return number of columns
161 :     */
162 :     static R_INLINE
163 : maechler 890 int packed_ncol(int len)
164 : bates 597 {
165 :     int disc = 8 * len + 1; /* discriminant */
166 :     int sqrtd = (int) sqrt((double) disc);
167 :    
168 :     if (len < 0 || disc != sqrtd * sqrtd)
169 :     error(_("invalid 'len' = %d in packed_ncol"));
170 :     return (sqrtd - 1)/2;
171 :     }
172 :    
173 : maechler 890 /**
174 : bates 536 * Allocate an SEXP of given type and length, assign it as slot nm in
175 :     * the object, and return the SEXP. The validity of this function
176 :     * depends on SET_SLOT not duplicating val when NAMED(val) == 0. If
177 :     * this behavior changes then ALLOC_SLOT must use SET_SLOT followed by
178 :     * GET_SLOT to ensure that the value returned is indeed the SEXP in
179 :     * the slot.
180 : maechler 1747 * NOTE: GET_SLOT(x, what) :== R_do_slot (x, what)
181 :     * ---- SET_SLOT(x, what, value) :== R_do_slot_assign(x, what, value)
182 :     * and the R_do_slot* are in src/main/attrib.c
183 : maechler 890 *
184 : bates 536 * @param obj object in which to assign the slot
185 :     * @param nm name of the slot, as an R name object
186 :     * @param type type of SEXP to allocate
187 :     * @param length length of SEXP to allocate
188 : maechler 890 *
189 : bates 536 * @return SEXP of given type and length assigned as slot nm in obj
190 :     */
191 :     static R_INLINE
192 :     SEXP ALLOC_SLOT(SEXP obj, SEXP nm, SEXPTYPE type, int length)
193 :     {
194 :     SEXP val = allocVector(type, length);
195 : bates 441
196 : bates 536 SET_SLOT(obj, nm, val);
197 :     return val;
198 :     }
199 :    
200 : maechler 890 /**
201 : bates 679 * Expand compressed pointers in the array mp into a full set of indices
202 : bates 536 * in the array mj.
203 : maechler 890 *
204 : bates 679 * @param ncol number of columns (or rows)
205 : bates 536 * @param mp column pointer vector of length ncol + 1
206 : bates 679 * @param mj vector of length mp[ncol] to hold the result
207 : maechler 890 *
208 : bates 536 * @return mj
209 :     */
210 :     static R_INLINE
211 : bates 679 int* expand_cmprPt(int ncol, const int mp[], int mj[])
212 : bates 536 {
213 :     int j;
214 :     for (j = 0; j < ncol; j++) {
215 :     int j2 = mp[j+1], jj;
216 :     for (jj = mp[j]; jj < j2; jj++) mj[jj] = j;
217 :     }
218 :     return mj;
219 :     }
220 :    
221 : mmaechler 2175 /**
222 : dmbates 2260 * Check if slot(obj, "x") contains any NA (or NaN).
223 : mmaechler 2175 *
224 :     * @param obj a 'Matrix' object with an 'x' slot.
225 :     *
226 : dmbates 2260 * @return Rboolean :== any(is.na(slot(obj, "x") )
227 : mmaechler 2175 */
228 :     static R_INLINE
229 : mmaechler 2453 Rboolean any_NA_in_x(SEXP obj)
230 : mmaechler 2175 {
231 :     double *x = REAL(GET_SLOT(obj, Matrix_xSym));
232 :     int i, n = LENGTH(GET_SLOT(obj, Matrix_xSym));
233 :     for(i=0; i < n; i++)
234 :     if(ISNAN(x[i])) return TRUE;
235 :     /* else */
236 :     return FALSE;
237 :     }
238 :    
239 :    
240 : maechler 1200 void make_d_matrix_triangular(double *x, SEXP from);
241 :     void make_i_matrix_triangular( int *x, SEXP from);
242 : bates 582
243 : maechler 1200 void make_d_matrix_symmetric(double *to, SEXP from);
244 :     void make_i_matrix_symmetric( int *to, SEXP from);
245 :    
246 : bates 738 SEXP Matrix_expand_pointers(SEXP pP);
247 :    
248 : maechler 1432 SEXP dup_mMatrix_as_dgeMatrix(SEXP A);
249 : maechler 1725 SEXP dup_mMatrix_as_geMatrix (SEXP A);
250 : bates 1395
251 : maechler 1654 SEXP new_dgeMatrix(int nrow, int ncol);
252 : mmaechler 2525 SEXP m_encodeInd (SEXP ij, SEXP di, SEXP chk_bnds);
253 :     SEXP m_encodeInd2(SEXP i, SEXP j, SEXP di, SEXP chk_bnds);
254 : maechler 1654
255 : mmaechler 2203
256 : bates 1461 static R_INLINE SEXP
257 :     mMatrix_as_dgeMatrix(SEXP A)
258 :     {
259 : bates 1463 return strcmp(class_P(A), "dgeMatrix") ? dup_mMatrix_as_dgeMatrix(A) : A;
260 : bates 1461 }
261 : bates 1416
262 : maechler 1725 static R_INLINE SEXP
263 :     mMatrix_as_geMatrix(SEXP A)
264 :     {
265 :     return strcmp(class_P(A) + 1, "geMatrix") ? dup_mMatrix_as_geMatrix(A) : A;
266 :     }
267 :    
268 : bates 1416 /**
269 :     * Return the 0-based index of a string match in a vector of strings
270 :     * terminated by an empty string. Returns -1 for no match.
271 :     *
272 : bates 2104 * @param class string to match
273 : bates 1416 * @param valid vector of possible matches terminated by an empty string
274 :     *
275 :     * @return index of match or -1 for no match
276 :     */
277 :     static R_INLINE int
278 : bates 1867 Matrix_check_class(const char *class, char **valid)
279 : bates 1416 {
280 :     int ans;
281 :     for (ans = 0; ; ans++) {
282 :     if (!strlen(valid[ans])) return -1;
283 :     if (!strcmp(class, valid[ans])) return ans;
284 :     }
285 :     }
286 :    
287 : mmaechler 2364 int Matrix_check_class_etc(SEXP x, char **valid);
288 :     int Matrix_check_class_and_super(SEXP x, char **valid, SEXP rho);
289 : mmaechler 2203
290 : bates 582 #ifdef __cplusplus
291 :     }
292 : bates 572 #endif
293 : bates 582
294 :     #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