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 1657, Wed Nov 1 16:29:53 2006 UTC pkg/Matrix/src/Csparse.c revision 3213, Tue Apr 18 20:14:20 2017 UTC
# Line 1  Line 1 
1                          /* Sparse matrices in compressed column-oriented form */  /** @file Csparse.c
2     * The "CsparseMatrix" class from R package Matrix:
3     *
4     * Sparse matrices in compressed column-oriented form
5     */
6  #include "Csparse.h"  #include "Csparse.h"
7    #include "Tsparse.h"
8  #include "chm_common.h"  #include "chm_common.h"
9    
10  SEXP Csparse_validate(SEXP x)  /** "Cheap" C version of  Csparse_validate() - *not* sorting : */
11    Rboolean isValid_Csparse(SEXP x)
12  {  {
13      /* NB: we do *NOT* check a potential 'x' slot here, at all */      /* NB: we do *NOT* check a potential 'x' slot here, at all */
14      SEXP pslot = GET_SLOT(x, Matrix_pSym),      SEXP pslot = GET_SLOT(x, Matrix_pSym),
15          islot = GET_SLOT(x, Matrix_iSym);          islot = GET_SLOT(x, Matrix_iSym);
16      int j, k, ncol, nrow, sorted,      int *dims = INTEGER(GET_SLOT(x, Matrix_DimSym)), j,
17          *dims = INTEGER(GET_SLOT(x, Matrix_DimSym)),          nrow = dims[0],
18            ncol = dims[1],
19          *xp = INTEGER(pslot),          *xp = INTEGER(pslot),
20          *xi = INTEGER(islot);          *xi = INTEGER(islot);
21    
     nrow = dims[0];  
     ncol = dims[1];  
22      if (length(pslot) != dims[1] + 1)      if (length(pslot) != dims[1] + 1)
23          return mkString(_("slot p must have length = ncol(.) + 1"));          return FALSE;
24      if (xp[0] != 0)      if (xp[0] != 0)
25          return mkString(_("first element of slot p must be zero"));          return FALSE;
26      if (length(islot) != xp[ncol])      if (length(islot) < xp[ncol]) /* allow larger slots from over-allocation!*/
27          return          return FALSE;
28              mkString(_("last element of slot p must match length of slots i and x"));      for (j = 0; j < xp[ncol]; j++) {
     for (j = 0; j < length(islot); j++) {  
29          if (xi[j] < 0 || xi[j] >= nrow)          if (xi[j] < 0 || xi[j] >= nrow)
30              return mkString(_("all row indices must be between 0 and nrow-1"));              return FALSE;
31      }      }
     sorted = TRUE;  
32      for (j = 0; j < ncol; j++) {      for (j = 0; j < ncol; j++) {
33          if (xp[j] > xp[j+1])          if (xp[j] > xp[j+1])
34                return FALSE;
35        }
36        return TRUE;
37    }
38    
39    SEXP Csparse_validate(SEXP x) {
40        return Csparse_validate_(x, FALSE);
41    }
42    
43    
44    #define _t_Csparse_validate
45    #include "t_Csparse_validate.c"
46    
47    #define _t_Csparse_sort
48    #include "t_Csparse_validate.c"
49    
50    // R: .validateCsparse(x, sort.if.needed = FALSE) :
51    SEXP Csparse_validate2(SEXP x, SEXP maybe_modify) {
52        return Csparse_validate_(x, asLogical(maybe_modify));
53    }
54    
55    // R: Matrix:::.sortCsparse(x) :
56    SEXP Csparse_sort (SEXP x) {
57       int ok = Csparse_sort_2(x, TRUE); // modifying x directly
58       if(!ok) warning(_("Csparse_sort(x): x is not a valid (apart from sorting) CsparseMatrix"));
59       return x;
60    }
61    
62    SEXP Rsparse_validate(SEXP x)
63    {
64        /* NB: we do *NOT* check a potential 'x' slot here, at all */
65        SEXP pslot = GET_SLOT(x, Matrix_pSym),
66            jslot = GET_SLOT(x, Matrix_jSym);
67        Rboolean sorted, strictly;
68        int i, k,
69            *dims = INTEGER(GET_SLOT(x, Matrix_DimSym)),
70            nrow = dims[0],
71            ncol = dims[1],
72            *xp = INTEGER(pslot),
73            *xj = INTEGER(jslot);
74    
75        if (length(pslot) != dims[0] + 1)
76            return mkString(_("slot p must have length = nrow(.) + 1"));
77        if (xp[0] != 0)
78            return mkString(_("first element of slot p must be zero"));
79        if (length(jslot) < xp[nrow]) /* allow larger slots from over-allocation!*/
80            return
81                mkString(_("last element of slot p must match length of slots j and x"));
82        for (i = 0; i < length(jslot); i++) {
83            if (xj[i] < 0 || xj[i] >= ncol)
84                return mkString(_("all column indices must be between 0 and ncol-1"));
85        }
86        sorted = TRUE; strictly = TRUE;
87        for (i = 0; i < nrow; i++) {
88            if (xp[i] > xp[i+1])
89              return mkString(_("slot p must be non-decreasing"));              return mkString(_("slot p must be non-decreasing"));
90          for (k = xp[j] + 1; k < xp[j + 1]; k++)          if(sorted)
91              if (xi[k] < xi[k - 1]) sorted = FALSE;              for (k = xp[i] + 1; k < xp[i + 1]; k++) {
92                    if (xj[k] < xj[k - 1])
93                        sorted = FALSE;
94                    else if (xj[k] == xj[k - 1])
95                        strictly = FALSE;
96      }      }
     if (!sorted) {  
         cholmod_sparse *chx = as_cholmod_sparse(x);  
         cholmod_sort(chx, &c);  
         Free(chx);  
97      }      }
98        if (!sorted)
99            /* cannot easily use cholmod_sort(.) ... -> "error out" :*/
100            return mkString(_("slot j is not increasing inside a column"));
101        else if(!strictly) /* sorted, but not strictly */
102            return mkString(_("slot j is not *strictly* increasing inside a column"));
103    
104      return ScalarLogical(1);      return ScalarLogical(1);
105  }  }
106    
107  SEXP Csparse_to_dense(SEXP x)  /** @brief From a CsparseMatrix, produce a dense one.
108     *
109     * Directly deals with symmetric, triangular and general.
110     * Called from ../R/Csparse.R's  C2dense()
111     *
112     * @param x a CsparseMatrix: currently all 9 of  "[dln][gst]CMatrix"
113     * @param symm_or_tri integer (NA, < 0, > 0, = 0) specifying the knowledge of the caller about x:
114     *      NA  : unknown => will be determined
115     *      = 0 : "generalMatrix" (not symm or tri);
116     *      < 0 : "triangularMatrix"
117     *      > 0 : "symmetricMatrix"
118     *
119     * @return a "denseMatrix"
120     */
121    SEXP Csparse_to_dense(SEXP x, SEXP symm_or_tri)
122  {  {
123      cholmod_sparse *chxs = as_cholmod_sparse(x);      Rboolean is_sym, is_tri;
124      cholmod_dense *chxd = cholmod_sparse_to_dense(chxs, &c);      int is_sym_or_tri = asInteger(symm_or_tri),
125            ctype = 0; // <- default = "dgC"
126      Free(chxs);      static const char *valid[] = { MATRIX_VALID_Csparse, ""};
127      return chm_dense_to_SEXP(chxd, 1, Real_kind(x));      if(is_sym_or_tri == NA_INTEGER) { // find if  is(x, "symmetricMatrix") :
128            ctype = R_check_class_etc(x, valid);
129            is_sym = (ctype % 3 == 1);
130            is_tri = (ctype % 3 == 2);
131        } else {
132            is_sym = is_sym_or_tri > 0;
133            is_tri = is_sym_or_tri < 0;
134            // => both are FALSE  iff  is_.. == 0
135            if(is_sym || is_tri)
136                ctype = R_check_class_etc(x, valid);
137        }
138        CHM_SP chxs = AS_CHM_SP__(x);// -> chxs->stype = +- 1 <==> symmetric
139        R_CheckStack();
140        if(is_tri && *diag_P(x) == 'U') { // ==>  x := diagU2N(x), directly for chxs
141            CHM_SP eye = cholmod_speye(chxs->nrow, chxs->ncol, chxs->xtype, &c);
142            double one[] = {1, 0};
143            CHM_SP ans = cholmod_add(chxs, eye, one, one,
144                                     /* values: */ ((ctype / 3) != 2), // TRUE iff not "nMatrix"
145                                     TRUE, &c);
146            cholmod_free_sparse(&eye, &c);
147            chxs = cholmod_copy_sparse(ans, &c);
148            cholmod_free_sparse(&ans, &c);
149        }
150        /* The following loses the symmetry property, since cholmod_dense has none,
151         * BUT, much worse (FIXME!), it also transforms CHOLMOD_PATTERN ("n") matrices
152         * to numeric (CHOLMOD_REAL) ones {and we "revert" via chm_dense_to_SEXP()}: */
153        CHM_DN chxd = cholmod_sparse_to_dense(chxs, &c);
154        /* FIXME: The above FAILS for prod(dim(.)) > INT_MAX
155         * ----
156         * TODO: use cholmod_l_* but also the 'cl' global ==> many changes in chm_common.[ch]
157         * >>>>>>>>>>> TODO <<<<<<<<<<<<
158         * CHM_DN chxd = cholmod_l_sparse_to_dense(chxs, &cl); */
159        //                   ^^^ important when prod(dim(.)) > INT_MAX
160        int Rkind = (chxs->xtype == CHOLMOD_PATTERN)? -1 : Real_kind(x);
161    
162        SEXP ans = chm_dense_to_SEXP(chxd, 1, Rkind, GET_SLOT(x, Matrix_DimNamesSym),
163                                     /* transp: */ FALSE);
164        // -> a [dln]geMatrix
165        if(is_sym) { // ==> want  [dln]syMatrix
166            const char cl1 = class_P(ans)[0];
167            PROTECT(ans);
168            SEXP aa = PROTECT(NEW_OBJECT(MAKE_CLASS((cl1 == 'd') ? "dsyMatrix" :
169                                                    ((cl1 == 'l') ? "lsyMatrix" : "nsyMatrix"))));
170            // No need to duplicate() as slots of ans are freshly allocated and ans will not be used
171            SET_SLOT(aa, Matrix_xSym,       GET_SLOT(ans, Matrix_xSym));
172            SET_SLOT(aa, Matrix_DimSym,     GET_SLOT(ans, Matrix_DimSym));
173            SET_SLOT(aa, Matrix_DimNamesSym,GET_SLOT(ans, Matrix_DimNamesSym));
174            SET_SLOT(aa, Matrix_uploSym, mkString((chxs->stype > 0) ? "U" : "L"));
175            UNPROTECT(2);
176            return aa;
177        }
178        else if(is_tri) { // ==> want  [dln]trMatrix
179            const char cl1 = class_P(ans)[0];
180            PROTECT(ans);
181            SEXP aa = PROTECT(NEW_OBJECT(MAKE_CLASS((cl1 == 'd') ? "dtrMatrix" :
182                                                    ((cl1 == 'l') ? "ltrMatrix" : "ntrMatrix"))));
183            // No need to duplicate() as slots of ans are freshly allocated and ans will not be used
184            SET_SLOT(aa, Matrix_xSym,       GET_SLOT(ans, Matrix_xSym));
185            SET_SLOT(aa, Matrix_DimSym,     GET_SLOT(ans, Matrix_DimSym));
186            SET_SLOT(aa, Matrix_DimNamesSym,GET_SLOT(ans, Matrix_DimNamesSym));
187            slot_dup(aa, x, Matrix_uploSym);
188            /* already by NEW_OBJECT(..) above:
189               SET_SLOT(aa, Matrix_diagSym, mkString("N")); */
190            UNPROTECT(2);
191            return aa;
192        }
193        else
194            return ans;
195  }  }
196    
197    // FIXME: do not go via CHM (should not be too hard, to just *drop* the x-slot, right?
198    SEXP Csparse2nz(SEXP x, Rboolean tri)
199    {
200        CHM_SP chxs = AS_CHM_SP__(x);
201        CHM_SP chxcp = cholmod_copy(chxs, chxs->stype, CHOLMOD_PATTERN, &c);
202        R_CheckStack();
203    
204        return chm_sparse_to_SEXP(chxcp, 1/*do_free*/,
205                                  tri ? ((*uplo_P(x) == 'U') ? 1 : -1) : 0,
206                                  /* Rkind: pattern */ 0,
207                                  /* diag = */ tri ? diag_P(x) : "",
208                                  GET_SLOT(x, Matrix_DimNamesSym));
209    }
210  SEXP Csparse_to_nz_pattern(SEXP x, SEXP tri)  SEXP Csparse_to_nz_pattern(SEXP x, SEXP tri)
211  {  {
212      cholmod_sparse *chxs = as_cholmod_sparse(x);      int tr_ = asLogical(tri);
213      cholmod_sparse      if(tr_ == NA_LOGICAL) {
214          *chxcp = cholmod_copy(chxs, chxs->stype, CHOLMOD_PATTERN, &c);          warning(_("Csparse_to_nz_pattern(x, tri = NA): 'tri' is taken as TRUE"));
215      int uploT = 0; char *diag = "";          tr_ = TRUE;
   
     Free(chxs);  
     if (asLogical(tri)) {       /* triangular sparse matrices */  
         uploT = (strcmp(CHAR(asChar(GET_SLOT(x, Matrix_uploSym))), "U")) ?  
             -1 : 1;  
         diag = CHAR(asChar(GET_SLOT(x, Matrix_diagSym)));  
216      }      }
217      return chm_sparse_to_SEXP(chxcp, 1, uploT, 0, diag,      return Csparse2nz(x, (Rboolean) tr_);
                               GET_SLOT(x, Matrix_DimNamesSym));  
218  }  }
219    
220  SEXP Csparse_to_matrix(SEXP x)  // n.CMatrix --> [dli].CMatrix  (not going through CHM!)
221    SEXP nz_pattern_to_Csparse(SEXP x, SEXP res_kind)
222  {  {
223      cholmod_sparse *chxs = as_cholmod_sparse(x);      return nz2Csparse(x, asInteger(res_kind));
224      cholmod_dense *chxd = cholmod_sparse_to_dense(chxs, &c);  }
225    
226      Free(chxs);  // n.CMatrix --> [dli].CMatrix  (not going through CHM!)
227      return chm_dense_to_matrix(chxd, 1,  // NOTE: use chm_MOD_xtype(() to change type of  'cholmod_sparse' matrix
228                                 GET_SLOT(x, Matrix_DimNamesSym));  SEXP nz2Csparse(SEXP x, enum x_slot_kind r_kind)
229    {
230        const char *cl_x = class_P(x);
231        // quick check - if ok, fast
232        if(cl_x[0] != 'n' || cl_x[2] != 'C') {
233            // e.g. class = "A", from  setClass("A", contains = "ngCMatrix")
234            static const char *valid[] = { MATRIX_VALID_nCsparse, ""};
235            int ctype = R_check_class_etc(x, valid);
236            if(ctype < 0)
237                error(_("not a 'n.CMatrix'"));
238            else // fine : get a valid  cl_x  class_P()-like string :
239                cl_x = valid[ctype];
240        }
241        int nnz = LENGTH(GET_SLOT(x, Matrix_iSym));
242        SEXP ans;
243        char *ncl = alloca(strlen(cl_x) + 1); /* not much memory required */
244        strcpy(ncl, cl_x);
245        double *dx_x; int *ix_x;
246        ncl[0] = (r_kind == x_double ? 'd' :
247                  (r_kind == x_logical ? 'l' :
248                   /* else (for now):  r_kind == x_integer : */ 'i'));
249        PROTECT(ans = NEW_OBJECT(MAKE_CLASS(ncl)));
250        // create a correct 'x' slot:
251        switch(r_kind) {
252            int i;
253        case x_double: // 'd'
254            dx_x = REAL(ALLOC_SLOT(ans, Matrix_xSym, REALSXP, nnz));
255            for (i=0; i < nnz; i++) dx_x[i] = 1.;
256            break;
257        case x_logical: // 'l'
258            ix_x = LOGICAL(ALLOC_SLOT(ans, Matrix_xSym, LGLSXP, nnz));
259            for (i=0; i < nnz; i++) ix_x[i] = TRUE;
260            break;
261        case x_integer: // 'i'
262            ix_x = INTEGER(ALLOC_SLOT(ans, Matrix_xSym, INTSXP, nnz));
263            for (i=0; i < nnz; i++) ix_x[i] = 1;
264            break;
265    
266        default:
267            error(_("nz2Csparse(): invalid/non-implemented r_kind = %d"),
268                  r_kind);
269        }
270    
271        // now copy all other slots :
272        slot_dup(ans, x, Matrix_iSym);
273        slot_dup(ans, x, Matrix_pSym);
274        slot_dup(ans, x, Matrix_DimSym);
275        slot_dup(ans, x, Matrix_DimNamesSym);
276        if(ncl[1] != 'g') { // symmetric or triangular ...
277            slot_dup_if_has(ans, x, Matrix_uploSym);
278            slot_dup_if_has(ans, x, Matrix_diagSym);
279        }
280        UNPROTECT(1);
281        return ans;
282    }
283    
284    SEXP Csparse_to_matrix(SEXP x, SEXP chk, SEXP symm)
285    {
286        int is_sym = asLogical(symm);
287        if(is_sym == NA_LOGICAL) { // find if  is(x, "symmetricMatrix") :
288            static const char *valid[] = { MATRIX_VALID_Csparse, ""};
289            int ctype = R_check_class_etc(x, valid);
290            is_sym = (ctype % 3 == 1);
291        }
292        return chm_dense_to_matrix(
293            cholmod_sparse_to_dense(AS_CHM_SP2(x, asLogical(chk)), &c),
294            1 /*do_free*/,
295            (is_sym
296             ? symmetric_DimNames(GET_SLOT(x, Matrix_DimNamesSym))
297             :                    GET_SLOT(x, Matrix_DimNamesSym)));
298    }
299    
300    SEXP Csparse_to_vector(SEXP x)
301    {
302        return chm_dense_to_vector(cholmod_sparse_to_dense(AS_CHM_SP__(x), &c), 1);
303  }  }
304    
305  SEXP Csparse_to_Tsparse(SEXP x, SEXP tri)  SEXP Csparse_to_Tsparse(SEXP x, SEXP tri)
306  {  {
307      cholmod_sparse *chxs = as_cholmod_sparse(x);      CHM_SP chxs = AS_CHM_SP__(x);
308      cholmod_triplet *chxt = cholmod_sparse_to_triplet(chxs, &c);      CHM_TR chxt = cholmod_sparse_to_triplet(chxs, &c);
309      int uploT = 0;      int tr = asLogical(tri);
310      char *diag = "";      int Rkind = (chxs->xtype != CHOLMOD_PATTERN) ? Real_kind(x) : 0;
311      int Rkind = (chxs->xtype == CHOLMOD_REAL) ? Real_kind(x) : 0;      R_CheckStack();
312    
313        return chm_triplet_to_SEXP(chxt, 1,
314                                   tr ? ((*uplo_P(x) == 'U') ? 1 : -1) : 0,
315                                   Rkind, tr ? diag_P(x) : "",
316                                   GET_SLOT(x, Matrix_DimNamesSym));
317    }
318    
319      Free(chxs);  SEXP Csparse_to_tCsparse(SEXP x, SEXP uplo, SEXP diag)
320      if (asLogical(tri)) {       /* triangular sparse matrices */  {
321          uploT = (*uplo_P(x) == 'U') ? -1 : 1;      CHM_SP chxs = AS_CHM_SP__(x);
322          diag = diag_P(x);      int Rkind = (chxs->xtype != CHOLMOD_PATTERN) ? Real_kind(x) : 0;
323        R_CheckStack();
324        return chm_sparse_to_SEXP(chxs, /* dofree = */ 0,
325                                  /* uploT = */ (*CHAR(asChar(uplo)) == 'U')? 1: -1,
326                                   Rkind, /* diag = */ CHAR(STRING_ELT(diag, 0)),
327                                   GET_SLOT(x, Matrix_DimNamesSym));
328      }      }
329      return chm_triplet_to_SEXP(chxt, 1, uploT, Rkind, diag,  
330    SEXP Csparse_to_tTsparse(SEXP x, SEXP uplo, SEXP diag)
331    {
332        CHM_SP chxs = AS_CHM_SP__(x);
333        CHM_TR chxt = cholmod_sparse_to_triplet(chxs, &c);
334        int Rkind = (chxs->xtype != CHOLMOD_PATTERN) ? Real_kind(x) : 0;
335        R_CheckStack();
336        return chm_triplet_to_SEXP(chxt, 1,
337                                  /* uploT = */ (*CHAR(asChar(uplo)) == 'U')? 1: -1,
338                                   Rkind, /* diag = */ CHAR(STRING_ELT(diag, 0)),
339                                 GET_SLOT(x, Matrix_DimNamesSym));                                 GET_SLOT(x, Matrix_DimNamesSym));
340  }  }
341    
342  /* this used to be called  sCMatrix_to_gCMatrix(..)   [in ./dsCMatrix.c ]: */  
343  SEXP Csparse_symmetric_to_general(SEXP x)  SEXP Csparse_symmetric_to_general(SEXP x)
344  {  {
345      cholmod_sparse *chx = as_cholmod_sparse(x), *chgx;      CHM_SP chx = AS_CHM_SP__(x), chgx;
346      int Rkind = (chx->xtype == CHOLMOD_REAL) ? Real_kind(x) : 0;      int Rkind = (chx->xtype != CHOLMOD_PATTERN) ? Real_kind(x) : 0;
347        R_CheckStack();
348    
349      if (!(chx->stype))      if (!(chx->stype))
350          error(_("Nonsymmetric matrix in Csparse_symmetric_to_general"));          error(_("Nonsymmetric matrix in Csparse_symmetric_to_general"));
351      chgx = cholmod_copy(chx, /* stype: */ 0, chx->xtype, &c);      chgx = cholmod_copy(chx, /* stype: */ 0, chx->xtype, &c);
352      /* xtype: pattern, "real", complex or .. */      /* xtype: pattern, "real", complex or .. */
     Free(chx);  
353      return chm_sparse_to_SEXP(chgx, 1, 0, Rkind, "",      return chm_sparse_to_SEXP(chgx, 1, 0, Rkind, "",
354                                GET_SLOT(x, Matrix_DimNamesSym));                                symmetric_DimNames(GET_SLOT(x, Matrix_DimNamesSym)));
355  }  }
356    
357  SEXP Csparse_general_to_symmetric(SEXP x, SEXP uplo)  SEXP Csparse_general_to_symmetric(SEXP x, SEXP uplo, SEXP sym_dmns)
358  {  {
359      cholmod_sparse *chx = as_cholmod_sparse(x), *chgx;      int *adims = INTEGER(GET_SLOT(x, Matrix_DimSym)), n = adims[0];
360      int uploT = (*CHAR(asChar(uplo)) == 'U') ? -1 : 1;      if(n != adims[1]) {
361      int Rkind = (chx->xtype == CHOLMOD_REAL) ? Real_kind(x) : 0;          error(_("Csparse_general_to_symmetric(): matrix is not square!"));
362            return R_NilValue; /* -Wall */
363        }
364        CHM_SP chx = AS_CHM_SP__(x), chgx;
365        int uploT = (*CHAR(asChar(uplo)) == 'U') ? 1 : -1;
366        int Rkind = (chx->xtype != CHOLMOD_PATTERN) ? Real_kind(x) : 0;
367        R_CheckStack();
368      chgx = cholmod_copy(chx, /* stype: */ uploT, chx->xtype, &c);      chgx = cholmod_copy(chx, /* stype: */ uploT, chx->xtype, &c);
369    
370        SEXP dns = GET_SLOT(x, Matrix_DimNamesSym);
371        if(asLogical(sym_dmns))
372            dns = symmetric_DimNames(dns);
373        else if((!isNull(VECTOR_ELT(dns, 0)) &&
374                 !isNull(VECTOR_ELT(dns, 1))) ||
375                !isNull(getAttrib(dns, R_NamesSymbol))) {
376            /* symmetrize them if both are not NULL
377             * or names(dimnames(.)) is asymmetric : */
378            dns = PROTECT(duplicate(dns));
379            if(!equal_string_vectors(VECTOR_ELT(dns, 0),
380                                     VECTOR_ELT(dns, 1))) {
381                if(uploT == 1)
382                    SET_VECTOR_ELT(dns, 0, VECTOR_ELT(dns,1));
383                else
384                    SET_VECTOR_ELT(dns, 1, VECTOR_ELT(dns,0));
385            }
386            SEXP nms_dns = getAttrib(dns, R_NamesSymbol);
387            if(!isNull(nms_dns) &&  // names(dimnames(.)) :
388               !R_compute_identical(STRING_ELT(nms_dns, 0),
389                                    STRING_ELT(nms_dns, 1), 16)) {
390                if(uploT == 1)
391                    SET_STRING_ELT(nms_dns, 0, STRING_ELT(nms_dns,1));
392                else
393                    SET_STRING_ELT(nms_dns, 1, STRING_ELT(nms_dns,0));
394                setAttrib(dns, R_NamesSymbol, nms_dns);
395            }
396            UNPROTECT(1);
397        }
398      /* xtype: pattern, "real", complex or .. */      /* xtype: pattern, "real", complex or .. */
399      Free(chx);      return chm_sparse_to_SEXP(chgx, 1, 0, Rkind, "", dns);
     return chm_sparse_to_SEXP(chgx, 1, 0, Rkind, "",  
                               GET_SLOT(x, Matrix_DimNamesSym));  
400  }  }
401    
402  SEXP Csparse_transpose(SEXP x, SEXP tri)  SEXP Csparse_transpose(SEXP x, SEXP tri)
403  {  {
404      cholmod_sparse *chx = as_cholmod_sparse(x);      /* TODO: lgCMatrix & igC* currently go via double prec. cholmod -
405      int Rkind = (chx->xtype == CHOLMOD_REAL) ? Real_kind(x) : 0;       *       since cholmod (& cs) lacks sparse 'int' matrices */
406      cholmod_sparse *chxt = cholmod_transpose(chx, (int) chx->xtype, &c);      CHM_SP chx = AS_CHM_SP__(x);
407        int Rkind = (chx->xtype != CHOLMOD_PATTERN) ? Real_kind(x) : 0;
408        CHM_SP chxt = cholmod_transpose(chx, chx->xtype, &c);
409      SEXP dn = PROTECT(duplicate(GET_SLOT(x, Matrix_DimNamesSym))), tmp;      SEXP dn = PROTECT(duplicate(GET_SLOT(x, Matrix_DimNamesSym))), tmp;
410      int uploT = 0; char *diag = "";      int tr = asLogical(tri);
411        R_CheckStack();
412    
     Free(chx);  
413      tmp = VECTOR_ELT(dn, 0);    /* swap the dimnames */      tmp = VECTOR_ELT(dn, 0);    /* swap the dimnames */
414      SET_VECTOR_ELT(dn, 0, VECTOR_ELT(dn, 1));      SET_VECTOR_ELT(dn, 0, VECTOR_ELT(dn, 1));
415      SET_VECTOR_ELT(dn, 1, tmp);      SET_VECTOR_ELT(dn, 1, tmp);
416        tmp = PROTECT(getAttrib(dn, R_NamesSymbol));
417        if(!isNull(tmp)) { // swap names(dimnames(.)):
418            SEXP nms_dns = PROTECT(allocVector(VECSXP, 2));
419            SET_VECTOR_ELT(nms_dns, 1, STRING_ELT(tmp, 0));
420            SET_VECTOR_ELT(nms_dns, 0, STRING_ELT(tmp, 1));
421            setAttrib(dn, R_NamesSymbol, nms_dns);
422      UNPROTECT(1);      UNPROTECT(1);
     if (asLogical(tri)) {       /* triangular sparse matrices */  
         uploT = (*uplo_P(x) == 'U') ? -1 : 1;  
         diag = diag_P(x);  
     }  
     return chm_sparse_to_SEXP(chxt, 1, uploT, Rkind, diag, dn);  
423  }  }
424    
425  SEXP Csparse_Csparse_prod(SEXP a, SEXP b)      SEXP ans = chm_sparse_to_SEXP(chxt, 1, /* SWAP 'uplo' for triangular */
426                                      tr ? ((*uplo_P(x) == 'U') ? -1 : 1) : 0,
427                                      Rkind, tr ? diag_P(x) : "", dn);
428        UNPROTECT(2);
429        return ans;
430    }
431    
432    /** @brief  A %*% B  - for matrices of class CsparseMatrix (R package "Matrix")
433     *
434     * @param a
435     * @param b
436     * @param bool_arith
437     *
438     * @return
439     *
440     * NOTA BENE:  cholmod_ssmult(A,B, ...) ->  ./CHOLMOD/MatrixOps/cholmod_ssmult.c
441     * ---------  computes a patter*n* matrix __always_ when
442     * *one* of A or B is pattern*n*, because of this (line 73-74):
443       ---------------------------------------------------------------------------
444        values = values &&
445            (A->xtype != CHOLMOD_PATTERN) && (B->xtype != CHOLMOD_PATTERN) ;
446       ---------------------------------------------------------------------------
447     * ==> Often need to copy the patter*n* to a *l*ogical matrix first !!!
448     */
449    SEXP Csparse_Csparse_prod(SEXP a, SEXP b, SEXP bool_arith)
450  {  {
451      cholmod_sparse *cha = as_cholmod_sparse(a),      CHM_SP
452          *chb = as_cholmod_sparse(b);          cha = AS_CHM_SP(a),
453      cholmod_sparse *chc = cholmod_ssmult(cha, chb, 0, cha->xtype, 1, &c);          chb = AS_CHM_SP(b), chc;
454      SEXP dn = allocVector(VECSXP, 2);      R_CheckStack();
455        static const char *valid_tri[] = { MATRIX_VALID_tri_Csparse, "" };
456        char diag[] = {'\0', '\0'};
457        int uploT = 0, nprot = 1,
458            do_bool = asLogical(bool_arith); // TRUE / NA / FALSE
459        Rboolean
460            a_is_n = (cha->xtype == CHOLMOD_PATTERN),
461            b_is_n = (chb->xtype == CHOLMOD_PATTERN),
462            force_num = (do_bool == FALSE),
463            maybe_bool= (do_bool == NA_LOGICAL);
464    
465    #ifdef DEBUG_Matrix_verbose
466        Rprintf("DBG Csparse_C*_prod(%s, %s)\n", class_P(a), class_P(b));
467    #endif
468    
469        if(a_is_n && (force_num || (maybe_bool && !b_is_n))) {
470            /* coerce 'a' to  double;
471             * have no CHOLMOD function (pattern -> logical) --> use "our" code */
472            SEXP da = PROTECT(nz2Csparse(a, x_double)); nprot++;
473            cha = AS_CHM_SP(da);
474            R_CheckStack();
475            a_is_n = FALSE;
476        }
477        else if(b_is_n && (force_num || (maybe_bool && !a_is_n))) {
478            // coerce 'b' to  double
479            SEXP db = PROTECT(nz2Csparse(b, x_double)); nprot++;
480            chb = AS_CHM_SP(db);
481            R_CheckStack();
482            b_is_n = FALSE;
483        }
484        chc = cholmod_ssmult(cha, chb, /*out_stype:*/ 0,
485                             /* values : */ do_bool != TRUE,
486                             /* sorted = TRUE: */ 1, &c);
487    
488        /* Preserve triangularity and even unit-triangularity if appropriate.
489         * Note that in that case, the multiplication itself should happen
490         * faster.  But there's no support for that in CHOLMOD */
491    
492        if(R_check_class_etc(a, valid_tri) >= 0 &&
493           R_check_class_etc(b, valid_tri) >= 0)
494            if(*uplo_P(a) == *uplo_P(b)) { /* both upper, or both lower tri. */
495                uploT = (*uplo_P(a) == 'U') ? 1 : -1;
496                if(*diag_P(a) == 'U' && *diag_P(b) == 'U') { /* return UNIT-triag. */
497                    /* "remove the diagonal entries": */
498                    chm_diagN2U(chc, uploT, /* do_realloc */ FALSE);
499                    diag[0]= 'U';
500                }
501                else diag[0]= 'N';
502            }
503    
504      Free(cha); Free(chb);      SEXP dn = PROTECT(allocVector(VECSXP, 2));
505      SET_VECTOR_ELT(dn, 0,       /* establish dimnames */      SET_VECTOR_ELT(dn, 0,       /* establish dimnames */
506                     duplicate(VECTOR_ELT(GET_SLOT(a, Matrix_DimNamesSym), 0)));                     duplicate(VECTOR_ELT(GET_SLOT(a, Matrix_DimNamesSym), 0)));
507      SET_VECTOR_ELT(dn, 1,      SET_VECTOR_ELT(dn, 1,
508                     duplicate(VECTOR_ELT(GET_SLOT(b, Matrix_DimNamesSym), 1)));                     duplicate(VECTOR_ELT(GET_SLOT(b, Matrix_DimNamesSym), 1)));
509      return chm_sparse_to_SEXP(chc, 1, 0, 0, "", dn);      UNPROTECT(nprot);
510        return chm_sparse_to_SEXP(chc, 1, uploT, /*Rkind*/0, diag, dn);
511  }  }
512    
513  SEXP Csparse_Csparse_crossprod(SEXP a, SEXP b)  /** @brief [t]crossprod (<Csparse>, <Csparse>)
514     *
515     * @param a a "CsparseMatrix" object
516     * @param b a "CsparseMatrix" object
517     * @param trans trans = FALSE:  crossprod(a,b)
518     *              trans = TRUE : tcrossprod(a,b)
519     * @param bool_arith logical (TRUE / NA / FALSE): Should boolean arithmetic be used.
520     *
521     * @return a CsparseMatrix, the (t)cross product of a and b.
522     */
523    SEXP Csparse_Csparse_crossprod(SEXP a, SEXP b, SEXP trans, SEXP bool_arith)
524  {  {
525      cholmod_sparse *cha = as_cholmod_sparse(a),      int tr = asLogical(trans), nprot = 1,
526          *chb = as_cholmod_sparse(b);          do_bool = asLogical(bool_arith); // TRUE / NA / FALSE
527      cholmod_sparse *chta = cholmod_transpose(cha, 1, &c);      CHM_SP
528      cholmod_sparse *chc = cholmod_ssmult(chta, chb, 0, cha->xtype, 1, &c);          cha = AS_CHM_SP(a),
529      SEXP dn = allocVector(VECSXP, 2);          chb = AS_CHM_SP(b),
530            chTr, chc;
531        R_CheckStack();
532        static const char *valid_tri[] = { MATRIX_VALID_tri_Csparse, "" };
533        char diag[] = {'\0', '\0'};
534        int uploT = 0;
535        Rboolean
536            a_is_n = (cha->xtype == CHOLMOD_PATTERN),
537            b_is_n = (chb->xtype == CHOLMOD_PATTERN),
538            force_num = (do_bool == FALSE),
539            maybe_bool= (do_bool == NA_LOGICAL);
540    
541        if(a_is_n && (force_num || (maybe_bool && !b_is_n))) {
542            // coerce 'a' to  double
543            SEXP da = PROTECT(nz2Csparse(a, x_double)); nprot++;
544            cha = AS_CHM_SP(da);
545            R_CheckStack();
546            // a_is_n = FALSE;
547        }
548        else if(b_is_n && (force_num || (maybe_bool && !a_is_n))) {
549            // coerce 'b' to  double
550            SEXP db = PROTECT(nz2Csparse(b, x_double)); nprot++;
551            chb = AS_CHM_SP(db);
552            R_CheckStack();
553            // b_is_n = FALSE;
554        }
555        else if(do_bool == TRUE) { // Want boolean arithmetic: sufficient if *one* is pattern:
556            if(!a_is_n && !b_is_n) {
557                // coerce 'a' to pattern
558                SEXP da = PROTECT(Csparse2nz(a, /* tri = */
559                                             R_check_class_etc(a, valid_tri) >= 0)); nprot++;
560                cha = AS_CHM_SP(da);
561                R_CheckStack();
562                // a_is_n = TRUE;
563            }
564        }
565        chTr = cholmod_transpose((tr) ? chb : cha, chb->xtype, &c);
566        chc = cholmod_ssmult((tr) ? cha : chTr, (tr) ? chTr : chb,
567                             /*out_stype:*/ 0, /* values : */ do_bool != TRUE,
568                             /* sorted = TRUE: */ 1, &c);
569        cholmod_free_sparse(&chTr, &c);
570    
571        /* Preserve triangularity and unit-triangularity if appropriate;
572         * see Csparse_Csparse_prod() for comments */
573        if(R_check_class_etc(a, valid_tri) >= 0 &&
574           R_check_class_etc(b, valid_tri) >= 0)
575            if(*uplo_P(a) != *uplo_P(b)) { /* one 'U', the other 'L' */
576                uploT = (*uplo_P(b) == 'U') ? 1 : -1;
577                if(*diag_P(a) == 'U' && *diag_P(b) == 'U') { /* return UNIT-triag. */
578                    chm_diagN2U(chc, uploT, /* do_realloc */ FALSE);
579                    diag[0]= 'U';
580                }
581                else diag[0]= 'N';
582            }
583    
584      Free(cha); Free(chb); cholmod_free_sparse(&chta, &c);      SEXP dn = PROTECT(allocVector(VECSXP, 2));
585      SET_VECTOR_ELT(dn, 0,       /* establish dimnames */      SET_VECTOR_ELT(dn, 0,       /* establish dimnames */
586                     duplicate(VECTOR_ELT(GET_SLOT(a, Matrix_DimNamesSym), 1)));                     duplicate(VECTOR_ELT(GET_SLOT(a, Matrix_DimNamesSym),
587                                            (tr) ? 0 : 1)));
588      SET_VECTOR_ELT(dn, 1,      SET_VECTOR_ELT(dn, 1,
589                     duplicate(VECTOR_ELT(GET_SLOT(b, Matrix_DimNamesSym), 1)));                     duplicate(VECTOR_ELT(GET_SLOT(b, Matrix_DimNamesSym),
590      return chm_sparse_to_SEXP(chc, 1, 0, 0, "", dn);                                          (tr) ? 0 : 1)));
591        UNPROTECT(nprot);
592        return chm_sparse_to_SEXP(chc, 1, uploT, /*Rkind*/0, diag, dn);
593    }
594    
595    /**
596     * All (dense * sparse)  Matrix products and cross products
597     *
598     *   f( f(<Csparse>)  %*%  f(<dense>) )   where  f ()  is either t () [tranpose] or the identity.
599     *
600     * @param a CsparseMatrix  (n x m)
601     * @param b numeric vector, matrix, or denseMatrix (m x k) or (k x m)  if `transp` is '2' or 'B'
602     * @param transp character.
603     *        = " " : nothing transposed {apart from a}
604     *        = "2" : "transpose 2nd arg": use  t(b) instead of b (= 2nd argument)
605     *        = "c" : "transpose c":       Return  t(c) instead of c
606     *        = "B" : "transpose both":    use t(b) and return t(c) instead of c
607     * NB: For "2", "c", "B", need to transpose a *dense* matrix, B or C --> chm_transpose_dense()
608     *
609     * @return a dense matrix, the matrix product c = g(a,b) :
610     *
611     *                                                Condition (R)   Condition (C)
612     *   R notation            Math notation          cross  transp   t.a t.b t.ans
613     *   ~~~~~~~~~~~~~~~~~     ~~~~~~~~~~~~~~~~~~     ~~~~~~~~~~~~~   ~~~~~~~~~~~~~
614     *   c <-   a %*%   b      C :=      A B            .       " "    .   .   .
615     *   c <-   a %*% t(b)     C :=      A B'           .       "2"    .   |   .
616     *   c <- t(a %*%   b)     C := (A B)'  = B'A'      .       "c"    .   .   |
617     *   c <- t(a %*% t(b))    C := (A B')' = B A'      .       "B"    .   |   |
618     *
619     *   c <-   t(a) %*%   b   C :=      A'B           TRUE     " "    |   .   .
620     *   c <-   t(a) %*% t(b)  C :=      A'B'          TRUE     "2"    |   |   .
621     *   c <- t(t(a) %*%   b)  C := (A'B)'  = B'A      TRUE     "c"    |   .   |
622     *   c <- t(t(a) %*% t(b)) C := (A'B')' = B A      TRUE     "B"    |   |   |
623     */
624    SEXP Csp_dense_products(SEXP a, SEXP b,
625                            Rboolean transp_a, Rboolean transp_b, Rboolean transp_ans)
626    {
627        CHM_SP cha = AS_CHM_SP(a);
628        int a_nc = transp_a ? cha->nrow : cha->ncol,
629            a_nr = transp_a ? cha->ncol : cha->nrow;
630        Rboolean
631            maybe_transp_b = (a_nc == 1),
632            b_is_vector = FALSE;
633        /* NOTE: trans_b {<--> "use t(b) instead of b" }
634           ----  "interferes" with the  case automatic treatment of *vector* b.
635           In that case,  t(b) or b is used "whatever make more sense",
636           according to the general R philosophy of treating vectors in matrix products.
637        */
638    
639        /* repeating a "cheap part" of  mMatrix_as_dgeMatrix2(b, .)  to see if
640         * we have a vector that we might 'transpose_if_vector' : */
641        static const char *valid[] = {"_NOT_A_CLASS_", MATRIX_VALID_ddense, ""};
642        /* int ctype = R_check_class_etc(b, valid);
643         * if (ctype > 0)   /.* a ddenseMatrix object */
644        if (R_check_class_etc(b, valid) < 0) {
645            // not a ddenseM*:  is.matrix() or vector:
646            b_is_vector = !isMatrix(b);
647        }
648    
649        if(b_is_vector) {
650            /* determine *if* we want/need to transpose at all:
651             * if (length(b) == ncol(A)) have match: use dim = c(n, 1) (<=> do *not* transp);
652             *  otherwise, try to transpose: ok  if (ncol(A) == 1) [see also above]:  */
653            maybe_transp_b = (LENGTH(b) != a_nc);
654            // Here, we transpose already in mMatrix_as_dge*()  ==> don't do it later:
655            transp_b = FALSE;
656        }
657        SEXP b_M = PROTECT(mMatrix_as_dgeMatrix2(b, maybe_transp_b));
658    
659        CHM_DN chb = AS_CHM_DN(b_M), b_t;
660        R_CheckStack();
661        int ncol_b;
662        if(transp_b) { // transpose b:
663            b_t = cholmod_allocate_dense(chb->ncol, chb->nrow, chb->ncol, chb->xtype, &c);
664            chm_transpose_dense(b_t, chb);
665            ncol_b = b_t->ncol;
666        } else
667            ncol_b = chb->ncol;
668        // Result C {with dim() before it may be transposed}:
669        CHM_DN chc = cholmod_allocate_dense(a_nr, ncol_b, a_nr, chb->xtype, &c);
670        double one[] = {1,0}, zero[] = {0,0};
671        int nprot = 2;
672    
673        /* Tim Davis, please FIXME:  currently (2010-11) *fails* when  a  is a pattern matrix:*/
674        if(cha->xtype == CHOLMOD_PATTERN) {
675            /* warning(_("Csparse_dense_prod(): cholmod_sdmult() not yet implemented for pattern./ ngCMatrix" */
676            /*        " --> slightly inefficient coercion")); */
677    
678            // This *fails* to produce a CHOLMOD_REAL ..
679            // CHM_SP chd = cholmod_l_copy(cha, cha->stype, CHOLMOD_REAL, &c);
680            // --> use our Matrix-classes
681            SEXP da = PROTECT(nz2Csparse(a, x_double)); nprot++;
682            cha = AS_CHM_SP(da);
683        }
684    
685        /* cholmod_sdmult(A, transp, alpha, beta, X,  Y,  &c): depending on transp == 0 / != 0:
686         *  Y := alpha*(A*X) + beta*Y or alpha*(A'*X) + beta*Y;  here, alpha = 1, beta = 0:
687         *  Y := A*X  or  A'*X
688         *                       NB: always  <sparse> %*% <dense> !
689         */
690        cholmod_sdmult(cha, transp_a, one, zero, (transp_b ? b_t : chb), /* -> */ chc, &c);
691    
692        SEXP dn = PROTECT(allocVector(VECSXP, 2));  /* establish dimnames */
693        SET_VECTOR_ELT(dn, transp_ans ? 1 : 0,
694                       duplicate(VECTOR_ELT(GET_SLOT(a, Matrix_DimNamesSym), transp_a ? 1 : 0)));
695        SET_VECTOR_ELT(dn, transp_ans ? 0 : 1,
696                       duplicate(VECTOR_ELT(GET_SLOT(b_M, Matrix_DimNamesSym),
697                                            transp_b ? 0 : 1)));
698        if(transp_b) cholmod_free_dense(&b_t, &c);
699        UNPROTECT(nprot);
700        return chm_dense_to_SEXP(chc, 1, 0, dn, transp_ans);
701  }  }
702    
 SEXP Csparse_dense_prod(SEXP a, SEXP b)  
 {  
     cholmod_sparse *cha = as_cholmod_sparse(a);  
     cholmod_dense *chb = as_cholmod_dense(PROTECT(mMatrix_as_dgeMatrix(b)));  
     cholmod_dense *chc =  
         cholmod_allocate_dense(cha->nrow, chb->ncol, cha->nrow, chb->xtype, &c);  
     double alpha[] = {1,0}, beta[] = {0,0};  
703    
704      cholmod_sdmult(cha, 0, alpha, beta, chb, chc, &c);  SEXP Csparse_dense_prod(SEXP a, SEXP b, SEXP transp)
705      Free(cha); Free(chb);  {
706      UNPROTECT(1);      return
707      return chm_dense_to_SEXP(chc, 1, 0);          Csp_dense_products(a, b,
708                    /* transp_a = */ FALSE,
709                    /* transp_b   = */ (*CHAR(asChar(transp)) == '2' || *CHAR(asChar(transp)) == 'B'),
710                    /* transp_ans = */ (*CHAR(asChar(transp)) == 'c' || *CHAR(asChar(transp)) == 'B'));
711  }  }
712    
713  SEXP Csparse_dense_crossprod(SEXP a, SEXP b)  SEXP Csparse_dense_crossprod(SEXP a, SEXP b, SEXP transp)
714  {  {
715      cholmod_sparse *cha = as_cholmod_sparse(a);      return
716      cholmod_dense *chb = as_cholmod_dense(PROTECT(mMatrix_as_dgeMatrix(b)));          Csp_dense_products(a, b,
717      cholmod_dense *chc =                  /* transp_a = */ TRUE,
718          cholmod_allocate_dense(cha->ncol, chb->ncol, cha->ncol, chb->xtype, &c);                  /* transp_b   = */ (*CHAR(asChar(transp)) == '2' || *CHAR(asChar(transp)) == 'B'),
719      double alpha[] = {1,0}, beta[] = {0,0};                  /* transp_ans = */ (*CHAR(asChar(transp)) == 'c' || *CHAR(asChar(transp)) == 'B'));
   
     cholmod_sdmult(cha, 1, alpha, beta, chb, chc, &c);  
     Free(cha); Free(chb);  
     UNPROTECT(1);  
     return chm_dense_to_SEXP(chc, 1, 0);  
720  }  }
721    
722  SEXP Csparse_crossprod(SEXP x, SEXP trans, SEXP triplet)  
723    /** @brief Computes   x'x  or  x x' -- *also* for Tsparse (triplet = TRUE)
724        see Csparse_Csparse_crossprod above for  x'y and x y'
725    */
726    SEXP Csparse_crossprod(SEXP x, SEXP trans, SEXP triplet, SEXP bool_arith)
727  {  {
728      int trip = asLogical(triplet),      int tripl = asLogical(triplet),
729          tr   = asLogical(trans); /* gets reversed because _aat is tcrossprod */          tr   = asLogical(trans), /* gets reversed because _aat is tcrossprod */
730      cholmod_triplet          do_bool = asLogical(bool_arith); // TRUE / NA / FALSE
731          *cht = trip ? as_cholmod_triplet(x) : (cholmod_triplet*) NULL;  #ifdef AS_CHM_DIAGU2N_FIXED_FINALLY
732      cholmod_sparse *chcp, *chxt,      CHM_TR cht = tripl ? AS_CHM_TR(x) : (CHM_TR) NULL;  int nprot = 1;
733          *chx = trip ? cholmod_triplet_to_sparse(cht, cht->nnz, &c)  #else /* workaround needed:*/
734          : as_cholmod_sparse(x);      SEXP xx = PROTECT(Tsparse_diagU2N(x));
735        CHM_TR cht = tripl ? AS_CHM_TR__(xx) : (CHM_TR) NULL; int nprot = 2;
736    #endif
737        CHM_SP chcp, chxt, chxc,
738            chx = (tripl ?
739                   cholmod_triplet_to_sparse(cht, cht->nnz, &c) :
740                   AS_CHM_SP(x));
741      SEXP dn = PROTECT(allocVector(VECSXP, 2));      SEXP dn = PROTECT(allocVector(VECSXP, 2));
742        R_CheckStack();
743      if (!tr)      Rboolean
744          chxt = cholmod_transpose(chx, chx->xtype, &c);          x_is_n = (chx->xtype == CHOLMOD_PATTERN),
745      chcp = cholmod_aat((!tr) ? chxt : chx, (int *) NULL, 0, chx->xtype, &c);          x_is_sym = chx->stype != 0,
746      if(!chcp)          force_num = (do_bool == FALSE);
747    
748        if(x_is_n && force_num) {
749            // coerce 'x' to  double
750            SEXP dx = PROTECT(nz2Csparse(x, x_double)); nprot++;
751            chx = AS_CHM_SP(dx);
752            R_CheckStack();
753        }
754        else if(do_bool == TRUE && !x_is_n) { // Want boolean arithmetic; need patter[n]
755            // coerce 'x' to pattern
756            static const char *valid_tri[] = { MATRIX_VALID_tri_Csparse, "" };
757            SEXP dx = PROTECT(Csparse2nz(x, /* tri = */
758                                         R_check_class_etc(x, valid_tri) >= 0)); nprot++;
759            chx = AS_CHM_SP(dx);
760            R_CheckStack();
761        }
762    
763        if (!tr) chxt = cholmod_transpose(chx, chx->xtype, &c);
764    
765        if (x_is_sym) // cholmod_aat() does not like symmetric
766            chxc = cholmod_copy(tr ? chx : chxt, /* stype: */ 0,
767                                chx->xtype, &c);
768        // CHOLMOD/Core/cholmod_aat.c :
769        chcp = cholmod_aat(x_is_sym ? chxc : (tr ? chx : chxt),
770                           (int *) NULL, 0, /* mode: */ chx->xtype, &c);
771        if(!chcp) {
772            UNPROTECT(1);
773          error(_("Csparse_crossprod(): error return from cholmod_aat()"));          error(_("Csparse_crossprod(): error return from cholmod_aat()"));
     cholmod_band_inplace(0, chcp->ncol, chcp->xtype, chcp, &c);  
     chcp->stype = 1;  
     if (trip) {  
         cholmod_free_sparse(&chx, &c);  
         Free(cht);  
     } else {  
         Free(chx);  
774      }      }
775        cholmod_band_inplace(0, chcp->ncol, chcp->xtype, chcp, &c);
776        chcp->stype = 1; // symmetric
777        if (tripl) cholmod_free_sparse(&chx, &c);
778      if (!tr) cholmod_free_sparse(&chxt, &c);      if (!tr) cholmod_free_sparse(&chxt, &c);
779                                  /* create dimnames */      SET_VECTOR_ELT(dn, 0,       /* establish dimnames */
     SET_VECTOR_ELT(dn, 0,  
780                     duplicate(VECTOR_ELT(GET_SLOT(x, Matrix_DimNamesSym),                     duplicate(VECTOR_ELT(GET_SLOT(x, Matrix_DimNamesSym),
781                                          (tr) ? 1 : 0)));                                          (tr) ? 0 : 1)));
782      SET_VECTOR_ELT(dn, 1, duplicate(VECTOR_ELT(dn, 0)));      SET_VECTOR_ELT(dn, 1, duplicate(VECTOR_ELT(dn, 0)));
783      UNPROTECT(1);      UNPROTECT(nprot);
784        // FIXME: uploT for symmetric ?
785      return chm_sparse_to_SEXP(chcp, 1, 0, 0, "", dn);      return chm_sparse_to_SEXP(chcp, 1, 0, 0, "", dn);
786  }  }
787    
788    /** @brief Csparse_drop(x, tol):  drop entries with absolute value < tol, i.e,
789     *  at least all "explicit" zeros. */
790  SEXP Csparse_drop(SEXP x, SEXP tol)  SEXP Csparse_drop(SEXP x, SEXP tol)
791  {  {
792      cholmod_sparse *chx = as_cholmod_sparse(x),      const char *cl = class_P(x);
793          *ans = cholmod_copy(chx, chx->stype, chx->xtype, &c);      /* dtCMatrix, etc; [1] = the second character =?= 't' for triangular */
794        int tr = (cl[1] == 't'); // FIXME - rather  R_check_class_etc(..)
795        CHM_SP chx = AS_CHM_SP__(x);
796        CHM_SP ans = cholmod_copy(chx, chx->stype, chx->xtype, &c);
797      double dtol = asReal(tol);      double dtol = asReal(tol);
798      int Rkind = (chx->xtype == CHOLMOD_REAL) ? Real_kind(x) : 0;      int Rkind = (chx->xtype != CHOLMOD_PATTERN) ? Real_kind(x) : 0;
799        R_CheckStack();
800    
801      if(!cholmod_drop(dtol, ans, &c))      if(!cholmod_drop(dtol, ans, &c))
802          error(_("cholmod_drop() failed"));          error(_("cholmod_drop() failed"));
803      Free(chx);     return chm_sparse_to_SEXP(ans, 1,
804      /* FIXME: currently drops dimnames */                                tr ? ((*uplo_P(x) == 'U') ? 1 : -1) : 0,
805      return chm_sparse_to_SEXP(ans, 1, 0, Rkind, "", R_NilValue);                                Rkind, tr ? diag_P(x) : "",
806                                  GET_SLOT(x, Matrix_DimNamesSym));
807  }  }
808    
809    /** @brief Horizontal Concatenation -  cbind( <Csparse>,  <Csparse>)
810     */
811  SEXP Csparse_horzcat(SEXP x, SEXP y)  SEXP Csparse_horzcat(SEXP x, SEXP y)
812  {  {
813      cholmod_sparse *chx = as_cholmod_sparse(x),  #define CSPARSE_CAT(_KIND_)                                             \
814          *chy = as_cholmod_sparse(y), *ans;      CHM_SP chx = AS_CHM_SP__(x), chy = AS_CHM_SP__(y);                  \
815      int Rkind = 0; /* only for "d" - FIXME */      R_CheckStack();                                                     \
816        int Rk_x = (chx->xtype != CHOLMOD_PATTERN) ? Real_kind(x) : -3,     \
817      ans = cholmod_horzcat(chx, chy, 1, &c);          Rk_y = (chy->xtype != CHOLMOD_PATTERN) ? Real_kind(y) : -3, Rkind; \
818      Free(chx); Free(chy);      if(Rk_x == -3 || Rk_y == -3) { /* at least one of them is patter"n" */ \
819      /* FIXME: currently drops dimnames */          if(Rk_x == -3 && Rk_y == -3) { /* fine */                       \
820      return chm_sparse_to_SEXP(ans, 1, 0, Rkind, "", R_NilValue);          } else { /* only one is a patter"n"                             \
821                      * "Bug" in cholmod_horzcat()/vertcat(): returns patter"n" matrix if one of them is */ \
822                Rboolean ok;                                                \
823                if(Rk_x == -3) {                                            \
824                    ok = chm_MOD_xtype(CHOLMOD_REAL, chx, &c); Rk_x = 0;    \
825                } else if(Rk_y == -3) {                                     \
826                    ok = chm_MOD_xtype(CHOLMOD_REAL, chy, &c); Rk_y = 0;    \
827                } else                                                      \
828                    error(_("Impossible Rk_x/Rk_y in Csparse_%s(), please report"), _KIND_); \
829                if(!ok)                                                     \
830                    error(_("chm_MOD_xtype() was not successful in Csparse_%s(), please report"), \
831                          _KIND_);                                          \
832            }                                                               \
833        }                                                                   \
834        Rkind = /* logical if both x and y are */ (Rk_x == 1 && Rk_y == 1) ? 1 : 0
835    
836        CSPARSE_CAT("horzcat");
837        // TODO: currently drops dimnames - and we fix at R level;
838    
839        return chm_sparse_to_SEXP(cholmod_horzcat(chx, chy, 1, &c),
840                                  1, 0, Rkind, "", R_NilValue);
841  }  }
842    
843    /** @brief Vertical Concatenation -  rbind( <Csparse>,  <Csparse>)
844     */
845  SEXP Csparse_vertcat(SEXP x, SEXP y)  SEXP Csparse_vertcat(SEXP x, SEXP y)
846  {  {
847      cholmod_sparse *chx = as_cholmod_sparse(x),      CSPARSE_CAT("vertcat");
848          *chy = as_cholmod_sparse(y), *ans;      // TODO: currently drops dimnames - and we fix at R level;
849      int Rkind = 0; /* only for "d" - FIXME */  
850        return chm_sparse_to_SEXP(cholmod_vertcat(chx, chy, 1, &c),
851      ans = cholmod_vertcat(chx, chy, 1, &c);                                1, 0, Rkind, "", R_NilValue);
     Free(chx); Free(chy);  
     /* FIXME: currently drops dimnames */  
     return chm_sparse_to_SEXP(ans, 1, 0, Rkind, "", R_NilValue);  
852  }  }
853    
854  SEXP Csparse_band(SEXP x, SEXP k1, SEXP k2)  SEXP Csparse_band(SEXP x, SEXP k1, SEXP k2)
855  {  {
856      cholmod_sparse *chx = as_cholmod_sparse(x), *ans;      CHM_SP chx = AS_CHM_SP__(x);
857      int Rkind = (chx->xtype == CHOLMOD_REAL) ? Real_kind(x) : 0;      int Rkind = (chx->xtype != CHOLMOD_PATTERN) ? Real_kind(x) : 0;
858        CHM_SP ans = cholmod_band(chx, asInteger(k1), asInteger(k2), chx->xtype, &c);
859        R_CheckStack();
860    
861      ans = cholmod_band(chx, asInteger(k1), asInteger(k2), chx->xtype, &c);      return chm_sparse_to_SEXP(ans, 1, 0, Rkind, "",
862      Free(chx);                                GET_SLOT(x, Matrix_DimNamesSym));
     return chm_sparse_to_SEXP(ans, 1, 0, Rkind, "", R_NilValue);  
863  }  }
864    
865  SEXP Csparse_diagU2N(SEXP x)  SEXP Csparse_diagU2N(SEXP x)
866  {  {
867      cholmod_sparse *chx = as_cholmod_sparse(x);      const char *cl = class_P(x);
868      cholmod_sparse *eye = cholmod_speye(chx->nrow, chx->ncol, chx->xtype, &c);      /* dtCMatrix, etc; [1] = the second character =?= 't' for triangular */
869        if (cl[1] != 't' || *diag_P(x) != 'U') {
870            /* "trivially fast" when not triangular (<==> no 'diag' slot),
871               or not *unit* triangular */
872            return (x);
873        }
874        else { /* unit triangular (diag='U'): "fill the diagonal" & diag:= "N" */
875            CHM_SP chx = AS_CHM_SP__(x);
876            CHM_SP eye = cholmod_speye(chx->nrow, chx->ncol, chx->xtype, &c);
877      double one[] = {1, 0};      double one[] = {1, 0};
878      cholmod_sparse *ans = cholmod_add(chx, eye, one, one, TRUE, TRUE, &c);          CHM_SP ans = cholmod_add(chx, eye, one, one, TRUE, TRUE, &c);
879      int uploT = (strcmp(CHAR(asChar(GET_SLOT(x, Matrix_uploSym))), "U")) ?          int uploT = (*uplo_P(x) == 'U') ? 1 : -1;
880          -1 : 1;          int Rkind = (chx->xtype != CHOLMOD_PATTERN) ? Real_kind(x) : 0;
     int Rkind = (chx->xtype == CHOLMOD_REAL) ? Real_kind(x) : 0;  
881    
882      Free(chx); cholmod_free_sparse(&eye, &c);          R_CheckStack();
883            cholmod_free_sparse(&eye, &c);
884      return chm_sparse_to_SEXP(ans, 1, uploT, Rkind, "N",      return chm_sparse_to_SEXP(ans, 1, uploT, Rkind, "N",
885                                duplicate(GET_SLOT(x, Matrix_DimNamesSym)));                                    GET_SLOT(x, Matrix_DimNamesSym));
886  }  }
887    }
888    
889    SEXP Csparse_diagN2U(SEXP x)
890    {
891        const char *cl = class_P(x);
892        /* dtCMatrix, etc; [1] = the second character =?= 't' for triangular */
893        if (cl[1] != 't' || *diag_P(x) != 'N') {
894            /* "trivially fast" when not triangular (<==> no 'diag' slot),
895               or already *unit* triangular */
896            return (x);
897        }
898        else { /* triangular with diag='N'): now drop the diagonal */
899            /* duplicate, since chx will be modified: */
900            SEXP xx = PROTECT(duplicate(x));
901            CHM_SP chx = AS_CHM_SP__(xx);
902            int uploT = (*uplo_P(x) == 'U') ? 1 : -1,
903                Rkind = (chx->xtype != CHOLMOD_PATTERN) ? Real_kind(x) : 0;
904            R_CheckStack();
905    
906            chm_diagN2U(chx, uploT, /* do_realloc */ FALSE);
907    
908            SEXP ans = chm_sparse_to_SEXP(chx, /*dofree*/ 0/* or 1 ?? */,
909                                          uploT, Rkind, "U",
910                                          GET_SLOT(x, Matrix_DimNamesSym));
911            UNPROTECT(1);// only now !
912            return ans;
913        }
914    }
915    
916    /**
917     * Indexing aka subsetting : Compute  x[i,j], also for vectors i and j
918     * Working via CHOLMOD_submatrix, see ./CHOLMOD/MatrixOps/cholmod_submatrix.c
919     * @param x CsparseMatrix
920     * @param i row     indices (0-origin), or NULL (R, not C)
921     * @param j columns indices (0-origin), or NULL
922     *
923     * @return x[i,j]  still CsparseMatrix --- currently, this loses dimnames
924     */
925  SEXP Csparse_submatrix(SEXP x, SEXP i, SEXP j)  SEXP Csparse_submatrix(SEXP x, SEXP i, SEXP j)
926  {  {
927      cholmod_sparse *chx = as_cholmod_sparse(x);      CHM_SP chx = AS_CHM_SP(x); /* << does diagU2N() when needed */
928      int rsize = (isNull(i)) ? -1 : LENGTH(i),      int rsize = (isNull(i)) ? -1 : LENGTH(i),
929          csize = (isNull(j)) ? -1 : LENGTH(j);          csize = (isNull(j)) ? -1 : LENGTH(j);
930      int Rkind = (chx->xtype == CHOLMOD_REAL) ? Real_kind(x) : 0;      int Rkind = (chx->xtype != CHOLMOD_PATTERN) ? Real_kind(x) : 0;
931        R_CheckStack();
932    
933      if (rsize >= 0 && !isInteger(i))      if (rsize >= 0 && !isInteger(i))
934          error(_("Index i must be NULL or integer"));          error(_("Index i must be NULL or integer"));
935      if (csize >= 0 && !isInteger(j))      if (csize >= 0 && !isInteger(j))
936          error(_("Index j must be NULL or integer"));          error(_("Index j must be NULL or integer"));
937      return chm_sparse_to_SEXP(cholmod_submatrix(chx, INTEGER(i), rsize,  
938                                                  INTEGER(j), csize,      /* Must treat 'NA's in i[] and j[] here -- they are *not* treated by Cholmod!
939                                                  TRUE, TRUE, &c),       * haveNA := ...
940                                1, 0, Rkind, "", R_NilValue);         if(haveNA) {
941             a. i = removeNA(i); j =removeNA(j), and remember where they were
942             b. ans = CHM_SUB(.., i, j)
943             c. add NA rows and/or columns to 'ans' according to
944                place of NA's in i and/or j.
945           } else {
946             ans = CHM_SUB(.....)  // == current code
947           }
948         */
949    #define CHM_SUB(_M_, _i_, _j_)                                  \
950        cholmod_submatrix(_M_,                                      \
951                          (rsize < 0) ? NULL : INTEGER(_i_), rsize, \
952                          (csize < 0) ? NULL : INTEGER(_j_), csize, \
953                          TRUE, TRUE, &c)
954        CHM_SP ans;
955        if (!chx->stype) {/* non-symmetric Matrix */
956            ans = CHM_SUB(chx, i, j);
957        }
958        else { /* symmetric : "dsCMatrix";
959                  currently, cholmod_submatrix() only accepts "generalMatrix" */
960            CHM_SP tmp = cholmod_copy(chx, /* stype: */ 0, chx->xtype, &c);
961            ans = CHM_SUB(tmp, i, j);
962            cholmod_free_sparse(&tmp, &c);
963        }
964    
965        // "FIXME": currently dropping dimnames, and adding them afterwards in R :
966        /* // dimnames: */
967        /* SEXP x_dns = GET_SLOT(x, Matrix_DimNamesSym), */
968        /*  dn = PROTECT(allocVector(VECSXP, 2)); */
969        return chm_sparse_to_SEXP(ans, 1, 0, Rkind, "", /* dimnames: */ R_NilValue);
970    }
971    #undef CHM_SUB
972    
973    #define _d_Csp_
974    #include "t_Csparse_subassign.c"
975    
976    #define _l_Csp_
977    #include "t_Csparse_subassign.c"
978    
979    #define _i_Csp_
980    #include "t_Csparse_subassign.c"
981    
982    #define _n_Csp_
983    #include "t_Csparse_subassign.c"
984    
985    #define _z_Csp_
986    #include "t_Csparse_subassign.c"
987    
988    
989    
990    SEXP Csparse_MatrixMarket(SEXP x, SEXP fname)
991    {
992        FILE *f = fopen(CHAR(asChar(fname)), "w");
993    
994        if (!f)
995            error(_("failure to open file \"%s\" for writing"),
996                  CHAR(asChar(fname)));
997        if (!cholmod_write_sparse(f, AS_CHM_SP(x),
998                                  (CHM_SP)NULL, (char*) NULL, &c))
999            error(_("cholmod_write_sparse returned error code"));
1000        fclose(f);
1001        return R_NilValue;
1002    }
1003    
1004    
1005    /**
1006     * Extract the diagonal entries from *triangular* Csparse matrix  __or__ a
1007     * cholmod_sparse factor (LDL = TRUE).
1008     *
1009     * @param n  dimension of the matrix.
1010     * @param x_p  'p' (column pointer) slot contents
1011     * @param x_x  'x' (non-zero entries) slot contents
1012     * @param perm 'perm' (= permutation vector) slot contents; only used for "diagBack"
1013     * @param resultKind a (SEXP) string indicating which kind of result is desired.
1014     *
1015     * @return  a SEXP, either a (double) number or a length n-vector of diagonal entries
1016     */
1017    SEXP diag_tC_ptr(int n, int *x_p, double *x_x, Rboolean is_U, int *perm,
1018    /*                                ^^^^^^ FIXME[Generalize] to int / ... */
1019                     SEXP resultKind)
1020    {
1021        const char* res_ch = CHAR(STRING_ELT(resultKind,0));
1022        enum diag_kind { diag, diag_backpermuted, trace, prod, sum_log, min, max, range
1023        } res_kind = ((!strcmp(res_ch, "trace")) ? trace :
1024                      ((!strcmp(res_ch, "sumLog")) ? sum_log :
1025                       ((!strcmp(res_ch, "prod")) ? prod :
1026                        ((!strcmp(res_ch, "min")) ? min :
1027                         ((!strcmp(res_ch, "max")) ? max :
1028                          ((!strcmp(res_ch, "range")) ? range :
1029                           ((!strcmp(res_ch, "diag")) ? diag :
1030                            ((!strcmp(res_ch, "diagBack")) ? diag_backpermuted :
1031                             -1))))))));
1032        int i, n_x, i_from;
1033        SEXP ans = PROTECT(allocVector(REALSXP,
1034    /*                                 ^^^^  FIXME[Generalize] */
1035                                       (res_kind == diag ||
1036                                        res_kind == diag_backpermuted) ? n :
1037                                       (res_kind == range ? 2 : 1)));
1038        double *v = REAL(ans);
1039    /*  ^^^^^^      ^^^^  FIXME[Generalize] */
1040    
1041        i_from = (is_U ? -1 : 0);
1042    
1043    #define for_DIAG(v_ASSIGN)                                      \
1044        for(i = 0; i < n; i++) {                                    \
1045            /* looking at i-th column */                            \
1046            n_x = x_p[i+1] - x_p[i];/* #{entries} in this column */ \
1047            if( is_U) i_from += n_x;                                \
1048            v_ASSIGN;                                               \
1049            if(!is_U) i_from += n_x;                                \
1050        }
1051    
1052        /* NOTA BENE: we assume  -- uplo = "L" i.e. lower triangular matrix
1053         *            for uplo = "U" (makes sense with a "dtCMatrix" !),
1054         *            should use  x_x[i_from + (n_x - 1)] instead of x_x[i_from],
1055         *            where n_x = (x_p[i+1] - x_p[i])
1056         */
1057    
1058        switch(res_kind) {
1059        case trace: // = sum
1060            v[0] = 0.;
1061            for_DIAG(v[0] += x_x[i_from]);
1062            break;
1063    
1064        case sum_log:
1065            v[0] = 0.;
1066            for_DIAG(v[0] += log(x_x[i_from]));
1067            break;
1068    
1069        case prod:
1070            v[0] = 1.;
1071            for_DIAG(v[0] *= x_x[i_from]);
1072            break;
1073    
1074        case min:
1075            v[0] = R_PosInf;
1076            for_DIAG(if(v[0] > x_x[i_from]) v[0] = x_x[i_from]);
1077            break;
1078    
1079        case max:
1080            v[0] = R_NegInf;
1081            for_DIAG(if(v[0] < x_x[i_from]) v[0] = x_x[i_from]);
1082            break;
1083    
1084        case range:
1085            v[0] = R_PosInf;
1086            v[1] = R_NegInf;
1087            for_DIAG(if(v[0] > x_x[i_from]) v[0] = x_x[i_from];
1088                     if(v[1] < x_x[i_from]) v[1] = x_x[i_from]);
1089            break;
1090    
1091        case diag:
1092            for_DIAG(v[i] = x_x[i_from]);
1093            break;
1094    
1095        case diag_backpermuted:
1096            for_DIAG(v[i] = x_x[i_from]);
1097    
1098            warning(_("%s = '%s' (back-permuted) is experimental"),
1099                    "resultKind", "diagBack");
1100            /* now back_permute : */
1101            for(i = 0; i < n; i++) {
1102                double tmp = v[i]; v[i] = v[perm[i]]; v[perm[i]] = tmp;
1103                /*^^^^ FIXME[Generalize] */
1104            }
1105            break;
1106    
1107        default: /* -1 from above */
1108            error(_("diag_tC(): invalid 'resultKind'"));
1109            /* Wall: */ ans = R_NilValue; v = REAL(ans);
1110        }
1111    
1112        UNPROTECT(1);
1113        return ans;
1114    }
1115    
1116    /**
1117     * Extract the diagonal entries from *triangular* Csparse matrix  __or__ a
1118     * cholmod_sparse factor (LDL = TRUE).
1119     *
1120     * @param obj -- now a cholmod_sparse factor or a dtCMatrix
1121     * @param pslot  'p' (column pointer)   slot of Csparse matrix/factor
1122     * @param xslot  'x' (non-zero entries) slot of Csparse matrix/factor
1123     * @param perm_slot  'perm' (= permutation vector) slot of corresponding CHMfactor;
1124     *                   only used for "diagBack"
1125     * @param resultKind a (SEXP) string indicating which kind of result is desired.
1126     *
1127     * @return  a SEXP, either a (double) number or a length n-vector of diagonal entries
1128     */
1129    SEXP diag_tC(SEXP obj, SEXP resultKind)
1130    {
1131    
1132        SEXP
1133            pslot = GET_SLOT(obj, Matrix_pSym),
1134            xslot = GET_SLOT(obj, Matrix_xSym);
1135        Rboolean is_U = (R_has_slot(obj, Matrix_uploSym) &&
1136                         *CHAR(asChar(GET_SLOT(obj, Matrix_uploSym))) == 'U');
1137        int n = length(pslot) - 1, /* n = ncol(.) = nrow(.) */
1138            *x_p  = INTEGER(pslot), pp = -1, *perm;
1139        double *x_x = REAL(xslot);
1140    /*  ^^^^^^        ^^^^ FIXME[Generalize] to INTEGER(.) / LOGICAL(.) / ... xslot !*/
1141    
1142        if(R_has_slot(obj, Matrix_permSym))
1143            perm = INTEGER(GET_SLOT(obj, Matrix_permSym));
1144        else perm = &pp;
1145    
1146        return diag_tC_ptr(n, x_p, x_x, is_U, perm, resultKind);
1147    }
1148    
1149    
1150    /**
1151     * Create a Csparse matrix object from indices and/or pointers.
1152     *
1153     * @param cls name of actual class of object to create
1154     * @param i optional integer vector of length nnz of row indices
1155     * @param j optional integer vector of length nnz of column indices
1156     * @param p optional integer vector of length np of row or column pointers
1157     * @param np length of integer vector p.  Must be zero if p == (int*)NULL
1158     * @param x optional vector of values
1159     * @param nnz length of vectors i, j and/or x, whichever is to be used
1160     * @param dims optional integer vector of length 2 to be used as
1161     *     dimensions.  If dims == (int*)NULL then the maximum row and column
1162     *     index are used as the dimensions.
1163     * @param dimnames optional list of length 2 to be used as dimnames
1164     * @param index1 indicator of 1-based indices
1165     *
1166     * @return an SEXP of class cls inheriting from CsparseMatrix.
1167     */
1168    SEXP create_Csparse(char* cls, int* i, int* j, int* p, int np,
1169                        void* x, int nnz, int* dims, SEXP dimnames,
1170                        int index1)
1171    {
1172        SEXP ans;
1173        int *ij = (int*)NULL, *tri, *trj,
1174            mi, mj, mp, nrow = -1, ncol = -1;
1175        int xtype = -1;             /* -Wall */
1176        CHM_TR T;
1177        CHM_SP A;
1178    
1179        if (np < 0 || nnz < 0)
1180            error(_("negative vector lengths not allowed: np = %d, nnz = %d"),
1181                  np, nnz);
1182        if (1 != ((mi = (i == (int*)NULL)) +
1183                  (mj = (j == (int*)NULL)) +
1184                  (mp = (p == (int*)NULL))))
1185            error(_("exactly 1 of 'i', 'j' or 'p' must be NULL"));
1186        if (mp) {
1187            if (np) error(_("np = %d, must be zero when p is NULL"), np);
1188        } else {
1189            if (np) {               /* Expand p to form i or j */
1190                if (!(p[0])) error(_("p[0] = %d, should be zero"), p[0]);
1191                for (int ii = 0; ii < np; ii++)
1192                    if (p[ii] > p[ii + 1])
1193                        error(_("p must be non-decreasing"));
1194                if (p[np] != nnz)
1195                    error("p[np] = %d != nnz = %d", p[np], nnz);
1196                ij = Calloc(nnz, int);
1197                if (mi) {
1198                    i = ij;
1199                    nrow = np;
1200                } else {
1201                    j = ij;
1202                    ncol = np;
1203                }
1204                /* Expand p to 0-based indices */
1205                for (int ii = 0; ii < np; ii++)
1206                    for (int jj = p[ii]; jj < p[ii + 1]; jj++) ij[jj] = ii;
1207            } else {
1208                if (nnz)
1209                    error(_("Inconsistent dimensions: np = 0 and nnz = %d"),
1210                          nnz);
1211            }
1212        }
1213        /* calculate nrow and ncol */
1214        if (nrow < 0) {
1215            for (int ii = 0; ii < nnz; ii++) {
1216                int i1 = i[ii] + (index1 ? 0 : 1); /* 1-based index */
1217                if (i1 < 1) error(_("invalid row index at position %d"), ii);
1218                if (i1 > nrow) nrow = i1;
1219            }
1220        }
1221        if (ncol < 0) {
1222            for (int jj = 0; jj < nnz; jj++) {
1223                int j1 = j[jj] + (index1 ? 0 : 1);
1224                if (j1 < 1) error(_("invalid column index at position %d"), jj);
1225                if (j1 > ncol) ncol = j1;
1226            }
1227        }
1228        if (dims != (int*)NULL) {
1229            if (dims[0] > nrow) nrow = dims[0];
1230            if (dims[1] > ncol) ncol = dims[1];
1231        }
1232        /* check the class name */
1233        if (strlen(cls) != 8)
1234            error(_("strlen of cls argument = %d, should be 8"), strlen(cls));
1235        if (!strcmp(cls + 2, "CMatrix"))
1236            error(_("cls = \"%s\" does not end in \"CMatrix\""), cls);
1237        switch(cls[0]) {
1238        case 'd':
1239        case 'l':
1240            xtype = CHOLMOD_REAL;
1241        break;
1242        case 'n':
1243            xtype = CHOLMOD_PATTERN;
1244            break;
1245        default:
1246            error(_("cls = \"%s\" must begin with 'd', 'l' or 'n'"), cls);
1247        }
1248        if (cls[1] != 'g')
1249            error(_("Only 'g'eneral sparse matrix types allowed"));
1250        /* allocate and populate the triplet */
1251        T = cholmod_allocate_triplet((size_t)nrow, (size_t)ncol, (size_t)nnz, 0,
1252                                     xtype, &c);
1253        T->x = x;
1254        tri = (int*)T->i;
1255        trj = (int*)T->j;
1256        for (int ii = 0; ii < nnz; ii++) {
1257            tri[ii] = i[ii] - ((!mi && index1) ? 1 : 0);
1258            trj[ii] = j[ii] - ((!mj && index1) ? 1 : 0);
1259        }
1260        /* create the cholmod_sparse structure */
1261        A = cholmod_triplet_to_sparse(T, nnz, &c);
1262        cholmod_free_triplet(&T, &c);
1263        /* copy the information to the SEXP */
1264        ans = PROTECT(NEW_OBJECT(MAKE_CLASS(cls)));
1265    // FIXME: This has been copied from chm_sparse_to_SEXP in  chm_common.c
1266        /* allocate and copy common slots */
1267        nnz = cholmod_nnz(A, &c);
1268        dims = INTEGER(ALLOC_SLOT(ans, Matrix_DimSym, INTSXP, 2));
1269        dims[0] = A->nrow; dims[1] = A->ncol;
1270        Memcpy(INTEGER(ALLOC_SLOT(ans, Matrix_pSym, INTSXP, A->ncol + 1)), (int*)A->p, A->ncol + 1);
1271        Memcpy(INTEGER(ALLOC_SLOT(ans, Matrix_iSym, INTSXP, nnz)), (int*)A->i, nnz);
1272        switch(cls[1]) {
1273        case 'd':
1274            Memcpy(REAL(ALLOC_SLOT(ans, Matrix_xSym, REALSXP, nnz)), (double*)A->x, nnz);
1275            break;
1276        case 'l':
1277            error(_("code not yet written for cls = \"lgCMatrix\""));
1278        }
1279    /* FIXME: dimnames are *NOT* put there yet (if non-NULL) */
1280        cholmod_free_sparse(&A, &c);
1281        UNPROTECT(1);
1282        return ans;
1283  }  }

Legend:
Removed from v.1657  
changed lines
  Added in v.3213

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