aboutsummaryrefslogtreecommitdiff
path: root/src/mtx_qr.c
blob: 5e43e303a65379fb7fab4bddae38bdb8c7905e29 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
/*
 *  iemmatrix
 *
 *  objects for manipulating simple matrices
 *  mostly refering to matlab/octave matrix functions
 *  this functions depends on the GNU scientific library
 *
 * Copyright (c) 2009, Franz Zotter
 * IEM, Graz, Austria
 *
 * For information on usage and redistribution, and for a DISCLAIMER OF ALL
 * WARRANTIES, see the file, "LICENSE.txt," in this distribution.
 *
 */

#include "iemmatrix.h"
#include <stdlib.h>

#ifdef HAVE_LIBGSL
#include <gsl/gsl_linalg.h>
#endif

static t_class *mtx_qr_class;

typedef struct _MTXQr_ MTXQr;
struct _MTXQr_
{
  t_object x_obj;
#ifdef HAVE_LIBGSL
  gsl_matrix *a;
  gsl_vector *tau;
#endif
  t_outlet *list_q_out;
  t_outlet *list_r_out;
  t_atom *list_q;
  t_atom *list_r;
  int rows;
  int columns;
};

#ifdef HAVE_LIBGSL
static void allocMTXqr (MTXQr *x) 
{
     x->a=(gsl_matrix*)gsl_matrix_alloc(x->rows,x->columns);
     x->tau=(gsl_vector*)gsl_vector_alloc(
           ((x->columns<x->rows)?x->columns:x->rows));

     x->list_q=(t_atom*)calloc(sizeof(t_atom),x->rows*x->rows+2);
     x->list_r=(t_atom*)calloc(sizeof(t_atom),x->rows*x->columns+2);
}

static void deleteMTXqr (MTXQr *x) 
{
   if (x->list_q!=0)
      free(x->list_q);
   if (x->list_r!=0)
      free(x->list_r);

   x->list_q = x->list_r = 0;

   if (x->a!=0)
      gsl_matrix_free(x->a);
   if (x->tau!=0)
      gsl_vector_free(x->tau);

   x->a = 0;
   x->tau = 0;
}
#endif

static void deleteMTXQr (MTXQr *x) 
{
#ifdef HAVE_LIBGSL
   deleteMTXqr(x);
#endif
}

static void *newMTXQr (t_symbol *s, int argc, t_atom *argv)
{
  MTXQr *x = (MTXQr *) pd_new (mtx_qr_class);
  x->list_q_out = outlet_new (&x->x_obj, gensym("matrix"));
  x->list_r_out = outlet_new (&x->x_obj, gensym("matrix"));
  x->list_q = 0; 
  x->list_r = 0;
#ifdef HAVE_LIBGSL
  x->a=0;
  x->tau=0;
#endif
  
  return ((void *) x);
} 

static void mTXQrBang (MTXQr *x)
{
  if (x->list_q) {
    outlet_anything(x->list_r_out, gensym("matrix"), x->rows*x->columns+2, x->list_r);
    post("mtx_qr: implementation outputs only R currently! Q has to be implemented...");
    // outlet_anything(x->list_q_out, gensym("matrix"), x->rows*x->rows+2, x->list_q);
  }
}

static void mTXQrMatrix (MTXQr *x, t_symbol *s, 
			      int argc, t_atom *argv)
{
  int rows = atom_getint (argv++);
  int columns = atom_getint (argv++);
  int size = rows * columns;
  int in_size = argc-2;
  int m,n;


#ifdef HAVE_LIBGSL
  /* size check */
  if (!size) 
    post("mtx_qr: invalid dimensions");
  else if (in_size<size) 
    post("mtx_qr: sparse matrix not yet supported: use \"mtx_check\"");
  else {
     x->rows=rows;
     x->columns=columns;

    deleteMTXqr(x);
    allocMTXqr(x);

    for (n=0;n<in_size;n++) 
       x->a->data[n]=(double) atom_getfloat(argv++);
    
    gsl_linalg_QR_decomp(x->a,x->tau);

    
    SETFLOAT((x->list_r),(float) x->rows);
    SETFLOAT((x->list_r+1),(float) x->columns);
    for (n=0,in_size=0;n<x->rows;n++) {
       for (m=0;m<n;m++) {
           SETFLOAT((x->list_r+2+in_size), 0);
           in_size++;
       }
       for (;m<x->columns;m++) {
           SETFLOAT((x->list_r+2+in_size), (float) x->a->data[in_size]);
           in_size++;
       }
    }

    SETFLOAT((x->list_q),(float) x->rows);
    SETFLOAT((x->list_q+1),(float) x->rows);

//      TODO: Housholder transformations have to be decoded from 
//      
//      x->tau and lower triangular part of x->a. 
//      
//      with L=min(rows,columns) 
//      
//      Matrix multiplications have to be done:
//      
//      Q=QL QL-1 ... Q1
//      
//      using the matrix factors 
//
//      Qi = I - tau[i] vi^T vi
//      
//      employing the dyadic vector product of
//
//         [   0    ]
//         [   :    ]
//         [   0    ]
//      vi=[A[i+1,i]]
//         [A[i+1,i]]
//         [   :    ]
//         [ A[L,i] ]
//         
//      on itself (out of x->a), 
//      and the scalar tau[i] in the vector x->tau.

    mTXQrBang(x);
  }
#else
    post("mtx_qr: implementation requires gsl");
#endif

}

void mtx_qr_setup (void)
{
  mtx_qr_class = class_new 
    (gensym("mtx_qr"),
     (t_newmethod) newMTXQr,
     (t_method) deleteMTXQr,
     sizeof (MTXQr),
     CLASS_DEFAULT, A_GIMME, 0);
  class_addbang (mtx_qr_class, (t_method) mTXQrBang);
  class_addmethod (mtx_qr_class, (t_method) mTXQrMatrix, gensym("matrix"), A_GIMME,0);
}

void iemtx_qr_setup(void){
  mtx_qr_setup();
}