SCM

SCM Repository

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

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

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

pkg/src/Csparse.c revision 930, Mon Sep 19 21:29:37 2005 UTC pkg/Matrix/src/Csparse.c revision 2984, Sat Apr 12 21:37:37 2014 UTC
# Line 1  Line 1 
1                          /* Sparse matrices in compress column-oriented form */                          /* Sparse matrices in compressed column-oriented form */
2    
3  #include "Csparse.h"  #include "Csparse.h"
4  #ifdef USE_CHOLMOD  #include "Tsparse.h"
5  #include "chm_common.h"  #include "chm_common.h"
 #endif  /* USE_CHOLMOD */  
6    
7  SEXP Csparse_validate(SEXP x)  /** "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),      SEXP pslot = GET_SLOT(x, Matrix_pSym),
12          islot = GET_SLOT(x, Matrix_iSym);          islot = GET_SLOT(x, Matrix_iSym);
13      int j, ncol = length(pslot) - 1,      int *dims = INTEGER(GET_SLOT(x, Matrix_DimSym)), j,
14          *dims = INTEGER(GET_SLOT(x, Matrix_DimSym)),          nrow = dims[0],
15          nrow, *xp = INTEGER(pslot),          ncol = dims[1],
16            *xp = INTEGER(pslot),
17          *xi = INTEGER(islot);          *xi = INTEGER(islot);
18    
19      nrow = dims[0];      if (length(pslot) != dims[1] + 1)
20      if (length(pslot) <= 0)          return FALSE;
         return mkString(_("slot p must have length > 0"));  
21      if (xp[0] != 0)      if (xp[0] != 0)
22          return mkString(_("first element of slot p must be zero"));          return FALSE;
23      if (length(islot) != xp[ncol])      if (length(islot) < xp[ncol]) /* allow larger slots from over-allocation!*/
24          return mkString(_("last element of slot p must match length of slots i and x"));          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++) {      for (j = 0; j < ncol; j++) {
30          if (xp[j] > xp[j+1])          if (xp[j] > xp[j+1])
31                return FALSE;
32        }
33        return TRUE;
34    }
35    
36    SEXP Csparse_validate(SEXP x) {
37        return Csparse_validate_(x, FALSE);
38    }
39    
40    
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    SEXP Csparse_validate2(SEXP x, SEXP maybe_modify) {
49        return Csparse_validate_(x, asLogical(maybe_modify));
50    }
51    
52    // 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    }
58    
59    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"));              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      }      }
     for (j = 0; j < length(islot); j++) {  
         if (xi[j] < 0 || xi[j] >= nrow)  
             return mkString(_("all row indices must be between 0 and nrow-1"));  
94      }      }
95        if (!sorted)
96            /* cannot easily use cholmod_sort(.) ... -> "error out" :*/
97            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);      return ScalarLogical(1);
102  }  }
103    
104  SEXP Csparse_to_Tsparse(SEXP x)  
105    /* Called from ../R/Csparse.R : */
106    /* Can only return [dln]geMatrix (no symm/triang);
107     * FIXME: replace by non-CHOLMOD code ! */
108    SEXP Csparse_to_dense(SEXP x)
109  {  {
110  #ifdef USE_CHOLMOD      CHM_SP chxs = AS_CHM_SP__(x);
111      cholmod_sparse *chxs = as_cholmod_sparse(x);      /* This loses the symmetry property, since cholmod_dense has none,
112      cholmod_triplet *chxt = cholmod_sparse_to_triplet(chxs, &c);       * BUT, much worse (FIXME!), it also transforms CHOLMOD_PATTERN ("n") matrices
113         * to numeric (CHOLMOD_REAL) ones : */
114        CHM_DN chxd = cholmod_sparse_to_dense(chxs, &c);
115        int Rkind = (chxs->xtype == CHOLMOD_PATTERN)? -1 : Real_kind(x);
116        R_CheckStack();
117    
118      Free(chxs);      return chm_dense_to_SEXP(chxd, 1, Rkind, GET_SLOT(x, Matrix_DimNamesSym));
     return chm_triplet_to_SEXP(chxt, 1);  
 #else  
     error("General conversion requires CHOLMOD");  
     return R_NilValue;          /* -Wall */  
 #endif  /* USE_CHOLMOD */  
119  }  }
120    
121  SEXP Csparse_transpose(SEXP x)  // FIXME: do not go via CHM (should not be too hard, to just *drop* the x-slot, right?
122    SEXP Csparse_to_nz_pattern(SEXP x, SEXP tri)
123  {  {
124  #ifdef USE_CHOLMOD      CHM_SP chxs = AS_CHM_SP__(x);
125      cholmod_sparse *chx = as_cholmod_sparse(x);      CHM_SP chxcp = cholmod_copy(chxs, chxs->stype, CHOLMOD_PATTERN, &c);
126      cholmod_sparse *chxt = cholmod_transpose(chx, (int) chx->xtype, &c);      int tr = asLogical(tri);
127        R_CheckStack();
128    
129        return chm_sparse_to_SEXP(chxcp, 1/*do_free*/,
130                                  tr ? ((*uplo_P(x) == 'U') ? 1 : -1) : 0,
131                                  0, tr ? diag_P(x) : "",
132                                  GET_SLOT(x, Matrix_DimNamesSym));
133    }
134    
135      Free(chx);  // n.CMatrix --> [dli].CMatrix  (not going through CHM!)
136      return chm_sparse_to_SEXP(chxt, 1);  SEXP nz_pattern_to_Csparse(SEXP x, SEXP res_kind)
137  #else  {
138      error("General conversion requires CHOLMOD");      return nz2Csparse(x, asInteger(res_kind));
139    }
140    // n.CMatrix --> [dli].CMatrix  (not going through CHM!)
141    SEXP nz2Csparse(SEXP x, enum x_slot_kind r_kind)
142    {
143        const char *cl_x = class_P(x);
144        if(cl_x[0] != 'n') error(_("not a 'n.CMatrix'"));
145        if(cl_x[2] != 'C') error(_("not a CsparseMatrix"));
146        int nnz = LENGTH(GET_SLOT(x, Matrix_iSym));
147        SEXP ans;
148        char *ncl = alloca(strlen(cl_x) + 1); /* not much memory required */
149        strcpy(ncl, cl_x);
150        double *dx_x; int *ix_x;
151        ncl[0] = (r_kind == x_double ? 'd' :
152                  (r_kind == x_logical ? 'l' :
153                   /* else (for now):  r_kind == x_integer : */ 'i'));
154        PROTECT(ans = NEW_OBJECT(MAKE_CLASS(ncl)));
155        // create a correct 'x' slot:
156        switch(r_kind) {
157            int i;
158        case x_double: // 'd'
159            dx_x = REAL(ALLOC_SLOT(ans, Matrix_xSym, REALSXP, nnz));
160            for (i=0; i < nnz; i++) dx_x[i] = 1.;
161            break;
162        case x_logical: // 'l'
163            ix_x = LOGICAL(ALLOC_SLOT(ans, Matrix_xSym, LGLSXP, nnz));
164            for (i=0; i < nnz; i++) ix_x[i] = TRUE;
165            break;
166        case x_integer: // 'i'
167            ix_x = INTEGER(ALLOC_SLOT(ans, Matrix_xSym, INTSXP, nnz));
168            for (i=0; i < nnz; i++) ix_x[i] = 1;
169            break;
170    
171        default:
172            error(_("nz2Csparse(): invalid/non-implemented r_kind = %d"),
173                  r_kind);
174        }
175    
176        // now copy all other slots :
177        slot_dup(ans, x, Matrix_iSym);
178        slot_dup(ans, x, Matrix_pSym);
179        slot_dup(ans, x, Matrix_DimSym);
180        slot_dup(ans, x, Matrix_DimNamesSym);
181        if(ncl[1] != 'g') { // symmetric or triangular ...
182            slot_dup_if_has(ans, x, Matrix_uploSym);
183            slot_dup_if_has(ans, x, Matrix_diagSym);
184        }
185        UNPROTECT(1);
186        return ans;
187    }
188    
189    SEXP Csparse_to_matrix(SEXP x, SEXP chk)
190    {
191        return chm_dense_to_matrix(cholmod_sparse_to_dense(AS_CHM_SP2(x, asLogical(chk)), &c),
192                                   1 /*do_free*/, GET_SLOT(x, Matrix_DimNamesSym));
193    }
194    SEXP Csparse_to_vector(SEXP x)
195    {
196        return chm_dense_to_vector(cholmod_sparse_to_dense(AS_CHM_SP__(x), &c), 1);
197    }
198    
199    SEXP Csparse_to_Tsparse(SEXP x, SEXP tri)
200    {
201        CHM_SP chxs = AS_CHM_SP__(x);
202        CHM_TR chxt = cholmod_sparse_to_triplet(chxs, &c);
203        int tr = asLogical(tri);
204        int Rkind = (chxs->xtype != CHOLMOD_PATTERN) ? Real_kind(x) : 0;
205        R_CheckStack();
206    
207        return chm_triplet_to_SEXP(chxt, 1,
208                                   tr ? ((*uplo_P(x) == 'U') ? 1 : -1) : 0,
209                                   Rkind, tr ? diag_P(x) : "",
210                                   GET_SLOT(x, Matrix_DimNamesSym));
211    }
212    
213    /* this used to be called  sCMatrix_to_gCMatrix(..)   [in ./dsCMatrix.c ]: */
214    SEXP Csparse_symmetric_to_general(SEXP x)
215    {
216        CHM_SP chx = AS_CHM_SP__(x), chgx;
217        int Rkind = (chx->xtype != CHOLMOD_PATTERN) ? Real_kind(x) : 0;
218        R_CheckStack();
219    
220        if (!(chx->stype))
221            error(_("Nonsymmetric matrix in Csparse_symmetric_to_general"));
222        chgx = cholmod_copy(chx, /* stype: */ 0, chx->xtype, &c);
223        /* xtype: pattern, "real", complex or .. */
224        return chm_sparse_to_SEXP(chgx, 1, 0, Rkind, "",
225                                  GET_SLOT(x, Matrix_DimNamesSym));
226    }
227    
228    SEXP Csparse_general_to_symmetric(SEXP x, SEXP uplo)
229    {
230        int *adims = INTEGER(GET_SLOT(x, Matrix_DimSym)), n = adims[0];
231        if(n != adims[1]) {
232            error(_("Csparse_general_to_symmetric(): matrix is not square!"));
233      return R_NilValue;          /* -Wall */      return R_NilValue;          /* -Wall */
234  #endif  /* USE_CHOLMOD */      }
235        CHM_SP chx = AS_CHM_SP__(x), chgx;
236        int uploT = (*CHAR(STRING_ELT(uplo,0)) == 'U') ? 1 : -1;
237        int Rkind = (chx->xtype != CHOLMOD_PATTERN) ? Real_kind(x) : 0;
238        R_CheckStack();
239        chgx = cholmod_copy(chx, /* stype: */ uploT, chx->xtype, &c);
240        /* xtype: pattern, "real", complex or .. */
241        return chm_sparse_to_SEXP(chgx, 1, 0, Rkind, "",
242                                  GET_SLOT(x, Matrix_DimNamesSym));
243  }  }
244    
245    SEXP Csparse_transpose(SEXP x, SEXP tri)
246    {
247        /* TODO: lgCMatrix & igC* currently go via double prec. cholmod -
248         *       since cholmod (& cs) lacks sparse 'int' matrices */
249        CHM_SP chx = AS_CHM_SP__(x);
250        int Rkind = (chx->xtype != CHOLMOD_PATTERN) ? Real_kind(x) : 0;
251        CHM_SP chxt = cholmod_transpose(chx, chx->xtype, &c);
252        SEXP dn = PROTECT(duplicate(GET_SLOT(x, Matrix_DimNamesSym))), tmp;
253        int tr = asLogical(tri);
254        R_CheckStack();
255    
256        tmp = VECTOR_ELT(dn, 0);    /* swap the dimnames */
257        SET_VECTOR_ELT(dn, 0, VECTOR_ELT(dn, 1));
258        SET_VECTOR_ELT(dn, 1, tmp);
259        UNPROTECT(1);
260        return chm_sparse_to_SEXP(chxt, 1, /* SWAP 'uplo' for triangular */
261                                  tr ? ((*uplo_P(x) == 'U') ? -1 : 1) : 0,
262                                  Rkind, tr ? diag_P(x) : "", dn);
263    }
264    
265  SEXP Csparse_Csparse_prod(SEXP a, SEXP b)  SEXP Csparse_Csparse_prod(SEXP a, SEXP b)
266  {  {
267  #ifdef USE_CHOLMOD      CHM_SP
268      cholmod_sparse *cha = as_cholmod_sparse(a), *chb = as_cholmod_sparse(b);          cha = AS_CHM_SP(a),
269      cholmod_sparse *chc = cholmod_ssmult(cha, chb, 0, (int) cha->xtype, 1, &c);          chb = AS_CHM_SP(b),
270            chc = cholmod_ssmult(cha, chb, /*out_stype:*/ 0,
271                                   /* values:= is_numeric (T/F) */ cha->xtype > 0,
272                                   /*out sorted:*/ 1, &c);
273        const char *cl_a = class_P(a), *cl_b = class_P(b);
274        char diag[] = {'\0', '\0'};
275        int uploT = 0;
276        SEXP dn = PROTECT(allocVector(VECSXP, 2));
277        R_CheckStack();
278    
279    #ifdef DEBUG_Matrix_verbose
280        Rprintf("DBG Csparse_C*_prod(%s, %s)\n", cl_a, cl_b);
281    #endif
282    
283        /* Preserve triangularity and even unit-triangularity if appropriate.
284         * Note that in that case, the multiplication itself should happen
285         * faster.  But there's no support for that in CHOLMOD */
286    
287        /* UGLY hack -- rather should have (fast!) C-level version of
288         *       is(a, "triangularMatrix") etc */
289        if (cl_a[1] == 't' && cl_b[1] == 't')
290            /* FIXME: fails for "Cholesky","BunchKaufmann"..*/
291            if(*uplo_P(a) == *uplo_P(b)) { /* both upper, or both lower tri. */
292                uploT = (*uplo_P(a) == 'U') ? 1 : -1;
293                if(*diag_P(a) == 'U' && *diag_P(b) == 'U') { /* return UNIT-triag. */
294                    /* "remove the diagonal entries": */
295                    chm_diagN2U(chc, uploT, /* do_realloc */ FALSE);
296                    diag[0]= 'U';
297                }
298                else diag[0]= 'N';
299            }
300        SET_VECTOR_ELT(dn, 0,       /* establish dimnames */
301                       duplicate(VECTOR_ELT(GET_SLOT(a, Matrix_DimNamesSym), 0)));
302        SET_VECTOR_ELT(dn, 1,
303                       duplicate(VECTOR_ELT(GET_SLOT(b, Matrix_DimNamesSym), 1)));
304        UNPROTECT(1);
305        return chm_sparse_to_SEXP(chc, 1, uploT, /*Rkind*/0, diag, dn);
306    }
307    
308      Free(cha); Free(chb);  SEXP Csparse_Csparse_crossprod(SEXP a, SEXP b, SEXP trans)
309      return chm_sparse_to_SEXP(chc, 1);  {
310  #else      int tr = asLogical(trans);
311      error("General multiplication requires CHOLMOD");      CHM_SP
312      return R_NilValue;          /* -Wall */          cha = AS_CHM_SP(a),
313  #endif  /* USE_CHOLMOD */          chb = AS_CHM_SP(b),
314            chTr, chc;
315        const char *cl_a = class_P(a), *cl_b = class_P(b);
316        char diag[] = {'\0', '\0'};
317        int uploT = 0;
318        SEXP dn = PROTECT(allocVector(VECSXP, 2));
319        R_CheckStack();
320    
321        chTr = cholmod_transpose((tr) ? chb : cha, chb->xtype, &c);
322        chc = cholmod_ssmult((tr) ? cha : chTr, (tr) ? chTr : chb,
323                             /*out_stype:*/ 0, cha->xtype, /*out sorted:*/ 1, &c);
324        cholmod_free_sparse(&chTr, &c);
325    
326        /* Preserve triangularity and unit-triangularity if appropriate;
327         * see Csparse_Csparse_prod() for comments */
328        if (cl_a[1] == 't' && cl_b[1] == 't')
329            if(*uplo_P(a) != *uplo_P(b)) { /* one 'U', the other 'L' */
330                uploT = (*uplo_P(b) == 'U') ? 1 : -1;
331                if(*diag_P(a) == 'U' && *diag_P(b) == 'U') { /* return UNIT-triag. */
332                    chm_diagN2U(chc, uploT, /* do_realloc */ FALSE);
333                    diag[0]= 'U';
334                }
335                else diag[0]= 'N';
336            }
337        SET_VECTOR_ELT(dn, 0,       /* establish dimnames */
338                       duplicate(VECTOR_ELT(GET_SLOT(a, Matrix_DimNamesSym), (tr) ? 0 : 1)));
339        SET_VECTOR_ELT(dn, 1,
340                       duplicate(VECTOR_ELT(GET_SLOT(b, Matrix_DimNamesSym), (tr) ? 0 : 1)));
341        UNPROTECT(1);
342        return chm_sparse_to_SEXP(chc, 1, uploT, /*Rkind*/0, diag, dn);
343  }  }
344    
345  SEXP Csparse_dense_prod(SEXP a, SEXP b)  SEXP Csparse_dense_prod(SEXP a, SEXP b)
346  {  {
347  #ifdef USE_CHOLMOD      CHM_SP cha = AS_CHM_SP(a);
348      cholmod_sparse *cha = as_cholmod_sparse(a);      SEXP b_M = PROTECT(mMatrix_as_dgeMatrix(b));
349      cholmod_dense *chb = as_cholmod_dense(b);      CHM_DN chb = AS_CHM_DN(b_M);
350      cholmod_dense *chc = cholmod_allocate_dense(cha->nrow, chb->ncol,      CHM_DN chc = cholmod_allocate_dense(cha->nrow, chb->ncol, cha->nrow,
351                                                  cha->nrow, chb->xtype, &c);                                          chb->xtype, &c);
352      double alpha = 1, beta = 0;      SEXP dn = PROTECT(allocVector(VECSXP, 2));
353        double one[] = {1,0}, zero[] = {0,0};
354      cholmod_sdmult(cha, 0, &alpha, &beta, chb, chc, &c);      int nprot = 2;
355      Free(cha); Free(chb);      R_CheckStack();
356      return chm_dense_to_SEXP(chc, 1);      /* Tim Davis, please FIXME:  currently (2010-11) *fails* when  a  is a pattern matrix:*/
357  #else      if(cha->xtype == CHOLMOD_PATTERN) {
358      error("General multiplication requires CHOLMOD");          /* warning(_("Csparse_dense_prod(): cholmod_sdmult() not yet implemented for pattern./ ngCMatrix" */
359      return R_NilValue;          /* -Wall */          /*        " --> slightly inefficient coercion")); */
360  #endif  /* USE_CHOLMOD */  
361            // This *fails* to produce a CHOLMOD_REAL ..
362            // CHM_SP chd = cholmod_l_copy(cha, cha->stype, CHOLMOD_REAL, &c);
363            // --> use our Matrix-classes
364            SEXP da = PROTECT(nz2Csparse(a, x_double)); nprot++;
365            cha = AS_CHM_SP(da);
366        }
367        cholmod_sdmult(cha, 0, one, zero, chb, chc, &c);
368        SET_VECTOR_ELT(dn, 0,       /* establish dimnames */
369                       duplicate(VECTOR_ELT(GET_SLOT(a, Matrix_DimNamesSym), 0)));
370        SET_VECTOR_ELT(dn, 1,
371                       duplicate(VECTOR_ELT(GET_SLOT(b_M, Matrix_DimNamesSym), 1)));
372        UNPROTECT(nprot);
373        return chm_dense_to_SEXP(chc, 1, 0, dn);
374    }
375    
376    SEXP Csparse_dense_crossprod(SEXP a, SEXP b)
377    {
378        CHM_SP cha = AS_CHM_SP(a);
379        SEXP b_M = PROTECT(mMatrix_as_dgeMatrix(b));
380        CHM_DN chb = AS_CHM_DN(b_M);
381        CHM_DN chc = cholmod_allocate_dense(cha->ncol, chb->ncol, cha->ncol,
382                                            chb->xtype, &c);
383        SEXP dn = PROTECT(allocVector(VECSXP, 2)); int nprot = 2;
384        double one[] = {1,0}, zero[] = {0,0};
385        R_CheckStack();
386        // -- see Csparse_dense_prod() above :
387        if(cha->xtype == CHOLMOD_PATTERN) {
388            SEXP da = PROTECT(nz2Csparse(a, x_double)); nprot++;
389            cha = AS_CHM_SP(da);
390        }
391        cholmod_sdmult(cha, 1, one, zero, chb, chc, &c);
392        SET_VECTOR_ELT(dn, 0,       /* establish dimnames */
393                       duplicate(VECTOR_ELT(GET_SLOT(a, Matrix_DimNamesSym), 1)));
394        SET_VECTOR_ELT(dn, 1,
395                       duplicate(VECTOR_ELT(GET_SLOT(b_M, Matrix_DimNamesSym), 1)));
396        UNPROTECT(nprot);
397        return chm_dense_to_SEXP(chc, 1, 0, dn);
398  }  }
399    
400    /* Computes   x'x  or  x x' -- *also* for Tsparse (triplet = TRUE)
401       see Csparse_Csparse_crossprod above for  x'y and x y' */
402  SEXP Csparse_crossprod(SEXP x, SEXP trans, SEXP triplet)  SEXP Csparse_crossprod(SEXP x, SEXP trans, SEXP triplet)
403  {  {
404  #ifdef USE_CHOLMOD      int trip = asLogical(triplet),
405      int trip = asLogical(triplet);          tr   = asLogical(trans); /* gets reversed because _aat is tcrossprod */
406      cholmod_triplet  #ifdef AS_CHM_DIAGU2N_FIXED_FINALLY
407          *cht = trip ? as_cholmod_triplet(x) : (cholmod_triplet*) NULL;      CHM_TR cht = trip ? AS_CHM_TR(x) : (CHM_TR) NULL;
408      cholmod_sparse *chcp, *chxt,  #else /* workaround needed:*/
409          *chx = trip ? cholmod_triplet_to_sparse(cht, cht->nnz, &c)      SEXP xx = PROTECT(Tsparse_diagU2N(x));
410          : as_cholmod_sparse(x);      CHM_TR cht = trip ? AS_CHM_TR__(xx) : (CHM_TR) NULL;
411      int tr = asLogical(trans);  /* gets reversed because _aat is tcrossprod */  #endif
412        CHM_SP chcp, chxt,
413            chx = (trip ?
414                   cholmod_triplet_to_sparse(cht, cht->nnz, &c) :
415                   AS_CHM_SP(x));
416        SEXP dn = PROTECT(allocVector(VECSXP, 2));
417        R_CheckStack();
418    
419      if (!tr)      if (!tr) chxt = cholmod_transpose(chx, chx->xtype, &c);
         chxt = cholmod_transpose(chx, (int) chx->xtype, &c);  
420      chcp = cholmod_aat((!tr) ? chxt : chx, (int *) NULL, 0, chx->xtype, &c);      chcp = cholmod_aat((!tr) ? chxt : chx, (int *) NULL, 0, chx->xtype, &c);
421        if(!chcp) {
422      if (trip) {          UNPROTECT(1);
423          cholmod_free_sparse(&chx, &c);          error(_("Csparse_crossprod(): error return from cholmod_aat()"));
         Free(cht);  
     } else {  
         Free(chx);  
424      }      }
425        cholmod_band_inplace(0, chcp->ncol, chcp->xtype, chcp, &c);
426        chcp->stype = 1;
427        if (trip) cholmod_free_sparse(&chx, &c);
428      if (!tr) cholmod_free_sparse(&chxt, &c);      if (!tr) cholmod_free_sparse(&chxt, &c);
429      return chm_sparse_to_SEXP(chcp, 1);      SET_VECTOR_ELT(dn, 0,       /* establish dimnames */
430                       duplicate(VECTOR_ELT(GET_SLOT(x, Matrix_DimNamesSym),
431                                            (tr) ? 0 : 1)));
432        SET_VECTOR_ELT(dn, 1, duplicate(VECTOR_ELT(dn, 0)));
433    #ifdef AS_CHM_DIAGU2N_FIXED_FINALLY
434        UNPROTECT(1);
435  #else  #else
436      error("General crossproduct requires CHOLMOD");      UNPROTECT(2);
437      return R_NilValue;          /* -Wall */  #endif
438  #endif  /* USE_CHOLMOD */      return chm_sparse_to_SEXP(chcp, 1, 0, 0, "", dn);
439    }
440    
441    /* Csparse_drop(x, tol):  drop entries with absolute value < tol, i.e,
442    *  at least all "explicit" zeros */
443    SEXP Csparse_drop(SEXP x, SEXP tol)
444    {
445        const char *cl = class_P(x);
446        /* dtCMatrix, etc; [1] = the second character =?= 't' for triangular */
447        int tr = (cl[1] == 't');
448        CHM_SP chx = AS_CHM_SP__(x);
449        CHM_SP ans = cholmod_copy(chx, chx->stype, chx->xtype, &c);
450        double dtol = asReal(tol);
451        int Rkind = (chx->xtype != CHOLMOD_PATTERN) ? Real_kind(x) : 0;
452        R_CheckStack();
453    
454        if(!cholmod_drop(dtol, ans, &c))
455            error(_("cholmod_drop() failed"));
456       return chm_sparse_to_SEXP(ans, 1,
457                                  tr ? ((*uplo_P(x) == 'U') ? 1 : -1) : 0,
458                                  Rkind, tr ? diag_P(x) : "",
459                                  GET_SLOT(x, Matrix_DimNamesSym));
460    }
461    
462    SEXP Csparse_horzcat(SEXP x, SEXP y)
463    {
464        CHM_SP chx = AS_CHM_SP__(x), chy = AS_CHM_SP__(y);
465        int Rk_x = (chx->xtype != CHOLMOD_PATTERN) ? Real_kind(x) : 0,
466            Rk_y = (chy->xtype != CHOLMOD_PATTERN) ? Real_kind(y) : 0,
467            Rkind = /* logical if both x and y are */ (Rk_x == 1 && Rk_y == 1) ? 1 : 0;
468        R_CheckStack();
469    
470        /* TODO: currently drops dimnames - and we fix at R level */
471        return chm_sparse_to_SEXP(cholmod_horzcat(chx, chy, 1, &c),
472                                  1, 0, Rkind, "", R_NilValue);
473    }
474    
475    SEXP Csparse_vertcat(SEXP x, SEXP y)
476    {
477        CHM_SP chx = AS_CHM_SP__(x), chy = AS_CHM_SP__(y);
478        int Rk_x = (chx->xtype != CHOLMOD_PATTERN) ? Real_kind(x) : 0,
479            Rk_y = (chy->xtype != CHOLMOD_PATTERN) ? Real_kind(y) : 0,
480            Rkind = /* logical if both x and y are */ (Rk_x == 1 && Rk_y == 1) ? 1 : 0;
481        R_CheckStack();
482    
483        /* TODO: currently drops dimnames - and we fix at R level */
484        return chm_sparse_to_SEXP(cholmod_vertcat(chx, chy, 1, &c),
485                                  1, 0, Rkind, "", R_NilValue);
486    }
487    
488    SEXP Csparse_band(SEXP x, SEXP k1, SEXP k2)
489    {
490        CHM_SP chx = AS_CHM_SP__(x);
491        int Rkind = (chx->xtype != CHOLMOD_PATTERN) ? Real_kind(x) : 0;
492        CHM_SP ans = cholmod_band(chx, asInteger(k1), asInteger(k2), chx->xtype, &c);
493        R_CheckStack();
494    
495        return chm_sparse_to_SEXP(ans, 1, 0, Rkind, "",
496                                  GET_SLOT(x, Matrix_DimNamesSym));
497    }
498    
499    SEXP Csparse_diagU2N(SEXP x)
500    {
501        const char *cl = class_P(x);
502        /* dtCMatrix, etc; [1] = the second character =?= 't' for triangular */
503        if (cl[1] != 't' || *diag_P(x) != 'U') {
504            /* "trivially fast" when not triangular (<==> no 'diag' slot),
505               or not *unit* triangular */
506            return (x);
507        }
508        else { /* unit triangular (diag='U'): "fill the diagonal" & diag:= "N" */
509            CHM_SP chx = AS_CHM_SP__(x);
510            CHM_SP eye = cholmod_speye(chx->nrow, chx->ncol, chx->xtype, &c);
511            double one[] = {1, 0};
512            CHM_SP ans = cholmod_add(chx, eye, one, one, TRUE, TRUE, &c);
513            int uploT = (*uplo_P(x) == 'U') ? 1 : -1;
514            int Rkind = (chx->xtype != CHOLMOD_PATTERN) ? Real_kind(x) : 0;
515    
516            R_CheckStack();
517            cholmod_free_sparse(&eye, &c);
518            return chm_sparse_to_SEXP(ans, 1, uploT, Rkind, "N",
519                                      GET_SLOT(x, Matrix_DimNamesSym));
520  }  }
521    }
522    
523    SEXP Csparse_diagN2U(SEXP x)
524    {
525        const char *cl = class_P(x);
526        /* dtCMatrix, etc; [1] = the second character =?= 't' for triangular */
527        if (cl[1] != 't' || *diag_P(x) != 'N') {
528            /* "trivially fast" when not triangular (<==> no 'diag' slot),
529               or already *unit* triangular */
530            return (x);
531        }
532        else { /* triangular with diag='N'): now drop the diagonal */
533            /* duplicate, since chx will be modified: */
534            SEXP xx = PROTECT(duplicate(x));
535            CHM_SP chx = AS_CHM_SP__(xx);
536            int uploT = (*uplo_P(x) == 'U') ? 1 : -1,
537                Rkind = (chx->xtype != CHOLMOD_PATTERN) ? Real_kind(x) : 0;
538            R_CheckStack();
539    
540            chm_diagN2U(chx, uploT, /* do_realloc */ FALSE);
541    
542            SEXP ans = chm_sparse_to_SEXP(chx, /*dofree*/ 0/* or 1 ?? */,
543                                          uploT, Rkind, "U",
544                                          GET_SLOT(x, Matrix_DimNamesSym));
545            UNPROTECT(1);// only now !
546            return ans;
547        }
548    }
549    
550    /**
551     * "Indexing" aka subsetting : Compute  x[i,j], also for vectors i and j
552     * Working via CHOLMOD_submatrix, see ./CHOLMOD/MatrixOps/cholmod_submatrix.c
553     * @param x CsparseMatrix
554     * @param i row     indices (0-origin), or NULL (R's)
555     * @param j columns indices (0-origin), or NULL
556     *
557     * @return x[i,j]  still CsparseMatrix --- currently, this loses dimnames
558     */
559    SEXP Csparse_submatrix(SEXP x, SEXP i, SEXP j)
560    {
561        CHM_SP chx = AS_CHM_SP(x); /* << does diagU2N() when needed */
562        int rsize = (isNull(i)) ? -1 : LENGTH(i),
563            csize = (isNull(j)) ? -1 : LENGTH(j);
564        int Rkind = (chx->xtype != CHOLMOD_PATTERN) ? Real_kind(x) : 0;
565        R_CheckStack();
566    
567        if (rsize >= 0 && !isInteger(i))
568            error(_("Index i must be NULL or integer"));
569        if (csize >= 0 && !isInteger(j))
570            error(_("Index j must be NULL or integer"));
571    
572        if (!chx->stype) {/* non-symmetric Matrix */
573            return chm_sparse_to_SEXP(cholmod_submatrix(chx,
574                                                        (rsize < 0) ? NULL : INTEGER(i), rsize,
575                                                        (csize < 0) ? NULL : INTEGER(j), csize,
576                                                        TRUE, TRUE, &c),
577                                      1, 0, Rkind, "",
578                                      /* FIXME: drops dimnames */ R_NilValue);
579        }
580                                    /* for now, cholmod_submatrix() only accepts "generalMatrix" */
581        CHM_SP tmp = cholmod_copy(chx, /* stype: */ 0, chx->xtype, &c);
582        CHM_SP ans = cholmod_submatrix(tmp,
583                                       (rsize < 0) ? NULL : INTEGER(i), rsize,
584                                       (csize < 0) ? NULL : INTEGER(j), csize,
585                                       TRUE, TRUE, &c);
586        cholmod_free_sparse(&tmp, &c);
587        return chm_sparse_to_SEXP(ans, 1, 0, Rkind, "", R_NilValue);
588    }
589    
590    #define _d_Csp_
591    #include "t_Csparse_subassign.c"
592    
593    #define _l_Csp_
594    #include "t_Csparse_subassign.c"
595    
596    #define _i_Csp_
597    #include "t_Csparse_subassign.c"
598    
599    #define _n_Csp_
600    #include "t_Csparse_subassign.c"
601    
602    #define _z_Csp_
603    #include "t_Csparse_subassign.c"
604    
605    
606    
607    SEXP Csparse_MatrixMarket(SEXP x, SEXP fname)
608    {
609        FILE *f = fopen(CHAR(asChar(fname)), "w");
610    
611        if (!f)
612            error(_("failure to open file \"%s\" for writing"),
613                  CHAR(asChar(fname)));
614        if (!cholmod_write_sparse(f, AS_CHM_SP(x),
615                                  (CHM_SP)NULL, (char*) NULL, &c))
616            error(_("cholmod_write_sparse returned error code"));
617        fclose(f);
618        return R_NilValue;
619    }
620    
621    
622    /**
623     * Extract the diagonal entries from *triangular* Csparse matrix  __or__ a
624     * cholmod_sparse factor (LDL = TRUE).
625     *
626     * @param n  dimension of the matrix.
627     * @param x_p  'p' (column pointer) slot contents
628     * @param x_x  'x' (non-zero entries) slot contents
629     * @param perm 'perm' (= permutation vector) slot contents; only used for "diagBack"
630     * @param resultKind a (SEXP) string indicating which kind of result is desired.
631     *
632     * @return  a SEXP, either a (double) number or a length n-vector of diagonal entries
633     */
634    SEXP diag_tC_ptr(int n, int *x_p, double *x_x, Rboolean is_U, int *perm,
635    /*                                ^^^^^^ FIXME[Generalize] to int / ... */
636                     SEXP resultKind)
637    {
638        const char* res_ch = CHAR(STRING_ELT(resultKind,0));
639        enum diag_kind { diag, diag_backpermuted, trace, prod, sum_log, min, max, range
640        } res_kind = ((!strcmp(res_ch, "trace")) ? trace :
641                      ((!strcmp(res_ch, "sumLog")) ? sum_log :
642                       ((!strcmp(res_ch, "prod")) ? prod :
643                        ((!strcmp(res_ch, "min")) ? min :
644                         ((!strcmp(res_ch, "max")) ? max :
645                          ((!strcmp(res_ch, "range")) ? range :
646                           ((!strcmp(res_ch, "diag")) ? diag :
647                            ((!strcmp(res_ch, "diagBack")) ? diag_backpermuted :
648                             -1))))))));
649        int i, n_x, i_from;
650        SEXP ans = PROTECT(allocVector(REALSXP,
651    /*                                 ^^^^  FIXME[Generalize] */
652                                       (res_kind == diag ||
653                                        res_kind == diag_backpermuted) ? n :
654                                       (res_kind == range ? 2 : 1)));
655        double *v = REAL(ans);
656    /*  ^^^^^^      ^^^^  FIXME[Generalize] */
657    
658        i_from = (is_U ? -1 : 0);
659    
660    #define for_DIAG(v_ASSIGN)                                      \
661        for(i = 0; i < n; i++) {                                    \
662            /* looking at i-th column */                            \
663            n_x = x_p[i+1] - x_p[i];/* #{entries} in this column */ \
664            if( is_U) i_from += n_x;                                \
665            v_ASSIGN;                                               \
666            if(!is_U) i_from += n_x;                                \
667        }
668    
669        /* NOTA BENE: we assume  -- uplo = "L" i.e. lower triangular matrix
670         *            for uplo = "U" (makes sense with a "dtCMatrix" !),
671         *            should use  x_x[i_from + (n_x - 1)] instead of x_x[i_from],
672         *            where n_x = (x_p[i+1] - x_p[i])
673         */
674    
675        switch(res_kind) {
676        case trace: // = sum
677            v[0] = 0.;
678            for_DIAG(v[0] += x_x[i_from]);
679            break;
680    
681        case sum_log:
682            v[0] = 0.;
683            for_DIAG(v[0] += log(x_x[i_from]));
684            break;
685    
686        case prod:
687            v[0] = 1.;
688            for_DIAG(v[0] *= x_x[i_from]);
689            break;
690    
691        case min:
692            v[0] = R_PosInf;
693            for_DIAG(if(v[0] > x_x[i_from]) v[0] = x_x[i_from]);
694            break;
695    
696        case max:
697            v[0] = R_NegInf;
698            for_DIAG(if(v[0] < x_x[i_from]) v[0] = x_x[i_from]);
699            break;
700    
701        case range:
702            v[0] = R_PosInf;
703            v[1] = R_NegInf;
704            for_DIAG(if(v[0] > x_x[i_from]) v[0] = x_x[i_from];
705                     if(v[1] < x_x[i_from]) v[1] = x_x[i_from]);
706            break;
707    
708        case diag:
709            for_DIAG(v[i] = x_x[i_from]);
710            break;
711    
712        case diag_backpermuted:
713            for_DIAG(v[i] = x_x[i_from]);
714    
715            warning(_("%s = '%s' (back-permuted) is experimental"),
716                    "resultKind", "diagBack");
717            /* now back_permute : */
718            for(i = 0; i < n; i++) {
719                double tmp = v[i]; v[i] = v[perm[i]]; v[perm[i]] = tmp;
720                /*^^^^ FIXME[Generalize] */
721            }
722            break;
723    
724        default: /* -1 from above */
725            error(_("diag_tC(): invalid 'resultKind'"));
726            /* Wall: */ ans = R_NilValue; v = REAL(ans);
727        }
728    
729        UNPROTECT(1);
730        return ans;
731    }
732    
733    /**
734     * Extract the diagonal entries from *triangular* Csparse matrix  __or__ a
735     * cholmod_sparse factor (LDL = TRUE).
736     *
737     * @param obj -- now a cholmod_sparse factor or a dtCMatrix
738     * @param pslot  'p' (column pointer)   slot of Csparse matrix/factor
739     * @param xslot  'x' (non-zero entries) slot of Csparse matrix/factor
740     * @param perm_slot  'perm' (= permutation vector) slot of corresponding CHMfactor;
741     *                   only used for "diagBack"
742     * @param resultKind a (SEXP) string indicating which kind of result is desired.
743     *
744     * @return  a SEXP, either a (double) number or a length n-vector of diagonal entries
745     */
746    SEXP diag_tC(SEXP obj, SEXP resultKind)
747    {
748    
749        SEXP
750            pslot = GET_SLOT(obj, Matrix_pSym),
751            xslot = GET_SLOT(obj, Matrix_xSym);
752        Rboolean is_U = (R_has_slot(obj, Matrix_uploSym) &&
753                         *CHAR(asChar(GET_SLOT(obj, Matrix_uploSym))) == 'U');
754        int n = length(pslot) - 1, /* n = ncol(.) = nrow(.) */
755            *x_p  = INTEGER(pslot), pp = -1, *perm;
756        double *x_x = REAL(xslot);
757    /*  ^^^^^^        ^^^^ FIXME[Generalize] to INTEGER(.) / LOGICAL(.) / ... xslot !*/
758    
759        if(R_has_slot(obj, Matrix_permSym))
760            perm = INTEGER(GET_SLOT(obj, Matrix_permSym));
761        else perm = &pp;
762    
763        return diag_tC_ptr(n, x_p, x_x, is_U, perm, resultKind);
764    }
765    
766    
767    /**
768     * Create a Csparse matrix object from indices and/or pointers.
769     *
770     * @param cls name of actual class of object to create
771     * @param i optional integer vector of length nnz of row indices
772     * @param j optional integer vector of length nnz of column indices
773     * @param p optional integer vector of length np of row or column pointers
774     * @param np length of integer vector p.  Must be zero if p == (int*)NULL
775     * @param x optional vector of values
776     * @param nnz length of vectors i, j and/or x, whichever is to be used
777     * @param dims optional integer vector of length 2 to be used as
778     *     dimensions.  If dims == (int*)NULL then the maximum row and column
779     *     index are used as the dimensions.
780     * @param dimnames optional list of length 2 to be used as dimnames
781     * @param index1 indicator of 1-based indices
782     *
783     * @return an SEXP of class cls inheriting from CsparseMatrix.
784     */
785    SEXP create_Csparse(char* cls, int* i, int* j, int* p, int np,
786                        void* x, int nnz, int* dims, SEXP dimnames,
787                        int index1)
788    {
789        SEXP ans;
790        int *ij = (int*)NULL, *tri, *trj,
791            mi, mj, mp, nrow = -1, ncol = -1;
792        int xtype = -1;             /* -Wall */
793        CHM_TR T;
794        CHM_SP A;
795    
796        if (np < 0 || nnz < 0)
797            error(_("negative vector lengths not allowed: np = %d, nnz = %d"),
798                  np, nnz);
799        if (1 != ((mi = (i == (int*)NULL)) +
800                  (mj = (j == (int*)NULL)) +
801                  (mp = (p == (int*)NULL))))
802            error(_("exactly 1 of 'i', 'j' or 'p' must be NULL"));
803        if (mp) {
804            if (np) error(_("np = %d, must be zero when p is NULL"), np);
805        } else {
806            if (np) {               /* Expand p to form i or j */
807                if (!(p[0])) error(_("p[0] = %d, should be zero"), p[0]);
808                for (int ii = 0; ii < np; ii++)
809                    if (p[ii] > p[ii + 1])
810                        error(_("p must be non-decreasing"));
811                if (p[np] != nnz)
812                    error("p[np] = %d != nnz = %d", p[np], nnz);
813                ij = Calloc(nnz, int);
814                if (mi) {
815                    i = ij;
816                    nrow = np;
817                } else {
818                    j = ij;
819                    ncol = np;
820                }
821                /* Expand p to 0-based indices */
822                for (int ii = 0; ii < np; ii++)
823                    for (int jj = p[ii]; jj < p[ii + 1]; jj++) ij[jj] = ii;
824            } else {
825                if (nnz)
826                    error(_("Inconsistent dimensions: np = 0 and nnz = %d"),
827                          nnz);
828            }
829        }
830        /* calculate nrow and ncol */
831        if (nrow < 0) {
832            for (int ii = 0; ii < nnz; ii++) {
833                int i1 = i[ii] + (index1 ? 0 : 1); /* 1-based index */
834                if (i1 < 1) error(_("invalid row index at position %d"), ii);
835                if (i1 > nrow) nrow = i1;
836            }
837        }
838        if (ncol < 0) {
839            for (int jj = 0; jj < nnz; jj++) {
840                int j1 = j[jj] + (index1 ? 0 : 1);
841                if (j1 < 1) error(_("invalid column index at position %d"), jj);
842                if (j1 > ncol) ncol = j1;
843            }
844        }
845        if (dims != (int*)NULL) {
846            if (dims[0] > nrow) nrow = dims[0];
847            if (dims[1] > ncol) ncol = dims[1];
848        }
849        /* check the class name */
850        if (strlen(cls) != 8)
851            error(_("strlen of cls argument = %d, should be 8"), strlen(cls));
852        if (!strcmp(cls + 2, "CMatrix"))
853            error(_("cls = \"%s\" does not end in \"CMatrix\""), cls);
854        switch(cls[0]) {
855        case 'd':
856        case 'l':
857            xtype = CHOLMOD_REAL;
858        break;
859        case 'n':
860            xtype = CHOLMOD_PATTERN;
861            break;
862        default:
863            error(_("cls = \"%s\" must begin with 'd', 'l' or 'n'"), cls);
864        }
865        if (cls[1] != 'g')
866            error(_("Only 'g'eneral sparse matrix types allowed"));
867        /* allocate and populate the triplet */
868        T = cholmod_allocate_triplet((size_t)nrow, (size_t)ncol, (size_t)nnz, 0,
869                                     xtype, &c);
870        T->x = x;
871        tri = (int*)T->i;
872        trj = (int*)T->j;
873        for (int ii = 0; ii < nnz; ii++) {
874            tri[ii] = i[ii] - ((!mi && index1) ? 1 : 0);
875            trj[ii] = j[ii] - ((!mj && index1) ? 1 : 0);
876        }
877        /* create the cholmod_sparse structure */
878        A = cholmod_triplet_to_sparse(T, nnz, &c);
879        cholmod_free_triplet(&T, &c);
880        /* copy the information to the SEXP */
881        ans = PROTECT(NEW_OBJECT(MAKE_CLASS(cls)));
882    /* FIXME: This has been copied from chm_sparse_to_SEXP in chm_common.c */
883        /* allocate and copy common slots */
884        nnz = cholmod_nnz(A, &c);
885        dims = INTEGER(ALLOC_SLOT(ans, Matrix_DimSym, INTSXP, 2));
886        dims[0] = A->nrow; dims[1] = A->ncol;
887        Memcpy(INTEGER(ALLOC_SLOT(ans, Matrix_pSym, INTSXP, A->ncol + 1)), (int*)A->p, A->ncol + 1);
888        Memcpy(INTEGER(ALLOC_SLOT(ans, Matrix_iSym, INTSXP, nnz)), (int*)A->i, nnz);
889        switch(cls[1]) {
890        case 'd':
891            Memcpy(REAL(ALLOC_SLOT(ans, Matrix_xSym, REALSXP, nnz)), (double*)A->x, nnz);
892            break;
893        case 'l':
894            error(_("code not yet written for cls = \"lgCMatrix\""));
895        }
896    /* FIXME: dimnames are *NOT* put there yet (if non-NULL) */
897        cholmod_free_sparse(&A, &c);
898        UNPROTECT(1);
899        return ans;
900    }

Legend:
Removed from v.930  
changed lines
  Added in v.2984

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