SCM

SCM Repository

[matrix] Diff of /pkg/src/Mutils.h
ViewVC logotype

Diff of /pkg/src/Mutils.h

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

revision 441, Wed Jan 19 11:22:07 2005 UTC revision 796, Mon Jul 4 14:57:28 2005 UTC
# Line 1  Line 1 
1  #ifndef MATRIX_MUTILS_H  #ifndef MATRIX_MUTILS_H
2  #define MATRIX_MUTILS_H  #define MATRIX_MUTILS_H
3    
4    #ifdef __cplusplus
5    extern "C" {
6    #endif
7    
8  #include <Rdefines.h>  #include <Rdefines.h>
9  #include <Rconfig.h>  #include <Rconfig.h>
10  #include "cblas.h"  #include <R.h>  /* to include Rconfig.h */
11    
12    #ifdef ENABLE_NLS
13    #include <libintl.h>
14    #define _(String) dgettext ("Matrix", String)
15    #else
16    #define _(String) (String)
17    #endif
18    
19    /* enum constants from cblas.h and some short forms */
20    enum CBLAS_ORDER {CblasRowMajor=101, CblasColMajor=102};
21    enum CBLAS_TRANSPOSE {CblasNoTrans=111, CblasTrans=112, CblasConjTrans=113};
22    enum CBLAS_UPLO {CblasUpper=121, CblasLower=122};
23    enum CBLAS_DIAG {CblasNonUnit=131, CblasUnit=132};
24    enum CBLAS_SIDE {CblasLeft=141, CblasRight=142};
25    #define RMJ CblasRowMajor
26    #define CMJ CblasColMajor
27    #define NTR CblasNoTrans
28    #define TRN CblasTrans
29    #define CTR CblasConjTrans
30    #define UPP CblasUpper
31    #define LOW CblasLower
32    #define NUN CblasNonUnit
33    #define UNT CblasUnit
34    #define LFT CblasLeft
35    #define RGT CblasRight
36    
37  char norm_type(char *typstr);  char norm_type(char *typstr);
38  char rcond_type(char *typstr);  char rcond_type(char *typstr);
39  double get_double_by_name(SEXP obj, char *nm);  double get_double_by_name(SEXP obj, char *nm);
40  SEXP set_double_by_name(SEXP obj, double val, char *nm);  SEXP set_double_by_name(SEXP obj, double val, char *nm);
41  SEXP as_det_obj(double val, int log, int sign);  SEXP as_det_obj(double val, int log, int sign);
42  SEXP get_factorization(SEXP obj, char *nm);  SEXP get_factors(SEXP obj, char *nm);
43  SEXP set_factorization(SEXP obj, SEXP val, char *nm);  SEXP set_factors(SEXP obj, SEXP val, char *nm);
44  SEXP cscMatrix_set_Dim(SEXP x, int nrow);  SEXP dgCMatrix_set_Dim(SEXP x, int nrow);
45  int csc_unsorted_columns(int ncol, const int p[], const int i[]);  int csc_unsorted_columns(int ncol, const int p[], const int i[]);
46  void csc_sort_columns(int ncol, const int p[], int i[], double x[]);  void csc_sort_columns(int ncol, const int p[], int i[], double x[]);
47  SEXP triple_as_SEXP(int nrow, int ncol, int nz,  SEXP triple_as_SEXP(int nrow, int ncol, int nz,
48                      const int Ti [], const int Tj [], const double Tx [],                      const int Ti [], const int Tj [], const double Tx [],
49                      char *Rclass);                      char *Rclass);
50  SEXP csc_check_column_sorting(SEXP A);  SEXP csc_check_column_sorting(SEXP A);
51  void csc_components_transpose(int m, int n, int nnz,  void csc_compTr(int m, int n, int nnz,
52                                const int xp[], const int xi[],                  const int xp[], const int xi[], const double xx[],
                               const double xx[],  
53                                int ap[], int ai[], double ax[]);                                int ap[], int ai[], double ax[]);
54  void ssc_symbolic_permute(int n, int upper, const int perm[],  void ssc_symbolic_permute(int n, int upper, const int perm[],
55                            int Ap[], int Ai[]);                            int Ap[], int Ai[]);
56  double *nlme_symmetrize(double *a, const int nc);  SEXP Matrix_make_named(int TYP, char **names);
57  void nlme_check_Lapack_error(int info, const char *laName);  SEXP check_scalar_string(SEXP sP, char *vals, char *nm);
58  SEXP nlme_replaceSlot(SEXP obj, SEXP names, SEXP value);  double *packed_to_full(double *dest, const double *src, int n,
59  SEXP nlme_weight_matrix_list(SEXP MLin, SEXP wts, SEXP adjst, SEXP MLout);                         enum CBLAS_UPLO uplo);
60    double *full_to_packed(double *dest, const double *src, int n,
61                                  /* stored pointers to symbols */                         enum CBLAS_UPLO uplo, enum CBLAS_DIAG diag);
62                                  /* initialized in R_init_Matrix */  double *packed_getDiag(double *dest, SEXP x);
63  extern  
64    
65    extern   /* stored pointers to symbols initialized in R_init_Matrix */
66  #include "Syms.h"  #include "Syms.h"
67    
68  /* zero an array */  /* zero an array */
69  #define AZERO(x, n) {int _I_, _SZ_ = (n); for(_I_ = 0; _I_ < _SZ_; _I_++) (x)[_I_] = 0;}  #define AZERO(x, n) {int _I_, _SZ_ = (n); for(_I_ = 0; _I_ < _SZ_; _I_++) (x)[_I_] = 0;}
70    
71    /* number of elements in one triangle of a square matrix of order n */
72    #define PACKED_LENGTH(n)   ((n) * ((n) + 1))/2
73    
74    /* duplicate the slot with name given by sym from src to dest */
75    #define slot_dup(dest, src, sym)  SET_SLOT(dest, sym, duplicate(GET_SLOT(src, sym)))
76    
77    /**
78     * Check for valid length of a packed triangular array and return the
79     * corresponding number of columns
80     *
81     * @param len length of a packed triangular array
82     *
83     * @return number of columns
84     */
85    static R_INLINE
86    int packed_ncol(int len)
87    {
88        int disc = 8 * len + 1;     /* discriminant */
89        int sqrtd = (int) sqrt((double) disc);
90    
91        if (len < 0 || disc != sqrtd * sqrtd)
92            error(_("invalid 'len' = %d in packed_ncol"));
93        return (sqrtd - 1)/2;
94    }
95    
96    /**
97     * Allocate an SEXP of given type and length, assign it as slot nm in
98     * the object, and return the SEXP.  The validity of this function
99     * depends on SET_SLOT not duplicating val when NAMED(val) == 0.  If
100     * this behavior changes then ALLOC_SLOT must use SET_SLOT followed by
101     * GET_SLOT to ensure that the value returned is indeed the SEXP in
102     * the slot.
103     *
104     * @param obj object in which to assign the slot
105     * @param nm name of the slot, as an R name object
106     * @param type type of SEXP to allocate
107     * @param length length of SEXP to allocate
108     *
109     * @return SEXP of given type and length assigned as slot nm in obj
110     */
111    static R_INLINE
112    SEXP ALLOC_SLOT(SEXP obj, SEXP nm, SEXPTYPE type, int length)
113    {
114        SEXP val = allocVector(type, length);
115    
116        SET_SLOT(obj, nm, val);
117        return val;
118    }
119    
120    /**
121     * Expand compressed pointers in the array mp into a full set of indices
122     * in the array mj.
123     *
124     * @param ncol number of columns (or rows)
125     * @param mp column pointer vector of length ncol + 1
126     * @param mj vector of length mp[ncol] to hold the result
127     *
128     * @return mj
129     */
130    static R_INLINE
131    int* expand_cmprPt(int ncol, const int mp[], int mj[])
132    {
133        int j;
134        for (j = 0; j < ncol; j++) {
135            int j2 = mp[j+1], jj;
136            for (jj = mp[j]; jj < j2; jj++) mj[jj] = j;
137        }
138        return mj;
139    }
140    
141    
142    /**
143     * Return the linear index of the (row, col) entry in a csc structure.
144     * If the entry is not found and missing is 0 an error is signaled;
145     * otherwise the missing value is returned.
146     *
147     * @param p vector of column pointers
148     * @param i vector of row indices
149     * @param row row index
150     * @param col column index
151     * @param missing the value to return is the row, col entry does not
152     * exist.  If this is zero and the row, col entry does not exist an
153     * error is signaled.
154     *
155     * @return index of element at (row, col) if it exists, otherwise missing
156     */
157    static R_INLINE int
158    check_csc_index(const int p[], const int i[], int row, int col, int missing)
159    {
160        int k, k2 = p[col + 1];
161                                    /* linear search - perhaps replace by bsearch */
162        for (k = p[col]; k < k2; k++) if (i[k] == row) return k;
163        if (!missing)
164            error("row %d and column %d not defined in rowind and colptr",
165                  row, col);
166        return missing;
167    }
168    
169    SEXP alloc3Darray(SEXPTYPE mode, int nrow, int ncol, int nface);
170    
171    /**
172     * Calculate the zero-based index in a row-wise packed lower triangular matrix.
173     * This is used for the arrays of blocked sparse matrices.
174     *
175     * @param i column number (zero-based)
176     * @param k row number (zero-based)
177     *
178     * @return The index of the (k,i) element of a packed lower triangular matrix
179     */
180    static R_INLINE
181    int Lind(int k, int i)
182    {
183        if (k < i) error("Lind(k = %d, i = %d) must have k >= i", k, i);
184        return (k * (k + 1))/2 + i;
185    }
186    
187    /**
188     * Check for a complete match on matrix dimensions
189     *
190     * @param xd dimensions of first matrix
191     * @param yd dimensions of second matrix
192     *
193     * @return 1 if dimensions match, otherwise 0
194     */
195    static R_INLINE
196    int match_mat_dims(const int xd[], const int yd[])
197    {
198        return xd[0] == yd[0] && xd[1] == yd[1];
199    }
200    
201    double *expand_csc_column(double *dest, int m, int j,
202                              const int Ap[], const int Ai[], const double Ax[]);
203    
204    /**
205     * Apply a permutation to an integer vector
206     *
207     * @param i vector of 0-based indices
208     * @param n length of vector i
209     * @param perm 0-based permutation vector of length max(i) + 1
210     */
211    static R_INLINE void
212    int_permute(int i[], int n, const int perm[])
213    {
214        int j;
215        for (j = 0; j < n; j++) i[j] = perm[i[j]];
216    }
217    
218    /**
219     * Force index pairs to be in the upper triangle of a matrix
220     *
221     * @param i vector of 0-based row indices
222     * @param j vector of 0-based column indices
223     * @param nnz length of index vectors
224     */
225    static R_INLINE void
226    make_upper_triangular(int i[], int j[], int nnz)
227    {
228        int k;
229        for (k = 0; k < nnz; k++) {
230            if (i[k] > j[k]) {
231                int tmp = i[k];
232                i[k] = j[k];
233                j[k] = tmp;
234            }
235        }
236    }
237    
238    void make_array_triangular(double *x, SEXP from);
239    
240    SEXP Matrix_expand_pointers(SEXP pP);
241    
242    
243    /**
244     * Elementwise increment dest by src
245     *
246     * @param dest vector to be incremented
247     * @param src vector to be added to dest
248     * @param n length of vectors
249     *
250     * @return dest
251     */
252    static R_INLINE double*
253    vecIncrement(double dest[], const double src[], int n) {
254        int i;
255        for (i = 0; i < n; i++) dest[i] += src[i];
256        return dest;
257    }
258    
259    /**
260     * Elementwise sum of src1 and src2 into dest
261     *
262     * @param dest vector to be incremented
263     * @param src1 vector to be added
264     * @param src1 second vector to be added
265     * @param n length of vectors
266     *
267     * @return dest
268     */
269    static R_INLINE double*
270    vecSum(double dest[], const double src1[], const double src2[],
271           int n) {
272        int i;
273        for (i = 0; i < n; i++) dest[i] = src1[i] + src2[i];
274        return dest;
275    }
276    
277    #ifdef __cplusplus
278    }
279  #endif  #endif
280    
281    #endif /* MATRIX_MUTILS_H_ */

Legend:
Removed from v.441  
changed lines
  Added in v.796

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