SCM

SCM Repository

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

Annotation of /pkg/src/Csparse.c

Parent Directory Parent Directory | Revision Log Revision Log


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

1 : bates 1218 /* Sparse matrices in compressed column-oriented form */
2 : bates 922 #include "Csparse.h"
3 :     #include "chm_common.h"
4 :    
5 :     SEXP Csparse_validate(SEXP x)
6 :     {
7 : maechler 1575 /* NB: we do *NOT* check a potential 'x' slot here, at all */
8 : bates 922 SEXP pslot = GET_SLOT(x, Matrix_pSym),
9 :     islot = GET_SLOT(x, Matrix_iSym);
10 : maechler 1893 Rboolean sorted, strictly;
11 :     int j, k,
12 : bates 922 *dims = INTEGER(GET_SLOT(x, Matrix_DimSym)),
13 : maechler 1660 nrow = dims[0],
14 :     ncol = dims[1],
15 : maechler 1654 *xp = INTEGER(pslot),
16 : bates 922 *xi = INTEGER(islot);
17 :    
18 : maechler 1654 if (length(pslot) != dims[1] + 1)
19 :     return mkString(_("slot p must have length = ncol(.) + 1"));
20 : bates 922 if (xp[0] != 0)
21 :     return mkString(_("first element of slot p must be zero"));
22 : maechler 1893 if (length(islot) < xp[ncol]) /* allow larger slots from over-allocation!*/
23 : bates 1555 return
24 :     mkString(_("last element of slot p must match length of slots i and x"));
25 :     for (j = 0; j < length(islot); j++) {
26 :     if (xi[j] < 0 || xi[j] >= nrow)
27 :     return mkString(_("all row indices must be between 0 and nrow-1"));
28 :     }
29 : maechler 1893 sorted = TRUE; strictly = TRUE;
30 : bates 922 for (j = 0; j < ncol; j++) {
31 :     if (xp[j] > xp[j+1])
32 :     return mkString(_("slot p must be non-decreasing"));
33 : maechler 1893 if(sorted)
34 :     for (k = xp[j] + 1; k < xp[j + 1]; k++) {
35 :     if (xi[k] < xi[k - 1])
36 :     sorted = FALSE;
37 :     else if (xi[k] == xi[k - 1])
38 :     strictly = FALSE;
39 :     }
40 : bates 922 }
41 : maechler 1654 if (!sorted) {
42 : maechler 1960 CHM_SP chx = AS_CHM_SP(x);
43 :     R_CheckStack();
44 :    
45 : maechler 1654 cholmod_sort(chx, &c);
46 : maechler 1893 /* Now re-check that row indices are *strictly* increasing
47 :     * (and not just increasing) within each column : */
48 :     for (j = 0; j < ncol; j++) {
49 :     for (k = xp[j] + 1; k < xp[j + 1]; k++)
50 :     if (xi[k] == xi[k - 1])
51 :     return mkString(_("slot i is not *strictly* increasing inside a column (even after cholmod_sort)"));
52 :     }
53 :    
54 :     } else if(!strictly) { /* sorted, but not strictly */
55 :     return mkString(_("slot i is not *strictly* increasing inside a column"));
56 : maechler 1654 }
57 : bates 922 return ScalarLogical(1);
58 :     }
59 :    
60 : maechler 1968 SEXP Rsparse_validate(SEXP x)
61 :     {
62 :     /* NB: we do *NOT* check a potential 'x' slot here, at all */
63 :     SEXP pslot = GET_SLOT(x, Matrix_pSym),
64 :     jslot = GET_SLOT(x, Matrix_jSym);
65 :     Rboolean sorted, strictly;
66 :     int i, k,
67 :     *dims = INTEGER(GET_SLOT(x, Matrix_DimSym)),
68 :     nrow = dims[0],
69 :     ncol = dims[1],
70 :     *xp = INTEGER(pslot),
71 :     *xj = INTEGER(jslot);
72 :    
73 :     if (length(pslot) != dims[0] + 1)
74 :     return mkString(_("slot p must have length = nrow(.) + 1"));
75 :     if (xp[0] != 0)
76 :     return mkString(_("first element of slot p must be zero"));
77 :     if (length(jslot) < xp[nrow]) /* allow larger slots from over-allocation!*/
78 :     return
79 :     mkString(_("last element of slot p must match length of slots j and x"));
80 :     for (i = 0; i < length(jslot); i++) {
81 :     if (xj[i] < 0 || xj[i] >= ncol)
82 :     return mkString(_("all column indices must be between 0 and ncol-1"));
83 :     }
84 :     sorted = TRUE; strictly = TRUE;
85 :     for (i = 0; i < nrow; i++) {
86 :     if (xp[i] > xp[i+1])
87 :     return mkString(_("slot p must be non-decreasing"));
88 :     if(sorted)
89 :     for (k = xp[i] + 1; k < xp[i + 1]; k++) {
90 :     if (xj[k] < xj[k - 1])
91 :     sorted = FALSE;
92 :     else if (xj[k] == xj[k - 1])
93 :     strictly = FALSE;
94 :     }
95 :     }
96 :     if (!sorted)
97 :     /* cannot easily use cholmod_sort(.) ... -> "error out" :*/
98 :     return mkString(_("slot j is not increasing inside a column"));
99 :     else if(!strictly) /* sorted, but not strictly */
100 :     return mkString(_("slot j is not *strictly* increasing inside a column"));
101 :    
102 :     return ScalarLogical(1);
103 :     }
104 :    
105 :    
106 : maechler 1751 /* Called from ../R/Csparse.R : */
107 :     /* Can only return [dln]geMatrix (no symm/triang);
108 :     * FIXME: replace by non-CHOLMOD code ! */
109 : bates 1059 SEXP Csparse_to_dense(SEXP x)
110 :     {
111 : maechler 1960 CHM_SP chxs = AS_CHM_SP(x);
112 : maechler 1751 /* This loses the symmetry property, since cholmod_dense has none,
113 :     * BUT, much worse (FIXME!), it also transforms CHOLMOD_PATTERN ("n") matrices
114 :     * to numeric (CHOLMOD_REAL) ones : */
115 : maechler 1960 CHM_DN chxd = cholmod_sparse_to_dense(chxs, &c);
116 : maechler 1751 int Rkind = (chxs->xtype == CHOLMOD_PATTERN)? -1 : Real_kind(x);
117 : maechler 1960 R_CheckStack();
118 : bates 1059
119 : maechler 1736 return chm_dense_to_SEXP(chxd, 1, Rkind, GET_SLOT(x, Matrix_DimNamesSym));
120 : bates 1059 }
121 :    
122 : maechler 1548 SEXP Csparse_to_nz_pattern(SEXP x, SEXP tri)
123 : bates 1371 {
124 : maechler 1960 CHM_SP chxs = AS_CHM_SP(x);
125 :     CHM_SP chxcp = cholmod_copy(chxs, chxs->stype, CHOLMOD_PATTERN, &c);
126 : bates 1867 int tr = asLogical(tri);
127 : maechler 1960 R_CheckStack();
128 : bates 1371
129 : maechler 1960 return chm_sparse_to_SEXP(chxcp, 1/*do_free*/,
130 : bates 1867 tr ? ((*uplo_P(x) == 'U') ? 1 : -1) : 0,
131 :     0, tr ? diag_P(x) : "",
132 : maechler 1548 GET_SLOT(x, Matrix_DimNamesSym));
133 : bates 1371 }
134 :    
135 : bates 1366 SEXP Csparse_to_matrix(SEXP x)
136 : bates 922 {
137 : maechler 1960 return chm_dense_to_matrix(cholmod_sparse_to_dense(AS_CHM_SP(x), &c),
138 :     1 /*do_free*/, GET_SLOT(x, Matrix_DimNamesSym));
139 : bates 1366 }
140 :    
141 :     SEXP Csparse_to_Tsparse(SEXP x, SEXP tri)
142 :     {
143 : maechler 1960 CHM_SP chxs = AS_CHM_SP(x);
144 :     CHM_TR chxt = cholmod_sparse_to_triplet(chxs, &c);
145 : bates 1867 int tr = asLogical(tri);
146 : maechler 1736 int Rkind = (chxs->xtype != CHOLMOD_PATTERN) ? Real_kind(x) : 0;
147 : maechler 1960 R_CheckStack();
148 : bates 922
149 : bates 1867 return chm_triplet_to_SEXP(chxt, 1,
150 :     tr ? ((*uplo_P(x) == 'U') ? 1 : -1) : 0,
151 :     Rkind, tr ? diag_P(x) : "",
152 : bates 1371 GET_SLOT(x, Matrix_DimNamesSym));
153 : bates 922 }
154 :    
155 : bates 1448 /* this used to be called sCMatrix_to_gCMatrix(..) [in ./dsCMatrix.c ]: */
156 : bates 1371 SEXP Csparse_symmetric_to_general(SEXP x)
157 :     {
158 : maechler 1960 CHM_SP chx = AS_CHM_SP(x), chgx;
159 : maechler 1736 int Rkind = (chx->xtype != CHOLMOD_PATTERN) ? Real_kind(x) : 0;
160 : maechler 1960 R_CheckStack();
161 : bates 1371
162 :     if (!(chx->stype))
163 : maechler 1548 error(_("Nonsymmetric matrix in Csparse_symmetric_to_general"));
164 : maechler 1375 chgx = cholmod_copy(chx, /* stype: */ 0, chx->xtype, &c);
165 :     /* xtype: pattern, "real", complex or .. */
166 : maechler 1548 return chm_sparse_to_SEXP(chgx, 1, 0, Rkind, "",
167 : bates 1371 GET_SLOT(x, Matrix_DimNamesSym));
168 :     }
169 :    
170 : maechler 1618 SEXP Csparse_general_to_symmetric(SEXP x, SEXP uplo)
171 : maechler 1598 {
172 : maechler 1960 CHM_SP chx = AS_CHM_SP(x), chgx;
173 : maechler 1710 int uploT = (*CHAR(asChar(uplo)) == 'U') ? 1 : -1;
174 : maechler 1736 int Rkind = (chx->xtype != CHOLMOD_PATTERN) ? Real_kind(x) : 0;
175 : maechler 1960 R_CheckStack();
176 : maechler 1598
177 : maechler 1618 chgx = cholmod_copy(chx, /* stype: */ uploT, chx->xtype, &c);
178 : maechler 1598 /* xtype: pattern, "real", complex or .. */
179 :     return chm_sparse_to_SEXP(chgx, 1, 0, Rkind, "",
180 :     GET_SLOT(x, Matrix_DimNamesSym));
181 :     }
182 :    
183 : bates 1369 SEXP Csparse_transpose(SEXP x, SEXP tri)
184 : bates 922 {
185 : maechler 1921 /* TODO: lgCMatrix & igC* currently go via double prec. cholmod -
186 :     * since cholmod (& cs) lacks sparse 'int' matrices */
187 : maechler 1960 CHM_SP chx = AS_CHM_SP(x);
188 : maechler 1736 int Rkind = (chx->xtype != CHOLMOD_PATTERN) ? Real_kind(x) : 0;
189 : maechler 1960 CHM_SP chxt = cholmod_transpose(chx, chx->xtype, &c);
190 : bates 1366 SEXP dn = PROTECT(duplicate(GET_SLOT(x, Matrix_DimNamesSym))), tmp;
191 : bates 1867 int tr = asLogical(tri);
192 : maechler 1960 R_CheckStack();
193 : bates 1369
194 : bates 1366 tmp = VECTOR_ELT(dn, 0); /* swap the dimnames */
195 :     SET_VECTOR_ELT(dn, 0, VECTOR_ELT(dn, 1));
196 :     SET_VECTOR_ELT(dn, 1, tmp);
197 :     UNPROTECT(1);
198 : bates 1867 return chm_sparse_to_SEXP(chxt, 1, /* SWAP 'uplo' for triangular */
199 :     tr ? ((*uplo_P(x) == 'U') ? -1 : 1) : 0,
200 :     Rkind, tr ? diag_P(x) : "", dn);
201 : bates 922 }
202 :    
203 :     SEXP Csparse_Csparse_prod(SEXP a, SEXP b)
204 :     {
205 : maechler 1960 CHM_SP cha = AS_CHM_SP(a), chb = AS_CHM_SP(b);
206 :     CHM_SP chc = cholmod_ssmult(cha, chb, 0, cha->xtype, 1, &c);
207 : bates 1366 SEXP dn = allocVector(VECSXP, 2);
208 : maechler 1960 R_CheckStack();
209 : bates 922
210 : bates 1366 SET_VECTOR_ELT(dn, 0, /* establish dimnames */
211 :     duplicate(VECTOR_ELT(GET_SLOT(a, Matrix_DimNamesSym), 0)));
212 :     SET_VECTOR_ELT(dn, 1,
213 :     duplicate(VECTOR_ELT(GET_SLOT(b, Matrix_DimNamesSym), 1)));
214 : maechler 1548 return chm_sparse_to_SEXP(chc, 1, 0, 0, "", dn);
215 : bates 922 }
216 :    
217 : maechler 1659 SEXP Csparse_Csparse_crossprod(SEXP a, SEXP b, SEXP trans)
218 : bates 1657 {
219 : maechler 1659 int tr = asLogical(trans);
220 : maechler 1960 CHM_SP cha = AS_CHM_SP(a), chb = AS_CHM_SP(b), chTr, chc;
221 : bates 1657 SEXP dn = allocVector(VECSXP, 2);
222 : maechler 1960 R_CheckStack();
223 : bates 1657
224 : maechler 1960 chTr = cholmod_transpose((tr) ? chb : cha, chb->xtype, &c);
225 : maechler 1659 chc = cholmod_ssmult((tr) ? cha : chTr, (tr) ? chTr : chb,
226 :     0, cha->xtype, 1, &c);
227 : maechler 1960 cholmod_free_sparse(&chTr, &c);
228 : maechler 1659
229 : bates 1657 SET_VECTOR_ELT(dn, 0, /* establish dimnames */
230 : maechler 1659 duplicate(VECTOR_ELT(GET_SLOT(a, Matrix_DimNamesSym), (tr) ? 0 : 1)));
231 : bates 1657 SET_VECTOR_ELT(dn, 1,
232 : maechler 1659 duplicate(VECTOR_ELT(GET_SLOT(b, Matrix_DimNamesSym), (tr) ? 0 : 1)));
233 : bates 1657 return chm_sparse_to_SEXP(chc, 1, 0, 0, "", dn);
234 :     }
235 :    
236 : bates 922 SEXP Csparse_dense_prod(SEXP a, SEXP b)
237 :     {
238 : maechler 1960 CHM_SP cha = AS_CHM_SP(a);
239 : maechler 1660 SEXP b_M = PROTECT(mMatrix_as_dgeMatrix(b));
240 : maechler 1960 CHM_DN chb = AS_CHM_DN(b_M);
241 :     CHM_DN chc = cholmod_allocate_dense(cha->nrow, chb->ncol, cha->nrow,
242 :     chb->xtype, &c);
243 :     SEXP dn = PROTECT(allocVector(VECSXP, 2));
244 :     double one[] = {1,0}, zero[] = {0,0};
245 :     R_CheckStack();
246 : bates 922
247 : maechler 1960 cholmod_sdmult(cha, 0, one, zero, chb, chc, &c);
248 : maechler 1660 SET_VECTOR_ELT(dn, 0, /* establish dimnames */
249 :     duplicate(VECTOR_ELT(GET_SLOT(a, Matrix_DimNamesSym), 0)));
250 :     SET_VECTOR_ELT(dn, 1,
251 :     duplicate(VECTOR_ELT(GET_SLOT(b_M, Matrix_DimNamesSym), 1)));
252 : maechler 1960 UNPROTECT(2);
253 : maechler 1660 return chm_dense_to_SEXP(chc, 1, 0, dn);
254 : bates 922 }
255 : maechler 925
256 : bates 1067 SEXP Csparse_dense_crossprod(SEXP a, SEXP b)
257 :     {
258 : maechler 1960 CHM_SP cha = AS_CHM_SP(a);
259 : maechler 1660 SEXP b_M = PROTECT(mMatrix_as_dgeMatrix(b));
260 : maechler 1960 CHM_DN chb = AS_CHM_DN(b_M);
261 :     CHM_DN chc = cholmod_allocate_dense(cha->ncol, chb->ncol, cha->ncol,
262 :     chb->xtype, &c);
263 :     SEXP dn = PROTECT(allocVector(VECSXP, 2));
264 :     double one[] = {1,0}, zero[] = {0,0};
265 :     R_CheckStack();
266 : bates 1067
267 : maechler 1960 cholmod_sdmult(cha, 1, one, zero, chb, chc, &c);
268 : maechler 1660 SET_VECTOR_ELT(dn, 0, /* establish dimnames */
269 :     duplicate(VECTOR_ELT(GET_SLOT(a, Matrix_DimNamesSym), 1)));
270 :     SET_VECTOR_ELT(dn, 1,
271 :     duplicate(VECTOR_ELT(GET_SLOT(b_M, Matrix_DimNamesSym), 1)));
272 : maechler 1960 UNPROTECT(2);
273 : maechler 1660 return chm_dense_to_SEXP(chc, 1, 0, dn);
274 : bates 1067 }
275 :    
276 : maechler 1659 /* Computes x'x or x x' -- see Csparse_Csparse_crossprod above for x'y and x y' */
277 : bates 928 SEXP Csparse_crossprod(SEXP x, SEXP trans, SEXP triplet)
278 : bates 922 {
279 : maechler 957 int trip = asLogical(triplet),
280 :     tr = asLogical(trans); /* gets reversed because _aat is tcrossprod */
281 : maechler 1960 CHM_TR cht = trip ? AS_CHM_TR(x) : (CHM_TR) NULL;
282 :     CHM_SP chcp, chxt,
283 :     chx = trip ? cholmod_triplet_to_sparse(cht, cht->nnz, &c) : AS_CHM_SP(x);
284 : bates 1366 SEXP dn = PROTECT(allocVector(VECSXP, 2));
285 : maechler 1960 R_CheckStack();
286 : bates 922
287 : maechler 1960 if (!tr) chxt = cholmod_transpose(chx, chx->xtype, &c);
288 : bates 928 chcp = cholmod_aat((!tr) ? chxt : chx, (int *) NULL, 0, chx->xtype, &c);
289 : maechler 1960 if(!chcp) error(_("Csparse_crossprod(): error return from cholmod_aat()"));
290 : bates 1360 cholmod_band_inplace(0, chcp->ncol, chcp->xtype, chcp, &c);
291 :     chcp->stype = 1;
292 : maechler 1960 if (trip) cholmod_free_sparse(&chx, &c);
293 : bates 923 if (!tr) cholmod_free_sparse(&chxt, &c);
294 : maechler 1960 SET_VECTOR_ELT(dn, 0, /* establish dimnames */
295 : bates 1366 duplicate(VECTOR_ELT(GET_SLOT(x, Matrix_DimNamesSym),
296 : maechler 1660 (tr) ? 0 : 1)));
297 : bates 1366 SET_VECTOR_ELT(dn, 1, duplicate(VECTOR_ELT(dn, 0)));
298 :     UNPROTECT(1);
299 : maechler 1548 return chm_sparse_to_SEXP(chcp, 1, 0, 0, "", dn);
300 : bates 922 }
301 : bates 923
302 : maechler 1618 SEXP Csparse_drop(SEXP x, SEXP tol)
303 :     {
304 : maechler 1960 CHM_SP chx = AS_CHM_SP(x);
305 :     CHM_SP ans = cholmod_copy(chx, chx->stype, chx->xtype, &c);
306 : maechler 1618 double dtol = asReal(tol);
307 : maechler 1736 int Rkind = (chx->xtype != CHOLMOD_PATTERN) ? Real_kind(x) : 0;
308 : maechler 1960 R_CheckStack();
309 : maechler 1618
310 :     if(!cholmod_drop(dtol, ans, &c))
311 :     error(_("cholmod_drop() failed"));
312 : maechler 1736 return chm_sparse_to_SEXP(ans, 1, 0, Rkind, "",
313 :     GET_SLOT(x, Matrix_DimNamesSym));
314 : maechler 1618 }
315 :    
316 : bates 1218 SEXP Csparse_horzcat(SEXP x, SEXP y)
317 :     {
318 : maechler 1960 CHM_SP chx = AS_CHM_SP(x), chy = AS_CHM_SP(y);
319 : maechler 1548 int Rkind = 0; /* only for "d" - FIXME */
320 : maechler 1960 R_CheckStack();
321 : maechler 1375
322 : bates 1366 /* FIXME: currently drops dimnames */
323 : maechler 1960 return chm_sparse_to_SEXP(cholmod_horzcat(chx, chy, 1, &c),
324 :     1, 0, Rkind, "", R_NilValue);
325 : bates 1218 }
326 :    
327 :     SEXP Csparse_vertcat(SEXP x, SEXP y)
328 :     {
329 : maechler 1960 CHM_SP chx = AS_CHM_SP(x), chy = AS_CHM_SP(y);
330 : maechler 1548 int Rkind = 0; /* only for "d" - FIXME */
331 : maechler 1960 R_CheckStack();
332 : maechler 1375
333 : bates 1366 /* FIXME: currently drops dimnames */
334 : maechler 1960 return chm_sparse_to_SEXP(cholmod_vertcat(chx, chy, 1, &c),
335 :     1, 0, Rkind, "", R_NilValue);
336 : bates 1218 }
337 : bates 1265
338 :     SEXP Csparse_band(SEXP x, SEXP k1, SEXP k2)
339 :     {
340 : maechler 1960 CHM_SP chx = AS_CHM_SP(x);
341 : maechler 1736 int Rkind = (chx->xtype != CHOLMOD_PATTERN) ? Real_kind(x) : 0;
342 : maechler 1960 CHM_SP ans = cholmod_band(chx, asInteger(k1), asInteger(k2), chx->xtype, &c);
343 :     R_CheckStack();
344 : bates 1265
345 : maechler 1736 return chm_sparse_to_SEXP(ans, 1, 0, Rkind, "",
346 :     GET_SLOT(x, Matrix_DimNamesSym));
347 : bates 1265 }
348 : bates 1366
349 :     SEXP Csparse_diagU2N(SEXP x)
350 :     {
351 : maechler 1708 if (*diag_P(x) != 'U') {/* "trivially fast" when there's no 'diag' slot at all */
352 :     return (x);
353 :     }
354 :     else {
355 : maechler 1960 CHM_SP chx = AS_CHM_SP(x);
356 :     CHM_SP eye = cholmod_speye(chx->nrow, chx->ncol, chx->xtype, &c);
357 : maechler 1708 double one[] = {1, 0};
358 : maechler 1960 CHM_SP ans = cholmod_add(chx, eye, one, one, TRUE, TRUE, &c);
359 : maechler 1710 int uploT = (*uplo_P(x) == 'U') ? 1 : -1;
360 : maechler 1736 int Rkind = (chx->xtype != CHOLMOD_PATTERN) ? Real_kind(x) : 0;
361 : bates 1366
362 : maechler 1960 R_CheckStack();
363 :     cholmod_free_sparse(&eye, &c);
364 : maechler 1708 return chm_sparse_to_SEXP(ans, 1, uploT, Rkind, "N",
365 : maechler 1736 GET_SLOT(x, Matrix_DimNamesSym));
366 : maechler 1708 }
367 : bates 1366 }
368 :    
369 :     SEXP Csparse_submatrix(SEXP x, SEXP i, SEXP j)
370 :     {
371 : maechler 1960 CHM_SP chx = AS_CHM_SP(x);
372 : bates 1366 int rsize = (isNull(i)) ? -1 : LENGTH(i),
373 :     csize = (isNull(j)) ? -1 : LENGTH(j);
374 : maechler 1736 int Rkind = (chx->xtype != CHOLMOD_PATTERN) ? Real_kind(x) : 0;
375 : maechler 1960 R_CheckStack();
376 : bates 1366
377 :     if (rsize >= 0 && !isInteger(i))
378 :     error(_("Index i must be NULL or integer"));
379 :     if (csize >= 0 && !isInteger(j))
380 :     error(_("Index j must be NULL or integer"));
381 : maechler 1736
382 : bates 1366 return chm_sparse_to_SEXP(cholmod_submatrix(chx, INTEGER(i), rsize,
383 : maechler 1375 INTEGER(j), csize,
384 : bates 1366 TRUE, TRUE, &c),
385 : maechler 1736 1, 0, Rkind, "",
386 :     /* FIXME: drops dimnames */ R_NilValue);
387 : bates 1366 }

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