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

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