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 2392 - (view) (download) (as text)
Original Path: pkg/src/Mutils.h

1 : bates 10 #ifndef MATRIX_MUTILS_H
2 :     #define MATRIX_MUTILS_H
3 :    
4 : mmaechler 2336 #define Matrix_with_SPQR
5 :    
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 2348 SEXP Matrix_make_named(int TYP, const char **names);
75 : bates 592 SEXP check_scalar_string(SEXP sP, char *vals, char *nm);
76 : maechler 2113 Rboolean equal_string_vectors(SEXP s1, SEXP s2);
77 :    
78 : maechler 1747 void d_packed_getDiag(double *dest, SEXP x, int n);
79 :     void l_packed_getDiag( int *dest, SEXP x, int n);
80 :     void tr_d_packed_getDiag(double *dest, SEXP x);
81 :     void tr_l_packed_getDiag( int *dest, SEXP x);
82 :    
83 : bates 862 SEXP Matrix_getElement(SEXP list, char *nm);
84 : bates 592
85 : maechler 952 #define PACKED_TO_FULL(TYPE) \
86 :     TYPE *packed_to_full_ ## TYPE(TYPE *dest, const TYPE *src, \
87 :     int n, enum CBLAS_UPLO uplo)
88 :     PACKED_TO_FULL(double);
89 :     PACKED_TO_FULL(int);
90 :     #undef PACKED_TO_FULL
91 : bates 738
92 : maechler 952 #define FULL_TO_PACKED(TYPE) \
93 :     TYPE *full_to_packed_ ## TYPE(TYPE *dest, const TYPE *src, int n, \
94 :     enum CBLAS_UPLO uplo, enum CBLAS_DIAG diag)
95 :     FULL_TO_PACKED(double);
96 :     FULL_TO_PACKED(int);
97 :     #undef FULL_TO_PACKED
98 :    
99 :    
100 : bates 592 extern /* stored pointers to symbols initialized in R_init_Matrix */
101 : bates 329 #include "Syms.h"
102 : bates 10
103 : bates 432 /* zero an array */
104 : bates 441 #define AZERO(x, n) {int _I_, _SZ_ = (n); for(_I_ = 0; _I_ < _SZ_; _I_++) (x)[_I_] = 0;}
105 : bates 432
106 : bates 597 /* number of elements in one triangle of a square matrix of order n */
107 :     #define PACKED_LENGTH(n) ((n) * ((n) + 1))/2
108 :    
109 : bates 738 /* duplicate the slot with name given by sym from src to dest */
110 : maechler 2120
111 : bates 738 #define slot_dup(dest, src, sym) SET_SLOT(dest, sym, duplicate(GET_SLOT(src, sym)))
112 :    
113 : maechler 2120 /* is not yet used: */
114 : maechler 1736 #define slot_nonNull_dup(dest, src, sym) \
115 :     if(GET_SLOT(src, sym) != R_NilValue) \
116 :     SET_SLOT(dest, sym, duplicate(GET_SLOT(src, sym)))
117 :    
118 :     /* TODO: Make this faster for the case where dimnames = list(NULL,NULL)
119 :     * and hence don't have to be set ! */
120 :     #define SET_DimNames(dest, src) slot_dup(dest, src, Matrix_DimNamesSym)
121 :    
122 :    
123 : maechler 951 #define uplo_P(_x_) CHAR(STRING_ELT(GET_SLOT(_x_, Matrix_uploSym), 0))
124 :     #define diag_P(_x_) CHAR(STRING_ELT(GET_SLOT(_x_, Matrix_diagSym), 0))
125 : bates 1461 #define class_P(_x_) CHAR(asChar(getAttrib(_x_, R_ClassSymbol)))
126 : maechler 951
127 : maechler 1725 /* should also work for "matrix" matrices: */
128 :     #define Real_KIND(_x_) (IS_S4_OBJECT(_x_) ? Real_kind(_x_) : \
129 :     (isReal(_x_) ? 0 : (isLogical(_x_) ? 1 : -1)))
130 : maechler 2115 /* This one gives '0' also for integer "matrix" :*/
131 :     #define Real_KIND2(_x_) (IS_S4_OBJECT(_x_) ? Real_kind(_x_) : \
132 :     (isLogical(_x_) ? 1 : 0))
133 : maechler 1725
134 :     /* requires 'x' slot: */
135 : maechler 1548 #define Real_kind(_x_) (isReal(GET_SLOT(_x_, Matrix_xSym)) ? 0 : \
136 : maechler 1725 (isLogical(GET_SLOT(_x_, Matrix_xSym)) ? 1 : -1))
137 : maechler 1548
138 : maechler 2115 #define DECLARE_AND_GET_X_SLOT(__C_TYPE, __SEXP) \
139 :     __C_TYPE *xx = __SEXP(GET_SLOT(x, Matrix_xSym))
140 : maechler 1548
141 : maechler 2115
142 : maechler 890 /**
143 : bates 597 * Check for valid length of a packed triangular array and return the
144 :     * corresponding number of columns
145 : maechler 890 *
146 : bates 597 * @param len length of a packed triangular array
147 : maechler 890 *
148 : bates 597 * @return number of columns
149 :     */
150 :     static R_INLINE
151 : maechler 890 int packed_ncol(int len)
152 : bates 597 {
153 :     int disc = 8 * len + 1; /* discriminant */
154 :     int sqrtd = (int) sqrt((double) disc);
155 :    
156 :     if (len < 0 || disc != sqrtd * sqrtd)
157 :     error(_("invalid 'len' = %d in packed_ncol"));
158 :     return (sqrtd - 1)/2;
159 :     }
160 :    
161 : maechler 890 /**
162 : bates 536 * Allocate an SEXP of given type and length, assign it as slot nm in
163 :     * the object, and return the SEXP. The validity of this function
164 :     * depends on SET_SLOT not duplicating val when NAMED(val) == 0. If
165 :     * this behavior changes then ALLOC_SLOT must use SET_SLOT followed by
166 :     * GET_SLOT to ensure that the value returned is indeed the SEXP in
167 :     * the slot.
168 : maechler 1747 * NOTE: GET_SLOT(x, what) :== R_do_slot (x, what)
169 :     * ---- SET_SLOT(x, what, value) :== R_do_slot_assign(x, what, value)
170 :     * and the R_do_slot* are in src/main/attrib.c
171 : maechler 890 *
172 : bates 536 * @param obj object in which to assign the slot
173 :     * @param nm name of the slot, as an R name object
174 :     * @param type type of SEXP to allocate
175 :     * @param length length of SEXP to allocate
176 : maechler 890 *
177 : bates 536 * @return SEXP of given type and length assigned as slot nm in obj
178 :     */
179 :     static R_INLINE
180 :     SEXP ALLOC_SLOT(SEXP obj, SEXP nm, SEXPTYPE type, int length)
181 :     {
182 :     SEXP val = allocVector(type, length);
183 : bates 441
184 : bates 536 SET_SLOT(obj, nm, val);
185 :     return val;
186 :     }
187 :    
188 : maechler 890 /**
189 : bates 679 * Expand compressed pointers in the array mp into a full set of indices
190 : bates 536 * in the array mj.
191 : maechler 890 *
192 : bates 679 * @param ncol number of columns (or rows)
193 : bates 536 * @param mp column pointer vector of length ncol + 1
194 : bates 679 * @param mj vector of length mp[ncol] to hold the result
195 : maechler 890 *
196 : bates 536 * @return mj
197 :     */
198 :     static R_INLINE
199 : bates 679 int* expand_cmprPt(int ncol, const int mp[], int mj[])
200 : bates 536 {
201 :     int j;
202 :     for (j = 0; j < ncol; j++) {
203 :     int j2 = mp[j+1], jj;
204 :     for (jj = mp[j]; jj < j2; jj++) mj[jj] = j;
205 :     }
206 :     return mj;
207 :     }
208 :    
209 : mmaechler 2175 /**
210 : dmbates 2260 * Check if slot(obj, "x") contains any NA (or NaN).
211 : mmaechler 2175 *
212 :     * @param obj a 'Matrix' object with an 'x' slot.
213 :     *
214 : dmbates 2260 * @return Rboolean :== any(is.na(slot(obj, "x") )
215 : mmaechler 2175 */
216 :     static R_INLINE
217 :     Rboolean any_NA(SEXP obj)
218 :     {
219 :     double *x = REAL(GET_SLOT(obj, Matrix_xSym));
220 :     int i, n = LENGTH(GET_SLOT(obj, Matrix_xSym));
221 :     for(i=0; i < n; i++)
222 :     if(ISNAN(x[i])) return TRUE;
223 :     /* else */
224 :     return FALSE;
225 :     }
226 :    
227 :    
228 : maechler 1200 void make_d_matrix_triangular(double *x, SEXP from);
229 :     void make_i_matrix_triangular( int *x, SEXP from);
230 : bates 582
231 : maechler 1200 void make_d_matrix_symmetric(double *to, SEXP from);
232 :     void make_i_matrix_symmetric( int *to, SEXP from);
233 :    
234 : bates 738 SEXP Matrix_expand_pointers(SEXP pP);
235 :    
236 : maechler 1432 SEXP dup_mMatrix_as_dgeMatrix(SEXP A);
237 : maechler 1725 SEXP dup_mMatrix_as_geMatrix (SEXP A);
238 : bates 1395
239 : maechler 1654 SEXP new_dgeMatrix(int nrow, int ncol);
240 : mmaechler 2203 SEXP m_encodeInd (SEXP ij, SEXP di);
241 :     SEXP m_encodeInd2(SEXP i, SEXP j, SEXP di);
242 : maechler 1654
243 : mmaechler 2203
244 : bates 1461 static R_INLINE SEXP
245 :     mMatrix_as_dgeMatrix(SEXP A)
246 :     {
247 : bates 1463 return strcmp(class_P(A), "dgeMatrix") ? dup_mMatrix_as_dgeMatrix(A) : A;
248 : bates 1461 }
249 : bates 1416
250 : maechler 1725 static R_INLINE SEXP
251 :     mMatrix_as_geMatrix(SEXP A)
252 :     {
253 :     return strcmp(class_P(A) + 1, "geMatrix") ? dup_mMatrix_as_geMatrix(A) : A;
254 :     }
255 :    
256 : bates 1416 /**
257 :     * Return the 0-based index of a string match in a vector of strings
258 :     * terminated by an empty string. Returns -1 for no match.
259 :     *
260 : bates 2104 * @param class string to match
261 : bates 1416 * @param valid vector of possible matches terminated by an empty string
262 :     *
263 :     * @return index of match or -1 for no match
264 :     */
265 :     static R_INLINE int
266 : bates 1867 Matrix_check_class(const char *class, char **valid)
267 : bates 1416 {
268 :     int ans;
269 :     for (ans = 0; ; ans++) {
270 :     if (!strlen(valid[ans])) return -1;
271 :     if (!strcmp(class, valid[ans])) return ans;
272 :     }
273 :     }
274 :    
275 : mmaechler 2364 int Matrix_check_class_etc(SEXP x, char **valid);
276 :     int Matrix_check_class_and_super(SEXP x, char **valid, SEXP rho);
277 : mmaechler 2203
278 : bates 582 #ifdef __cplusplus
279 :     }
280 : bates 572 #endif
281 : bates 582
282 :     #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