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