SCM

SCM Repository

[matrix] Annotation of /pkg/Matrix/src/Csparse.c
ViewVC logotype

Annotation of /pkg/Matrix/src/Csparse.c

Parent Directory Parent Directory | Revision Log Revision Log


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

1 : bates 1218 /* Sparse matrices in compressed column-oriented form */
2 : mmaechler 2677
3 : bates 922 #include "Csparse.h"
4 : maechler 2120 #include "Tsparse.h"
5 : bates 922 #include "chm_common.h"
6 :    
7 : mmaechler 2279 /** "Cheap" C version of Csparse_validate() - *not* sorting : */
8 :     Rboolean isValid_Csparse(SEXP x)
9 :     {
10 :     /* NB: we do *NOT* check a potential 'x' slot here, at all */
11 :     SEXP pslot = GET_SLOT(x, Matrix_pSym),
12 :     islot = GET_SLOT(x, Matrix_iSym);
13 :     int *dims = INTEGER(GET_SLOT(x, Matrix_DimSym)), j,
14 :     nrow = dims[0],
15 :     ncol = dims[1],
16 :     *xp = INTEGER(pslot),
17 :     *xi = INTEGER(islot);
18 :    
19 :     if (length(pslot) != dims[1] + 1)
20 :     return FALSE;
21 :     if (xp[0] != 0)
22 :     return FALSE;
23 :     if (length(islot) < xp[ncol]) /* allow larger slots from over-allocation!*/
24 :     return FALSE;
25 :     for (j = 0; j < xp[ncol]; j++) {
26 :     if (xi[j] < 0 || xi[j] >= nrow)
27 :     return FALSE;
28 :     }
29 :     for (j = 0; j < ncol; j++) {
30 :     if (xp[j] > xp[j + 1])
31 :     return FALSE;
32 :     }
33 :     return TRUE;
34 :     }
35 :    
36 : mmaechler 2312 SEXP Csparse_validate(SEXP x) {
37 :     return Csparse_validate_(x, FALSE);
38 :     }
39 :    
40 : mmaechler 2889
41 :     #define _t_Csparse_validate
42 :     #include "t_Csparse_validate.c"
43 :    
44 :     #define _t_Csparse_sort
45 :     #include "t_Csparse_validate.c"
46 :    
47 :     // R: .validateCsparse(x, sort.if.needed = FALSE) :
48 : mmaechler 2312 SEXP Csparse_validate2(SEXP x, SEXP maybe_modify) {
49 :     return Csparse_validate_(x, asLogical(maybe_modify));
50 :     }
51 :    
52 : mmaechler 2889 // R: Matrix:::.sortCsparse(x) :
53 :     SEXP Csparse_sort (SEXP x) {
54 :     int ok = Csparse_sort_2(x, TRUE); // modifying x directly
55 :     if(!ok) warning(_("Csparse_sort(x): x is not a valid (apart from sorting) CsparseMatrix"));
56 :     return x;
57 : bates 922 }
58 :    
59 : maechler 1968 SEXP Rsparse_validate(SEXP x)
60 :     {
61 :     /* NB: we do *NOT* check a potential 'x' slot here, at all */
62 :     SEXP pslot = GET_SLOT(x, Matrix_pSym),
63 :     jslot = GET_SLOT(x, Matrix_jSym);
64 :     Rboolean sorted, strictly;
65 :     int i, k,
66 :     *dims = INTEGER(GET_SLOT(x, Matrix_DimSym)),
67 :     nrow = dims[0],
68 :     ncol = dims[1],
69 :     *xp = INTEGER(pslot),
70 :     *xj = INTEGER(jslot);
71 :    
72 :     if (length(pslot) != dims[0] + 1)
73 :     return mkString(_("slot p must have length = nrow(.) + 1"));
74 :     if (xp[0] != 0)
75 :     return mkString(_("first element of slot p must be zero"));
76 :     if (length(jslot) < xp[nrow]) /* allow larger slots from over-allocation!*/
77 :     return
78 :     mkString(_("last element of slot p must match length of slots j and x"));
79 :     for (i = 0; i < length(jslot); i++) {
80 :     if (xj[i] < 0 || xj[i] >= ncol)
81 :     return mkString(_("all column indices must be between 0 and ncol-1"));
82 :     }
83 :     sorted = TRUE; strictly = TRUE;
84 :     for (i = 0; i < nrow; i++) {
85 :     if (xp[i] > xp[i+1])
86 :     return mkString(_("slot p must be non-decreasing"));
87 :     if(sorted)
88 :     for (k = xp[i] + 1; k < xp[i + 1]; k++) {
89 :     if (xj[k] < xj[k - 1])
90 :     sorted = FALSE;
91 :     else if (xj[k] == xj[k - 1])
92 :     strictly = FALSE;
93 :     }
94 :     }
95 :     if (!sorted)
96 : mmaechler 2661 /* cannot easily use cholmod_sort(.) ... -> "error out" :*/
97 : maechler 1968 return mkString(_("slot j is not increasing inside a column"));
98 :     else if(!strictly) /* sorted, but not strictly */
99 :     return mkString(_("slot j is not *strictly* increasing inside a column"));
100 :    
101 :     return ScalarLogical(1);
102 :     }
103 :    
104 : mmaechler 3055 /**
105 :     * From a CsparseMatrix, produce a dense one.
106 :     * Directly deals with symmetric, triangular and general.
107 :     * Called from ../R/Csparse.R's C2dense()
108 :     *
109 :     * @param x a CsparseMatrix: currently all 9 of "[dln][gst]CMatrix"
110 :     * @param symm_or_tri integer (NA, < 0, > 0, = 0) specifying the knowledge of the caller about x:
111 :     * NA : unknown => will be determined
112 :     * = 0 : "generalMatrix" (not symm or tri);
113 :     * < 0 : "triangularMatrix"
114 :     * > 0 : "symmetricMatrix"
115 :     *
116 :     * @return a "denseMatrix"
117 :     */
118 :     SEXP Csparse_to_dense(SEXP x, SEXP symm_or_tri)
119 : bates 1059 {
120 : mmaechler 3055 Rboolean is_sym, is_tri;
121 :     int is_sym_or_tri = asInteger(symm_or_tri),
122 :     ctype = 0; // <- default = "dgC"
123 :     static const char *valid[] = { MATRIX_VALID_Csparse, ""};
124 :     if(is_sym_or_tri == NA_INTEGER) { // find if is(x, "symmetricMatrix") :
125 :     ctype = Matrix_check_class_etc(x, valid);
126 :     is_sym = (ctype % 3 == 1);
127 :     is_tri = (ctype % 3 == 2);
128 :     } else {
129 :     is_sym = is_sym_or_tri > 0;
130 :     is_tri = is_sym_or_tri < 0;
131 :     // => both are FALSE iff is_.. == 0
132 :     if(is_sym || is_tri)
133 :     ctype = Matrix_check_class_etc(x, valid);
134 :     }
135 :     CHM_SP chxs = AS_CHM_SP__(x);// -> chxs->stype = +- 1 <==> symmetric
136 :     R_CheckStack();
137 :     if(is_tri && *diag_P(x) == 'U') { // ==> x := diagU2N(x), directly for chxs
138 :     CHM_SP eye = cholmod_speye(chxs->nrow, chxs->ncol, chxs->xtype, &c);
139 :     double one[] = {1, 0};
140 :     CHM_SP ans = cholmod_add(chxs, eye, one, one,
141 :     /* values: */ ((ctype / 3) != 2), // TRUE iff not "nMatrix"
142 :     TRUE, &c);
143 :     cholmod_free_sparse(&eye, &c);
144 :     chxs = cholmod_copy_sparse(ans, &c);
145 :     cholmod_free_sparse(&ans, &c);
146 :     }
147 :     /* The following loses the symmetry property, since cholmod_dense has none,
148 : maechler 1751 * BUT, much worse (FIXME!), it also transforms CHOLMOD_PATTERN ("n") matrices
149 : mmaechler 3055 * to numeric (CHOLMOD_REAL) ones {and we "revert" via chm_dense_to_SEXP()}: */
150 : mmaechler 2661 CHM_DN chxd = cholmod_sparse_to_dense(chxs, &c);
151 : maechler 1751 int Rkind = (chxs->xtype == CHOLMOD_PATTERN)? -1 : Real_kind(x);
152 : bates 1059
153 : mmaechler 3055 SEXP ans = chm_dense_to_SEXP(chxd, 1, Rkind,GET_SLOT(x, Matrix_DimNamesSym));
154 :     // -> a [dln]geMatrix
155 :     if(is_sym) { // ==> want [dln]syMatrix
156 :     const char cl1 = class_P(ans)[0];
157 :     PROTECT(ans);
158 :     SEXP aa = PROTECT(NEW_OBJECT(MAKE_CLASS((cl1 == 'd') ? "dsyMatrix" :
159 :     ((cl1 == 'l') ? "lsyMatrix" : "nsyMatrix"))));
160 :     // No need to duplicate() as slots of ans are freshly allocated and ans will not be used
161 :     SET_SLOT(aa, Matrix_xSym, GET_SLOT(ans, Matrix_xSym));
162 :     SET_SLOT(aa, Matrix_DimSym, GET_SLOT(ans, Matrix_DimSym));
163 :     SET_SLOT(aa, Matrix_DimNamesSym,GET_SLOT(ans, Matrix_DimNamesSym));
164 :     SET_SLOT(aa, Matrix_uploSym, mkString((chxs->stype > 0) ? "U" : "L"));
165 :     UNPROTECT(2);
166 :     return aa;
167 :     }
168 :     else if(is_tri) { // ==> want [dln]trMatrix
169 :     const char cl1 = class_P(ans)[0];
170 :     PROTECT(ans);
171 :     SEXP aa = PROTECT(NEW_OBJECT(MAKE_CLASS((cl1 == 'd') ? "dtrMatrix" :
172 :     ((cl1 == 'l') ? "ltrMatrix" : "ntrMatrix"))));
173 :     // No need to duplicate() as slots of ans are freshly allocated and ans will not be used
174 :     SET_SLOT(aa, Matrix_xSym, GET_SLOT(ans, Matrix_xSym));
175 :     SET_SLOT(aa, Matrix_DimSym, GET_SLOT(ans, Matrix_DimSym));
176 :     SET_SLOT(aa, Matrix_DimNamesSym,GET_SLOT(ans, Matrix_DimNamesSym));
177 :     slot_dup(aa, x, Matrix_uploSym);
178 :     /* already by NEW_OBJECT(..) above:
179 :     SET_SLOT(aa, Matrix_diagSym, mkString("N")); */
180 :     UNPROTECT(2);
181 :     return aa;
182 :     }
183 :     else
184 :     return ans;
185 : bates 1059 }
186 :    
187 : mmaechler 2628 // FIXME: do not go via CHM (should not be too hard, to just *drop* the x-slot, right?
188 : maechler 1548 SEXP Csparse_to_nz_pattern(SEXP x, SEXP tri)
189 : bates 1371 {
190 : mmaechler 2223 CHM_SP chxs = AS_CHM_SP__(x);
191 : mmaechler 2661 CHM_SP chxcp = cholmod_copy(chxs, chxs->stype, CHOLMOD_PATTERN, &c);
192 : bates 1867 int tr = asLogical(tri);
193 : maechler 1960 R_CheckStack();
194 : bates 1371
195 : maechler 1960 return chm_sparse_to_SEXP(chxcp, 1/*do_free*/,
196 : bates 1867 tr ? ((*uplo_P(x) == 'U') ? 1 : -1) : 0,
197 :     0, tr ? diag_P(x) : "",
198 : maechler 1548 GET_SLOT(x, Matrix_DimNamesSym));
199 : bates 1371 }
200 :    
201 : mmaechler 2628 // n.CMatrix --> [dli].CMatrix (not going through CHM!)
202 :     SEXP nz_pattern_to_Csparse(SEXP x, SEXP res_kind)
203 :     {
204 :     return nz2Csparse(x, asInteger(res_kind));
205 :     }
206 : mmaechler 3055
207 : mmaechler 2628 // n.CMatrix --> [dli].CMatrix (not going through CHM!)
208 : mmaechler 3055 // NOTE: use chm_MOD_xtype(() to change type of 'cholmod_sparse' matrix
209 : mmaechler 2628 SEXP nz2Csparse(SEXP x, enum x_slot_kind r_kind)
210 :     {
211 :     const char *cl_x = class_P(x);
212 :     if(cl_x[0] != 'n') error(_("not a 'n.CMatrix'"));
213 :     if(cl_x[2] != 'C') error(_("not a CsparseMatrix"));
214 :     int nnz = LENGTH(GET_SLOT(x, Matrix_iSym));
215 :     SEXP ans;
216 : dmbates 2804 char *ncl = alloca(strlen(cl_x) + 1); /* not much memory required */
217 :     strcpy(ncl, cl_x);
218 : mmaechler 2628 double *dx_x; int *ix_x;
219 :     ncl[0] = (r_kind == x_double ? 'd' :
220 :     (r_kind == x_logical ? 'l' :
221 :     /* else (for now): r_kind == x_integer : */ 'i'));
222 :     PROTECT(ans = NEW_OBJECT(MAKE_CLASS(ncl)));
223 :     // create a correct 'x' slot:
224 :     switch(r_kind) {
225 :     int i;
226 :     case x_double: // 'd'
227 :     dx_x = REAL(ALLOC_SLOT(ans, Matrix_xSym, REALSXP, nnz));
228 :     for (i=0; i < nnz; i++) dx_x[i] = 1.;
229 :     break;
230 :     case x_logical: // 'l'
231 :     ix_x = LOGICAL(ALLOC_SLOT(ans, Matrix_xSym, LGLSXP, nnz));
232 :     for (i=0; i < nnz; i++) ix_x[i] = TRUE;
233 :     break;
234 :     case x_integer: // 'i'
235 :     ix_x = INTEGER(ALLOC_SLOT(ans, Matrix_xSym, INTSXP, nnz));
236 :     for (i=0; i < nnz; i++) ix_x[i] = 1;
237 :     break;
238 :    
239 :     default:
240 :     error(_("nz2Csparse(): invalid/non-implemented r_kind = %d"),
241 :     r_kind);
242 :     }
243 :    
244 :     // now copy all other slots :
245 :     slot_dup(ans, x, Matrix_iSym);
246 :     slot_dup(ans, x, Matrix_pSym);
247 :     slot_dup(ans, x, Matrix_DimSym);
248 :     slot_dup(ans, x, Matrix_DimNamesSym);
249 :     if(ncl[1] != 'g') { // symmetric or triangular ...
250 :     slot_dup_if_has(ans, x, Matrix_uploSym);
251 :     slot_dup_if_has(ans, x, Matrix_diagSym);
252 :     }
253 :     UNPROTECT(1);
254 :     return ans;
255 :     }
256 :    
257 : mmaechler 3055 SEXP Csparse_to_matrix(SEXP x, SEXP chk, SEXP symm)
258 : bates 922 {
259 : mmaechler 3055 int is_sym = asLogical(symm);
260 :     if(is_sym == NA_LOGICAL) { // find if is(x, "symmetricMatrix") :
261 :     static const char *valid[] = { MATRIX_VALID_Csparse, ""};
262 :     int ctype = Matrix_check_class_etc(x, valid);
263 :     is_sym = (ctype % 3 == 1);
264 :     }
265 :     return chm_dense_to_matrix(
266 :     cholmod_sparse_to_dense(AS_CHM_SP2(x, asLogical(chk)), &c),
267 :     1 /*do_free*/,
268 :     (is_sym
269 :     ? symmetric_DimNames(GET_SLOT(x, Matrix_DimNamesSym))
270 :     : GET_SLOT(x, Matrix_DimNamesSym)));
271 : bates 1366 }
272 : mmaechler 3055
273 : mmaechler 2901 SEXP Csparse_to_vector(SEXP x)
274 :     {
275 :     return chm_dense_to_vector(cholmod_sparse_to_dense(AS_CHM_SP__(x), &c), 1);
276 :     }
277 : bates 1366
278 :     SEXP Csparse_to_Tsparse(SEXP x, SEXP tri)
279 :     {
280 : mmaechler 2223 CHM_SP chxs = AS_CHM_SP__(x);
281 : mmaechler 2661 CHM_TR chxt = cholmod_sparse_to_triplet(chxs, &c);
282 : bates 1867 int tr = asLogical(tri);
283 : maechler 1736 int Rkind = (chxs->xtype != CHOLMOD_PATTERN) ? Real_kind(x) : 0;
284 : maechler 1960 R_CheckStack();
285 : bates 922
286 : bates 1867 return chm_triplet_to_SEXP(chxt, 1,
287 :     tr ? ((*uplo_P(x) == 'U') ? 1 : -1) : 0,
288 :     Rkind, tr ? diag_P(x) : "",
289 : bates 1371 GET_SLOT(x, Matrix_DimNamesSym));
290 : bates 922 }
291 :    
292 : mmaechler 3023 SEXP Csparse_to_tCsparse(SEXP x, SEXP uplo, SEXP diag)
293 :     {
294 :     CHM_SP chxs = AS_CHM_SP__(x);
295 :     int Rkind = (chxs->xtype != CHOLMOD_PATTERN) ? Real_kind(x) : 0;
296 :     R_CheckStack();
297 :     return chm_sparse_to_SEXP(chxs, /* dofree = */ 0,
298 :     /* uploT = */ (*CHAR(asChar(uplo)) == 'U')? 1: -1,
299 :     Rkind, /* diag = */ CHAR(STRING_ELT(diag, 0)),
300 :     GET_SLOT(x, Matrix_DimNamesSym));
301 :     }
302 :    
303 :     SEXP Csparse_to_tTsparse(SEXP x, SEXP uplo, SEXP diag)
304 :     {
305 :     CHM_SP chxs = AS_CHM_SP__(x);
306 :     CHM_TR chxt = cholmod_sparse_to_triplet(chxs, &c);
307 :     int Rkind = (chxs->xtype != CHOLMOD_PATTERN) ? Real_kind(x) : 0;
308 :     R_CheckStack();
309 :     return chm_triplet_to_SEXP(chxt, 1,
310 :     /* uploT = */ (*CHAR(asChar(uplo)) == 'U')? 1: -1,
311 :     Rkind, /* diag = */ CHAR(STRING_ELT(diag, 0)),
312 :     GET_SLOT(x, Matrix_DimNamesSym));
313 :     }
314 :    
315 :    
316 : bates 1371 SEXP Csparse_symmetric_to_general(SEXP x)
317 :     {
318 : mmaechler 2223 CHM_SP chx = AS_CHM_SP__(x), chgx;
319 : maechler 1736 int Rkind = (chx->xtype != CHOLMOD_PATTERN) ? Real_kind(x) : 0;
320 : maechler 1960 R_CheckStack();
321 : bates 1371
322 :     if (!(chx->stype))
323 : maechler 1548 error(_("Nonsymmetric matrix in Csparse_symmetric_to_general"));
324 : mmaechler 2661 chgx = cholmod_copy(chx, /* stype: */ 0, chx->xtype, &c);
325 : maechler 1375 /* xtype: pattern, "real", complex or .. */
326 : maechler 1548 return chm_sparse_to_SEXP(chgx, 1, 0, Rkind, "",
327 : mmaechler 3055 symmetric_DimNames(GET_SLOT(x, Matrix_DimNamesSym)));
328 : bates 1371 }
329 :    
330 : mmaechler 3055 SEXP Csparse_general_to_symmetric(SEXP x, SEXP uplo, SEXP sym_dmns)
331 : maechler 1598 {
332 : mmaechler 2817 int *adims = INTEGER(GET_SLOT(x, Matrix_DimSym)), n = adims[0];
333 :     if(n != adims[1]) {
334 :     error(_("Csparse_general_to_symmetric(): matrix is not square!"));
335 :     return R_NilValue; /* -Wall */
336 :     }
337 : mmaechler 2223 CHM_SP chx = AS_CHM_SP__(x), chgx;
338 : mmaechler 3020 int uploT = (*CHAR(asChar(uplo)) == 'U') ? 1 : -1;
339 : maechler 1736 int Rkind = (chx->xtype != CHOLMOD_PATTERN) ? Real_kind(x) : 0;
340 : maechler 1960 R_CheckStack();
341 : mmaechler 2661 chgx = cholmod_copy(chx, /* stype: */ uploT, chx->xtype, &c);
342 : mmaechler 3020
343 : mmaechler 3055 SEXP dns = GET_SLOT(x, Matrix_DimNamesSym);
344 :     if(asLogical(sym_dmns))
345 :     dns = symmetric_DimNames(dns);
346 :     else if((!isNull(VECTOR_ELT(dns, 0)) &&
347 :     !isNull(VECTOR_ELT(dns, 1))) ||
348 :     !isNull(getAttrib(dns, R_NamesSymbol))) {
349 :     /* symmetrize them if both are not NULL
350 :     * or names(dimnames(.)) is asymmetric : */
351 :     dns = PROTECT(duplicate(dns));
352 :     if(!equal_string_vectors(VECTOR_ELT(dns, 0),
353 :     VECTOR_ELT(dns, 1))) {
354 :     if(uploT == 1)
355 :     SET_VECTOR_ELT(dns, 0, VECTOR_ELT(dns,1));
356 :     else
357 :     SET_VECTOR_ELT(dns, 1, VECTOR_ELT(dns,0));
358 :     }
359 :     SEXP nms_dns = getAttrib(dns, R_NamesSymbol);
360 :     if(!isNull(nms_dns) && // names(dimnames(.)) :
361 :     !R_compute_identical(STRING_ELT(nms_dns, 0),
362 :     STRING_ELT(nms_dns, 1), 16)) {
363 :     if(uploT == 1)
364 :     SET_STRING_ELT(nms_dns, 0, STRING_ELT(nms_dns,1));
365 :     else
366 :     SET_STRING_ELT(nms_dns, 1, STRING_ELT(nms_dns,0));
367 :     setAttrib(dns, R_NamesSymbol, nms_dns);
368 :     }
369 :     UNPROTECT(1);
370 : mmaechler 3020 }
371 : maechler 1598 /* xtype: pattern, "real", complex or .. */
372 : mmaechler 3020 return chm_sparse_to_SEXP(chgx, 1, 0, Rkind, "", dns);
373 : maechler 1598 }
374 :    
375 : bates 1369 SEXP Csparse_transpose(SEXP x, SEXP tri)
376 : bates 922 {
377 : maechler 1921 /* TODO: lgCMatrix & igC* currently go via double prec. cholmod -
378 :     * since cholmod (& cs) lacks sparse 'int' matrices */
379 : mmaechler 2223 CHM_SP chx = AS_CHM_SP__(x);
380 : maechler 1736 int Rkind = (chx->xtype != CHOLMOD_PATTERN) ? Real_kind(x) : 0;
381 : mmaechler 2661 CHM_SP chxt = cholmod_transpose(chx, chx->xtype, &c);
382 : bates 1366 SEXP dn = PROTECT(duplicate(GET_SLOT(x, Matrix_DimNamesSym))), tmp;
383 : bates 1867 int tr = asLogical(tri);
384 : maechler 1960 R_CheckStack();
385 : bates 1369
386 : bates 1366 tmp = VECTOR_ELT(dn, 0); /* swap the dimnames */
387 :     SET_VECTOR_ELT(dn, 0, VECTOR_ELT(dn, 1));
388 :     SET_VECTOR_ELT(dn, 1, tmp);
389 : mmaechler 3020 if(!isNull(tmp = getAttrib(dn, R_NamesSymbol))) { // swap names(dimnames(.)):
390 :     SEXP nms_dns = PROTECT(allocVector(VECSXP, 2));
391 :     SET_VECTOR_ELT(nms_dns, 1, STRING_ELT(tmp, 0));
392 :     SET_VECTOR_ELT(nms_dns, 0, STRING_ELT(tmp, 1));
393 :     setAttrib(dn, R_NamesSymbol, nms_dns);
394 :     UNPROTECT(1);
395 :     }
396 : bates 1366 UNPROTECT(1);
397 : bates 1867 return chm_sparse_to_SEXP(chxt, 1, /* SWAP 'uplo' for triangular */
398 :     tr ? ((*uplo_P(x) == 'U') ? -1 : 1) : 0,
399 :     Rkind, tr ? diag_P(x) : "", dn);
400 : bates 922 }
401 :    
402 :     SEXP Csparse_Csparse_prod(SEXP a, SEXP b)
403 :     {
404 : maechler 2120 CHM_SP
405 : mmaechler 2223 cha = AS_CHM_SP(a),
406 :     chb = AS_CHM_SP(b),
407 : mmaechler 2661 chc = cholmod_ssmult(cha, chb, /*out_stype:*/ 0,
408 : mmaechler 2490 /* values:= is_numeric (T/F) */ cha->xtype > 0,
409 :     /*out sorted:*/ 1, &c);
410 : maechler 2125 const char *cl_a = class_P(a), *cl_b = class_P(b);
411 :     char diag[] = {'\0', '\0'};
412 :     int uploT = 0;
413 : mmaechler 2495 SEXP dn = PROTECT(allocVector(VECSXP, 2));
414 : maechler 1960 R_CheckStack();
415 : bates 922
416 : mmaechler 2494 #ifdef DEBUG_Matrix_verbose
417 : mmaechler 2490 Rprintf("DBG Csparse_C*_prod(%s, %s)\n", cl_a, cl_b);
418 :     #endif
419 :    
420 : maechler 2125 /* Preserve triangularity and even unit-triangularity if appropriate.
421 :     * Note that in that case, the multiplication itself should happen
422 :     * faster. But there's no support for that in CHOLMOD */
423 :    
424 :     /* UGLY hack -- rather should have (fast!) C-level version of
425 :     * is(a, "triangularMatrix") etc */
426 :     if (cl_a[1] == 't' && cl_b[1] == 't')
427 :     /* FIXME: fails for "Cholesky","BunchKaufmann"..*/
428 :     if(*uplo_P(a) == *uplo_P(b)) { /* both upper, or both lower tri. */
429 :     uploT = (*uplo_P(a) == 'U') ? 1 : -1;
430 :     if(*diag_P(a) == 'U' && *diag_P(b) == 'U') { /* return UNIT-triag. */
431 :     /* "remove the diagonal entries": */
432 :     chm_diagN2U(chc, uploT, /* do_realloc */ FALSE);
433 :     diag[0]= 'U';
434 :     }
435 :     else diag[0]= 'N';
436 :     }
437 : bates 1366 SET_VECTOR_ELT(dn, 0, /* establish dimnames */
438 :     duplicate(VECTOR_ELT(GET_SLOT(a, Matrix_DimNamesSym), 0)));
439 :     SET_VECTOR_ELT(dn, 1,
440 :     duplicate(VECTOR_ELT(GET_SLOT(b, Matrix_DimNamesSym), 1)));
441 : mmaechler 2495 UNPROTECT(1);
442 : maechler 2125 return chm_sparse_to_SEXP(chc, 1, uploT, /*Rkind*/0, diag, dn);
443 : bates 922 }
444 :    
445 : maechler 1659 SEXP Csparse_Csparse_crossprod(SEXP a, SEXP b, SEXP trans)
446 : bates 1657 {
447 : maechler 1659 int tr = asLogical(trans);
448 : maechler 2120 CHM_SP
449 : mmaechler 2223 cha = AS_CHM_SP(a),
450 :     chb = AS_CHM_SP(b),
451 : maechler 2120 chTr, chc;
452 : maechler 2125 const char *cl_a = class_P(a), *cl_b = class_P(b);
453 :     char diag[] = {'\0', '\0'};
454 :     int uploT = 0;
455 : mmaechler 2495 SEXP dn = PROTECT(allocVector(VECSXP, 2));
456 : maechler 1960 R_CheckStack();
457 : bates 1657
458 : mmaechler 2661 chTr = cholmod_transpose((tr) ? chb : cha, chb->xtype, &c);
459 :     chc = cholmod_ssmult((tr) ? cha : chTr, (tr) ? chTr : chb,
460 : maechler 2125 /*out_stype:*/ 0, cha->xtype, /*out sorted:*/ 1, &c);
461 : mmaechler 2661 cholmod_free_sparse(&chTr, &c);
462 : maechler 1659
463 : maechler 2125 /* Preserve triangularity and unit-triangularity if appropriate;
464 :     * see Csparse_Csparse_prod() for comments */
465 :     if (cl_a[1] == 't' && cl_b[1] == 't')
466 :     if(*uplo_P(a) != *uplo_P(b)) { /* one 'U', the other 'L' */
467 :     uploT = (*uplo_P(b) == 'U') ? 1 : -1;
468 :     if(*diag_P(a) == 'U' && *diag_P(b) == 'U') { /* return UNIT-triag. */
469 :     chm_diagN2U(chc, uploT, /* do_realloc */ FALSE);
470 :     diag[0]= 'U';
471 :     }
472 :     else diag[0]= 'N';
473 :     }
474 : bates 1657 SET_VECTOR_ELT(dn, 0, /* establish dimnames */
475 : maechler 1659 duplicate(VECTOR_ELT(GET_SLOT(a, Matrix_DimNamesSym), (tr) ? 0 : 1)));
476 : bates 1657 SET_VECTOR_ELT(dn, 1,
477 : maechler 1659 duplicate(VECTOR_ELT(GET_SLOT(b, Matrix_DimNamesSym), (tr) ? 0 : 1)));
478 : mmaechler 2495 UNPROTECT(1);
479 : maechler 2125 return chm_sparse_to_SEXP(chc, 1, uploT, /*Rkind*/0, diag, dn);
480 : bates 1657 }
481 :    
482 : bates 922 SEXP Csparse_dense_prod(SEXP a, SEXP b)
483 :     {
484 : mmaechler 2223 CHM_SP cha = AS_CHM_SP(a);
485 : mmaechler 3018 SEXP b_M = PROTECT(mMatrix_as_dgeMatrix2(b, // transpose_if_vector =
486 :     cha->ncol == 1));
487 : maechler 1960 CHM_DN chb = AS_CHM_DN(b_M);
488 : mmaechler 2661 CHM_DN chc = cholmod_allocate_dense(cha->nrow, chb->ncol, cha->nrow,
489 : maechler 1960 chb->xtype, &c);
490 :     SEXP dn = PROTECT(allocVector(VECSXP, 2));
491 :     double one[] = {1,0}, zero[] = {0,0};
492 : mmaechler 2628 int nprot = 2;
493 : maechler 1960 R_CheckStack();
494 : mmaechler 2628 /* Tim Davis, please FIXME: currently (2010-11) *fails* when a is a pattern matrix:*/
495 :     if(cha->xtype == CHOLMOD_PATTERN) {
496 :     /* warning(_("Csparse_dense_prod(): cholmod_sdmult() not yet implemented for pattern./ ngCMatrix" */
497 :     /* " --> slightly inefficient coercion")); */
498 : bates 922
499 : mmaechler 2628 // This *fails* to produce a CHOLMOD_REAL ..
500 :     // CHM_SP chd = cholmod_l_copy(cha, cha->stype, CHOLMOD_REAL, &c);
501 :     // --> use our Matrix-classes
502 :     SEXP da = PROTECT(nz2Csparse(a, x_double)); nprot++;
503 :     cha = AS_CHM_SP(da);
504 :     }
505 : mmaechler 2661 cholmod_sdmult(cha, 0, one, zero, chb, chc, &c);
506 : maechler 1660 SET_VECTOR_ELT(dn, 0, /* establish dimnames */
507 :     duplicate(VECTOR_ELT(GET_SLOT(a, Matrix_DimNamesSym), 0)));
508 :     SET_VECTOR_ELT(dn, 1,
509 :     duplicate(VECTOR_ELT(GET_SLOT(b_M, Matrix_DimNamesSym), 1)));
510 : mmaechler 2628 UNPROTECT(nprot);
511 : maechler 1660 return chm_dense_to_SEXP(chc, 1, 0, dn);
512 : bates 922 }
513 : maechler 925
514 : bates 1067 SEXP Csparse_dense_crossprod(SEXP a, SEXP b)
515 :     {
516 : mmaechler 2223 CHM_SP cha = AS_CHM_SP(a);
517 : mmaechler 3018 SEXP b_M = PROTECT(mMatrix_as_dgeMatrix2(b, // transpose_if_vector =
518 :     cha->nrow == 1));
519 : maechler 1960 CHM_DN chb = AS_CHM_DN(b_M);
520 : mmaechler 2661 CHM_DN chc = cholmod_allocate_dense(cha->ncol, chb->ncol, cha->ncol,
521 : maechler 1960 chb->xtype, &c);
522 : mmaechler 2629 SEXP dn = PROTECT(allocVector(VECSXP, 2)); int nprot = 2;
523 : maechler 1960 double one[] = {1,0}, zero[] = {0,0};
524 :     R_CheckStack();
525 : mmaechler 2629 // -- see Csparse_dense_prod() above :
526 :     if(cha->xtype == CHOLMOD_PATTERN) {
527 :     SEXP da = PROTECT(nz2Csparse(a, x_double)); nprot++;
528 :     cha = AS_CHM_SP(da);
529 :     }
530 : mmaechler 2661 cholmod_sdmult(cha, 1, one, zero, chb, chc, &c);
531 : maechler 1660 SET_VECTOR_ELT(dn, 0, /* establish dimnames */
532 :     duplicate(VECTOR_ELT(GET_SLOT(a, Matrix_DimNamesSym), 1)));
533 :     SET_VECTOR_ELT(dn, 1,
534 :     duplicate(VECTOR_ELT(GET_SLOT(b_M, Matrix_DimNamesSym), 1)));
535 : mmaechler 2629 UNPROTECT(nprot);
536 : maechler 1660 return chm_dense_to_SEXP(chc, 1, 0, dn);
537 : bates 1067 }
538 :    
539 : maechler 2125 /* Computes x'x or x x' -- *also* for Tsparse (triplet = TRUE)
540 :     see Csparse_Csparse_crossprod above for x'y and x y' */
541 : bates 928 SEXP Csparse_crossprod(SEXP x, SEXP trans, SEXP triplet)
542 : bates 922 {
543 : maechler 957 int trip = asLogical(triplet),
544 :     tr = asLogical(trans); /* gets reversed because _aat is tcrossprod */
545 : mmaechler 2491 #ifdef AS_CHM_DIAGU2N_FIXED_FINALLY
546 : mmaechler 2223 CHM_TR cht = trip ? AS_CHM_TR(x) : (CHM_TR) NULL;
547 : mmaechler 2491 #else /* workaround needed:*/
548 : mmaechler 2516 SEXP xx = PROTECT(Tsparse_diagU2N(x));
549 :     CHM_TR cht = trip ? AS_CHM_TR__(xx) : (CHM_TR) NULL;
550 : mmaechler 2491 #endif
551 : maechler 1960 CHM_SP chcp, chxt,
552 : maechler 2120 chx = (trip ?
553 : mmaechler 2661 cholmod_triplet_to_sparse(cht, cht->nnz, &c) :
554 : mmaechler 2223 AS_CHM_SP(x));
555 : bates 1366 SEXP dn = PROTECT(allocVector(VECSXP, 2));
556 : maechler 1960 R_CheckStack();
557 : bates 922
558 : mmaechler 2661 if (!tr) chxt = cholmod_transpose(chx, chx->xtype, &c);
559 :     chcp = cholmod_aat((!tr) ? chxt : chx, (int *) NULL, 0, chx->xtype, &c);
560 : maechler 2120 if(!chcp) {
561 :     UNPROTECT(1);
562 : mmaechler 2661 error(_("Csparse_crossprod(): error return from cholmod_aat()"));
563 : maechler 2120 }
564 : mmaechler 2661 cholmod_band_inplace(0, chcp->ncol, chcp->xtype, chcp, &c);
565 : bates 1360 chcp->stype = 1;
566 : mmaechler 2661 if (trip) cholmod_free_sparse(&chx, &c);
567 :     if (!tr) cholmod_free_sparse(&chxt, &c);
568 : maechler 1960 SET_VECTOR_ELT(dn, 0, /* establish dimnames */
569 : bates 1366 duplicate(VECTOR_ELT(GET_SLOT(x, Matrix_DimNamesSym),
570 : maechler 1660 (tr) ? 0 : 1)));
571 : bates 1366 SET_VECTOR_ELT(dn, 1, duplicate(VECTOR_ELT(dn, 0)));
572 : mmaechler 2516 #ifdef AS_CHM_DIAGU2N_FIXED_FINALLY
573 : bates 1366 UNPROTECT(1);
574 : mmaechler 2516 #else
575 :     UNPROTECT(2);
576 :     #endif
577 : maechler 1548 return chm_sparse_to_SEXP(chcp, 1, 0, 0, "", dn);
578 : bates 922 }
579 : bates 923
580 : mmaechler 2646 /* Csparse_drop(x, tol): drop entries with absolute value < tol, i.e,
581 :     * at least all "explicit" zeros */
582 : maechler 1618 SEXP Csparse_drop(SEXP x, SEXP tol)
583 :     {
584 : mmaechler 2175 const char *cl = class_P(x);
585 :     /* dtCMatrix, etc; [1] = the second character =?= 't' for triangular */
586 :     int tr = (cl[1] == 't');
587 : mmaechler 2223 CHM_SP chx = AS_CHM_SP__(x);
588 : mmaechler 2661 CHM_SP ans = cholmod_copy(chx, chx->stype, chx->xtype, &c);
589 : maechler 1618 double dtol = asReal(tol);
590 : maechler 1736 int Rkind = (chx->xtype != CHOLMOD_PATTERN) ? Real_kind(x) : 0;
591 : maechler 1960 R_CheckStack();
592 : maechler 1618
593 : mmaechler 2661 if(!cholmod_drop(dtol, ans, &c))
594 :     error(_("cholmod_drop() failed"));
595 : mmaechler 2725 return chm_sparse_to_SEXP(ans, 1,
596 : mmaechler 2175 tr ? ((*uplo_P(x) == 'U') ? 1 : -1) : 0,
597 :     Rkind, tr ? diag_P(x) : "",
598 : maechler 1736 GET_SLOT(x, Matrix_DimNamesSym));
599 : maechler 1618 }
600 :    
601 : bates 1218 SEXP Csparse_horzcat(SEXP x, SEXP y)
602 :     {
603 : mmaechler 3055 #define CSPARSE_CAT(_KIND_) \
604 :     CHM_SP chx = AS_CHM_SP__(x), chy = AS_CHM_SP__(y); \
605 :     R_CheckStack(); \
606 :     int Rk_x = (chx->xtype != CHOLMOD_PATTERN) ? Real_kind(x) : -3, \
607 :     Rk_y = (chy->xtype != CHOLMOD_PATTERN) ? Real_kind(y) : -3, Rkind; \
608 :     if(Rk_x == -3 || Rk_y == -3) { /* at least one of them is patter"n" */ \
609 :     if(Rk_x == -3 && Rk_y == -3) { /* fine */ \
610 :     } else { /* only one is a patter"n" \
611 :     * "Bug" in cholmod_horzcat()/vertcat(): returns patter"n" matrix if one of them is */ \
612 :     Rboolean ok; \
613 :     if(Rk_x == -3) { \
614 :     ok = chm_MOD_xtype(CHOLMOD_REAL, chx, &c); Rk_x = 0; \
615 :     } else if(Rk_y == -3) { \
616 :     ok = chm_MOD_xtype(CHOLMOD_REAL, chy, &c); Rk_y = 0; \
617 :     } else \
618 :     error(_("Impossible Rk_x/Rk_y in Csparse_%s(), please report"), _KIND_); \
619 :     if(!ok) \
620 :     error(_("chm_MOD_xtype() was not successful in Csparse_%s(), please report"), \
621 :     _KIND_); \
622 :     } \
623 :     } \
624 :     Rkind = /* logical if both x and y are */ (Rk_x == 1 && Rk_y == 1) ? 1 : 0
625 : maechler 1375
626 : mmaechler 3055 CSPARSE_CAT("horzcat");
627 :     // TODO: currently drops dimnames - and we fix at R level;
628 :    
629 : mmaechler 2661 return chm_sparse_to_SEXP(cholmod_horzcat(chx, chy, 1, &c),
630 : maechler 1960 1, 0, Rkind, "", R_NilValue);
631 : bates 1218 }
632 :    
633 :     SEXP Csparse_vertcat(SEXP x, SEXP y)
634 :     {
635 : mmaechler 3055 CSPARSE_CAT("vertcat");
636 :     // TODO: currently drops dimnames - and we fix at R level;
637 : maechler 1375
638 : mmaechler 2661 return chm_sparse_to_SEXP(cholmod_vertcat(chx, chy, 1, &c),
639 : maechler 1960 1, 0, Rkind, "", R_NilValue);
640 : bates 1218 }
641 : bates 1265
642 :     SEXP Csparse_band(SEXP x, SEXP k1, SEXP k2)
643 :     {
644 : mmaechler 2223 CHM_SP chx = AS_CHM_SP__(x);
645 : maechler 1736 int Rkind = (chx->xtype != CHOLMOD_PATTERN) ? Real_kind(x) : 0;
646 : mmaechler 2661 CHM_SP ans = cholmod_band(chx, asInteger(k1), asInteger(k2), chx->xtype, &c);
647 : maechler 1960 R_CheckStack();
648 : bates 1265
649 : maechler 1736 return chm_sparse_to_SEXP(ans, 1, 0, Rkind, "",
650 :     GET_SLOT(x, Matrix_DimNamesSym));
651 : bates 1265 }
652 : bates 1366
653 :     SEXP Csparse_diagU2N(SEXP x)
654 :     {
655 : maechler 2120 const char *cl = class_P(x);
656 :     /* dtCMatrix, etc; [1] = the second character =?= 't' for triangular */
657 :     if (cl[1] != 't' || *diag_P(x) != 'U') {
658 : maechler 2125 /* "trivially fast" when not triangular (<==> no 'diag' slot),
659 :     or not *unit* triangular */
660 : maechler 1708 return (x);
661 :     }
662 : maechler 2125 else { /* unit triangular (diag='U'): "fill the diagonal" & diag:= "N" */
663 : mmaechler 2223 CHM_SP chx = AS_CHM_SP__(x);
664 : mmaechler 2661 CHM_SP eye = cholmod_speye(chx->nrow, chx->ncol, chx->xtype, &c);
665 : maechler 1708 double one[] = {1, 0};
666 : mmaechler 2661 CHM_SP ans = cholmod_add(chx, eye, one, one, TRUE, TRUE, &c);
667 : maechler 1710 int uploT = (*uplo_P(x) == 'U') ? 1 : -1;
668 : maechler 1736 int Rkind = (chx->xtype != CHOLMOD_PATTERN) ? Real_kind(x) : 0;
669 : bates 1366
670 : maechler 1960 R_CheckStack();
671 : mmaechler 2661 cholmod_free_sparse(&eye, &c);
672 : maechler 1708 return chm_sparse_to_SEXP(ans, 1, uploT, Rkind, "N",
673 : maechler 1736 GET_SLOT(x, Matrix_DimNamesSym));
674 : maechler 1708 }
675 : bates 1366 }
676 :    
677 : maechler 2125 SEXP Csparse_diagN2U(SEXP x)
678 :     {
679 :     const char *cl = class_P(x);
680 :     /* dtCMatrix, etc; [1] = the second character =?= 't' for triangular */
681 :     if (cl[1] != 't' || *diag_P(x) != 'N') {
682 :     /* "trivially fast" when not triangular (<==> no 'diag' slot),
683 :     or already *unit* triangular */
684 :     return (x);
685 :     }
686 :     else { /* triangular with diag='N'): now drop the diagonal */
687 :     /* duplicate, since chx will be modified: */
688 : mmaechler 2772 SEXP xx = PROTECT(duplicate(x));
689 :     CHM_SP chx = AS_CHM_SP__(xx);
690 : maechler 2125 int uploT = (*uplo_P(x) == 'U') ? 1 : -1,
691 :     Rkind = (chx->xtype != CHOLMOD_PATTERN) ? Real_kind(x) : 0;
692 :     R_CheckStack();
693 :    
694 :     chm_diagN2U(chx, uploT, /* do_realloc */ FALSE);
695 :    
696 : mmaechler 2834 SEXP ans = chm_sparse_to_SEXP(chx, /*dofree*/ 0/* or 1 ?? */,
697 :     uploT, Rkind, "U",
698 :     GET_SLOT(x, Matrix_DimNamesSym));
699 :     UNPROTECT(1);// only now !
700 :     return ans;
701 : maechler 2125 }
702 :     }
703 :    
704 : mmaechler 2519 /**
705 :     * "Indexing" aka subsetting : Compute x[i,j], also for vectors i and j
706 :     * Working via CHOLMOD_submatrix, see ./CHOLMOD/MatrixOps/cholmod_submatrix.c
707 :     * @param x CsparseMatrix
708 :     * @param i row indices (0-origin), or NULL (R's)
709 :     * @param j columns indices (0-origin), or NULL
710 :     *
711 :     * @return x[i,j] still CsparseMatrix --- currently, this loses dimnames
712 :     */
713 : bates 1366 SEXP Csparse_submatrix(SEXP x, SEXP i, SEXP j)
714 :     {
715 : mmaechler 2519 CHM_SP chx = AS_CHM_SP(x); /* << does diagU2N() when needed */
716 : bates 1366 int rsize = (isNull(i)) ? -1 : LENGTH(i),
717 :     csize = (isNull(j)) ? -1 : LENGTH(j);
718 : maechler 1736 int Rkind = (chx->xtype != CHOLMOD_PATTERN) ? Real_kind(x) : 0;
719 : maechler 1960 R_CheckStack();
720 : bates 1366
721 :     if (rsize >= 0 && !isInteger(i))
722 :     error(_("Index i must be NULL or integer"));
723 :     if (csize >= 0 && !isInteger(j))
724 :     error(_("Index j must be NULL or integer"));
725 : maechler 1736
726 : mmaechler 3011 #define CHM_SUB(_M_, _i_, _j_) \
727 :     cholmod_submatrix(_M_, \
728 :     (rsize < 0) ? NULL : INTEGER(_i_), rsize, \
729 :     (csize < 0) ? NULL : INTEGER(_j_), csize, \
730 :     TRUE, TRUE, &c)
731 :     CHM_SP ans;
732 : dmbates 2731 if (!chx->stype) {/* non-symmetric Matrix */
733 : mmaechler 3011 ans = CHM_SUB(chx, i, j);
734 : dmbates 2731 }
735 : mmaechler 3011 else {
736 :     /* for now, cholmod_submatrix() only accepts "generalMatrix" */
737 :     CHM_SP tmp = cholmod_copy(chx, /* stype: */ 0, chx->xtype, &c);
738 :     ans = CHM_SUB(tmp, i, j);
739 :     cholmod_free_sparse(&tmp, &c);
740 :     }
741 : mmaechler 3018
742 : mmaechler 3011 // "FIXME": currently dropping dimnames, and adding them afterwards in R :
743 : mmaechler 3018 /* // dimnames: */
744 :     /* SEXP x_dns = GET_SLOT(x, Matrix_DimNamesSym), */
745 :     /* dn = PROTECT(allocVector(VECSXP, 2)); */
746 : mmaechler 3011 return chm_sparse_to_SEXP(ans, 1, 0, Rkind, "", /* dimnames: */ R_NilValue);
747 : bates 1366 }
748 : bates 2049
749 : mmaechler 2684 #define _d_Csp_
750 :     #include "t_Csparse_subassign.c"
751 : mmaechler 2661
752 : mmaechler 2684 #define _l_Csp_
753 :     #include "t_Csparse_subassign.c"
754 : mmaechler 2661
755 : mmaechler 2684 #define _i_Csp_
756 :     #include "t_Csparse_subassign.c"
757 : mmaechler 2661
758 : mmaechler 2684 #define _n_Csp_
759 :     #include "t_Csparse_subassign.c"
760 : mmaechler 2677
761 : mmaechler 2684 #define _z_Csp_
762 :     #include "t_Csparse_subassign.c"
763 : mmaechler 2677
764 : mmaechler 2661
765 : mmaechler 2677
766 : bates 2049 SEXP Csparse_MatrixMarket(SEXP x, SEXP fname)
767 :     {
768 :     FILE *f = fopen(CHAR(asChar(fname)), "w");
769 :    
770 :     if (!f)
771 :     error(_("failure to open file \"%s\" for writing"),
772 :     CHAR(asChar(fname)));
773 : mmaechler 2661 if (!cholmod_write_sparse(f, AS_CHM_SP(x),
774 : maechler 2120 (CHM_SP)NULL, (char*) NULL, &c))
775 : mmaechler 2661 error(_("cholmod_write_sparse returned error code"));
776 : bates 2049 fclose(f);
777 :     return R_NilValue;
778 :     }
779 : maechler 2137
780 :    
781 :     /**
782 :     * Extract the diagonal entries from *triangular* Csparse matrix __or__ a
783 :     * cholmod_sparse factor (LDL = TRUE).
784 :     *
785 :     * @param n dimension of the matrix.
786 :     * @param x_p 'p' (column pointer) slot contents
787 :     * @param x_x 'x' (non-zero entries) slot contents
788 : mmaechler 2175 * @param perm 'perm' (= permutation vector) slot contents; only used for "diagBack"
789 : maechler 2137 * @param resultKind a (SEXP) string indicating which kind of result is desired.
790 :     *
791 :     * @return a SEXP, either a (double) number or a length n-vector of diagonal entries
792 :     */
793 : mmaechler 2984 SEXP diag_tC_ptr(int n, int *x_p, double *x_x, Rboolean is_U, int *perm,
794 : maechler 2137 /* ^^^^^^ FIXME[Generalize] to int / ... */
795 : mmaechler 2984 SEXP resultKind)
796 : maechler 2137 {
797 :     const char* res_ch = CHAR(STRING_ELT(resultKind,0));
798 : mmaechler 2984 enum diag_kind { diag, diag_backpermuted, trace, prod, sum_log, min, max, range
799 : maechler 2137 } res_kind = ((!strcmp(res_ch, "trace")) ? trace :
800 :     ((!strcmp(res_ch, "sumLog")) ? sum_log :
801 :     ((!strcmp(res_ch, "prod")) ? prod :
802 : mmaechler 2984 ((!strcmp(res_ch, "min")) ? min :
803 :     ((!strcmp(res_ch, "max")) ? max :
804 :     ((!strcmp(res_ch, "range")) ? range :
805 :     ((!strcmp(res_ch, "diag")) ? diag :
806 :     ((!strcmp(res_ch, "diagBack")) ? diag_backpermuted :
807 :     -1))))))));
808 :     int i, n_x, i_from;
809 : maechler 2137 SEXP ans = PROTECT(allocVector(REALSXP,
810 :     /* ^^^^ FIXME[Generalize] */
811 :     (res_kind == diag ||
812 : mmaechler 2984 res_kind == diag_backpermuted) ? n :
813 :     (res_kind == range ? 2 : 1)));
814 : maechler 2137 double *v = REAL(ans);
815 :     /* ^^^^^^ ^^^^ FIXME[Generalize] */
816 :    
817 : mmaechler 2984 i_from = (is_U ? -1 : 0);
818 :    
819 : mmaechler 2784 #define for_DIAG(v_ASSIGN) \
820 : mmaechler 2984 for(i = 0; i < n; i++) { \
821 : mmaechler 2784 /* looking at i-th column */ \
822 : maechler 2137 n_x = x_p[i+1] - x_p[i];/* #{entries} in this column */ \
823 : mmaechler 2984 if( is_U) i_from += n_x; \
824 : mmaechler 2784 v_ASSIGN; \
825 : mmaechler 2984 if(!is_U) i_from += n_x; \
826 : maechler 2137 }
827 :    
828 :     /* NOTA BENE: we assume -- uplo = "L" i.e. lower triangular matrix
829 :     * for uplo = "U" (makes sense with a "dtCMatrix" !),
830 : mmaechler 2984 * should use x_x[i_from + (n_x - 1)] instead of x_x[i_from],
831 :     * where n_x = (x_p[i+1] - x_p[i])
832 : maechler 2137 */
833 :    
834 :     switch(res_kind) {
835 : mmaechler 2984 case trace: // = sum
836 : maechler 2137 v[0] = 0.;
837 :     for_DIAG(v[0] += x_x[i_from]);
838 :     break;
839 :    
840 :     case sum_log:
841 :     v[0] = 0.;
842 :     for_DIAG(v[0] += log(x_x[i_from]));
843 :     break;
844 :    
845 :     case prod:
846 :     v[0] = 1.;
847 :     for_DIAG(v[0] *= x_x[i_from]);
848 :     break;
849 :    
850 : mmaechler 2984 case min:
851 :     v[0] = R_PosInf;
852 :     for_DIAG(if(v[0] > x_x[i_from]) v[0] = x_x[i_from]);
853 :     break;
854 :    
855 :     case max:
856 :     v[0] = R_NegInf;
857 :     for_DIAG(if(v[0] < x_x[i_from]) v[0] = x_x[i_from]);
858 :     break;
859 :    
860 :     case range:
861 :     v[0] = R_PosInf;
862 :     v[1] = R_NegInf;
863 :     for_DIAG(if(v[0] > x_x[i_from]) v[0] = x_x[i_from];
864 :     if(v[1] < x_x[i_from]) v[1] = x_x[i_from]);
865 :     break;
866 :    
867 : maechler 2137 case diag:
868 :     for_DIAG(v[i] = x_x[i_from]);
869 :     break;
870 :    
871 :     case diag_backpermuted:
872 :     for_DIAG(v[i] = x_x[i_from]);
873 :    
874 : mmaechler 2784 warning(_("%s = '%s' (back-permuted) is experimental"),
875 :     "resultKind", "diagBack");
876 : maechler 2144 /* now back_permute : */
877 :     for(i = 0; i < n; i++) {
878 :     double tmp = v[i]; v[i] = v[perm[i]]; v[perm[i]] = tmp;
879 :     /*^^^^ FIXME[Generalize] */
880 :     }
881 : maechler 2137 break;
882 :    
883 :     default: /* -1 from above */
884 : mmaechler 2387 error(_("diag_tC(): invalid 'resultKind'"));
885 : maechler 2137 /* Wall: */ ans = R_NilValue; v = REAL(ans);
886 :     }
887 :    
888 :     UNPROTECT(1);
889 :     return ans;
890 :     }
891 :    
892 :     /**
893 :     * Extract the diagonal entries from *triangular* Csparse matrix __or__ a
894 :     * cholmod_sparse factor (LDL = TRUE).
895 :     *
896 : mmaechler 2984 * @param obj -- now a cholmod_sparse factor or a dtCMatrix
897 : maechler 2137 * @param pslot 'p' (column pointer) slot of Csparse matrix/factor
898 :     * @param xslot 'x' (non-zero entries) slot of Csparse matrix/factor
899 : mmaechler 2175 * @param perm_slot 'perm' (= permutation vector) slot of corresponding CHMfactor;
900 :     * only used for "diagBack"
901 : maechler 2137 * @param resultKind a (SEXP) string indicating which kind of result is desired.
902 :     *
903 :     * @return a SEXP, either a (double) number or a length n-vector of diagonal entries
904 :     */
905 : mmaechler 2984 SEXP diag_tC(SEXP obj, SEXP resultKind)
906 : maechler 2137 {
907 : mmaechler 2984
908 :     SEXP
909 :     pslot = GET_SLOT(obj, Matrix_pSym),
910 :     xslot = GET_SLOT(obj, Matrix_xSym);
911 :     Rboolean is_U = (R_has_slot(obj, Matrix_uploSym) &&
912 :     *CHAR(asChar(GET_SLOT(obj, Matrix_uploSym))) == 'U');
913 : maechler 2137 int n = length(pslot) - 1, /* n = ncol(.) = nrow(.) */
914 : mmaechler 2984 *x_p = INTEGER(pslot), pp = -1, *perm;
915 : maechler 2137 double *x_x = REAL(xslot);
916 :     /* ^^^^^^ ^^^^ FIXME[Generalize] to INTEGER(.) / LOGICAL(.) / ... xslot !*/
917 :    
918 : mmaechler 2984 if(R_has_slot(obj, Matrix_permSym))
919 :     perm = INTEGER(GET_SLOT(obj, Matrix_permSym));
920 :     else perm = &pp;
921 :    
922 :     return diag_tC_ptr(n, x_p, x_x, is_U, perm, resultKind);
923 : maechler 2137 }
924 : dmbates 2319
925 : mmaechler 2984
926 : dmbates 2319 /**
927 :     * Create a Csparse matrix object from indices and/or pointers.
928 :     *
929 :     * @param cls name of actual class of object to create
930 :     * @param i optional integer vector of length nnz of row indices
931 :     * @param j optional integer vector of length nnz of column indices
932 :     * @param p optional integer vector of length np of row or column pointers
933 :     * @param np length of integer vector p. Must be zero if p == (int*)NULL
934 :     * @param x optional vector of values
935 :     * @param nnz length of vectors i, j and/or x, whichever is to be used
936 :     * @param dims optional integer vector of length 2 to be used as
937 :     * dimensions. If dims == (int*)NULL then the maximum row and column
938 :     * index are used as the dimensions.
939 :     * @param dimnames optional list of length 2 to be used as dimnames
940 :     * @param index1 indicator of 1-based indices
941 :     *
942 :     * @return an SEXP of class cls inheriting from CsparseMatrix.
943 :     */
944 :     SEXP create_Csparse(char* cls, int* i, int* j, int* p, int np,
945 :     void* x, int nnz, int* dims, SEXP dimnames,
946 :     int index1)
947 :     {
948 :     SEXP ans;
949 :     int *ij = (int*)NULL, *tri, *trj,
950 :     mi, mj, mp, nrow = -1, ncol = -1;
951 :     int xtype = -1; /* -Wall */
952 :     CHM_TR T;
953 :     CHM_SP A;
954 :    
955 :     if (np < 0 || nnz < 0)
956 :     error(_("negative vector lengths not allowed: np = %d, nnz = %d"),
957 :     np, nnz);
958 :     if (1 != ((mi = (i == (int*)NULL)) +
959 :     (mj = (j == (int*)NULL)) +
960 :     (mp = (p == (int*)NULL))))
961 :     error(_("exactly 1 of 'i', 'j' or 'p' must be NULL"));
962 :     if (mp) {
963 :     if (np) error(_("np = %d, must be zero when p is NULL"), np);
964 :     } else {
965 :     if (np) { /* Expand p to form i or j */
966 :     if (!(p[0])) error(_("p[0] = %d, should be zero"), p[0]);
967 :     for (int ii = 0; ii < np; ii++)
968 :     if (p[ii] > p[ii + 1])
969 :     error(_("p must be non-decreasing"));
970 :     if (p[np] != nnz)
971 : mmaechler 2387 error("p[np] = %d != nnz = %d", p[np], nnz);
972 : dmbates 2319 ij = Calloc(nnz, int);
973 :     if (mi) {
974 :     i = ij;
975 :     nrow = np;
976 :     } else {
977 :     j = ij;
978 :     ncol = np;
979 :     }
980 : mmaechler 2661 /* Expand p to 0-based indices */
981 : dmbates 2319 for (int ii = 0; ii < np; ii++)
982 :     for (int jj = p[ii]; jj < p[ii + 1]; jj++) ij[jj] = ii;
983 :     } else {
984 :     if (nnz)
985 :     error(_("Inconsistent dimensions: np = 0 and nnz = %d"),
986 :     nnz);
987 :     }
988 :     }
989 : mmaechler 2661 /* calculate nrow and ncol */
990 : dmbates 2319 if (nrow < 0) {
991 :     for (int ii = 0; ii < nnz; ii++) {
992 :     int i1 = i[ii] + (index1 ? 0 : 1); /* 1-based index */
993 :     if (i1 < 1) error(_("invalid row index at position %d"), ii);
994 :     if (i1 > nrow) nrow = i1;
995 :     }
996 :     }
997 :     if (ncol < 0) {
998 :     for (int jj = 0; jj < nnz; jj++) {
999 :     int j1 = j[jj] + (index1 ? 0 : 1);
1000 : mmaechler 2387 if (j1 < 1) error(_("invalid column index at position %d"), jj);
1001 : dmbates 2319 if (j1 > ncol) ncol = j1;
1002 :     }
1003 :     }
1004 :     if (dims != (int*)NULL) {
1005 :     if (dims[0] > nrow) nrow = dims[0];
1006 :     if (dims[1] > ncol) ncol = dims[1];
1007 :     }
1008 : mmaechler 2661 /* check the class name */
1009 : dmbates 2319 if (strlen(cls) != 8)
1010 :     error(_("strlen of cls argument = %d, should be 8"), strlen(cls));
1011 :     if (!strcmp(cls + 2, "CMatrix"))
1012 :     error(_("cls = \"%s\" does not end in \"CMatrix\""), cls);
1013 :     switch(cls[0]) {
1014 :     case 'd':
1015 :     case 'l':
1016 : mmaechler 2661 xtype = CHOLMOD_REAL;
1017 :     break;
1018 : dmbates 2319 case 'n':
1019 : mmaechler 2661 xtype = CHOLMOD_PATTERN;
1020 :     break;
1021 : dmbates 2319 default:
1022 : mmaechler 2661 error(_("cls = \"%s\" must begin with 'd', 'l' or 'n'"), cls);
1023 : dmbates 2319 }
1024 :     if (cls[1] != 'g')
1025 :     error(_("Only 'g'eneral sparse matrix types allowed"));
1026 : mmaechler 2661 /* allocate and populate the triplet */
1027 :     T = cholmod_allocate_triplet((size_t)nrow, (size_t)ncol, (size_t)nnz, 0,
1028 :     xtype, &c);
1029 : dmbates 2319 T->x = x;
1030 :     tri = (int*)T->i;
1031 :     trj = (int*)T->j;
1032 :     for (int ii = 0; ii < nnz; ii++) {
1033 :     tri[ii] = i[ii] - ((!mi && index1) ? 1 : 0);
1034 :     trj[ii] = j[ii] - ((!mj && index1) ? 1 : 0);
1035 :     }
1036 : mmaechler 2661 /* create the cholmod_sparse structure */
1037 :     A = cholmod_triplet_to_sparse(T, nnz, &c);
1038 :     cholmod_free_triplet(&T, &c);
1039 :     /* copy the information to the SEXP */
1040 : dmbates 2319 ans = PROTECT(NEW_OBJECT(MAKE_CLASS(cls)));
1041 : mmaechler 3055 // FIXME: This has been copied from chm_sparse_to_SEXP in chm_common.c
1042 : mmaechler 2661 /* allocate and copy common slots */
1043 :     nnz = cholmod_nnz(A, &c);
1044 : dmbates 2319 dims = INTEGER(ALLOC_SLOT(ans, Matrix_DimSym, INTSXP, 2));
1045 :     dims[0] = A->nrow; dims[1] = A->ncol;
1046 :     Memcpy(INTEGER(ALLOC_SLOT(ans, Matrix_pSym, INTSXP, A->ncol + 1)), (int*)A->p, A->ncol + 1);
1047 :     Memcpy(INTEGER(ALLOC_SLOT(ans, Matrix_iSym, INTSXP, nnz)), (int*)A->i, nnz);
1048 :     switch(cls[1]) {
1049 :     case 'd':
1050 :     Memcpy(REAL(ALLOC_SLOT(ans, Matrix_xSym, REALSXP, nnz)), (double*)A->x, nnz);
1051 :     break;
1052 :     case 'l':
1053 :     error(_("code not yet written for cls = \"lgCMatrix\""));
1054 :     }
1055 : mmaechler 2646 /* FIXME: dimnames are *NOT* put there yet (if non-NULL) */
1056 : mmaechler 2661 cholmod_free_sparse(&A, &c);
1057 : dmbates 2319 UNPROTECT(1);
1058 :     return ans;
1059 :     }

R-Forge@R-project.org
ViewVC Help
Powered by ViewVC 1.0.0  
Thanks to:
Vienna University of Economics and Business University of Wisconsin - Madison Powered By FusionForge