SCM

SCM Repository

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

Diff of /pkg/Matrix/src/Mutils.h

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

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

Legend:
Removed from v.412  
changed lines
  Added in v.890

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