source: trunk/yat/utility/matrix.cc @ 792

Last change on this file since 792 was 792, checked in by Jari Häkkinen, 15 years ago

Addresses #193. matrix now works as outlined in the ticket
discussion. Added support for const views. Added a clone function that
facilitates resizing of matrices. clone is needed since assignement
operator functionality is changed.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 12.3 KB
Line 
1// $Id: matrix.cc 792 2007-03-11 00:14:24Z jari $
2
3/*
4  Copyright (C) 2003 Daniel Dalevi, Peter Johansson
5  Copyright (C) 2004 Jari Häkkinen, Peter Johansson
6  Copyright (C) 2005, 2006 Jari Häkkinen, Peter Johansson, Markus Ringnér
7  Copyright (C) 2007 Jari Häkkinen
8
9  This file is part of the yat library, http://lev.thep.lu.se/trac/yat
10
11  The yat library is free software; you can redistribute it and/or
12  modify it under the terms of the GNU General Public License as
13  published by the Free Software Foundation; either version 2 of the
14  License, or (at your option) any later version.
15
16  The yat library is distributed in the hope that it will be useful,
17  but WITHOUT ANY WARRANTY; without even the implied warranty of
18  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19  General Public License for more details.
20
21  You should have received a copy of the GNU General Public License
22  along with this program; if not, write to the Free Software
23  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
24  02111-1307, USA.
25*/
26
27#include "matrix.h"
28#include "vector.h"
29#include "utility.h"
30
31#include <cassert>
32#include <cmath>
33#include <sstream>
34#include <vector>
35
36#include <gsl/gsl_blas.h>
37
38namespace theplu {
39namespace yat {
40namespace utility {
41
42
43  matrix::matrix(void)
44    : blas_result_(NULL), m_(NULL), view_(NULL), view_const_(NULL),
45      proxy_m_(NULL)
46  {
47  }
48
49
50  matrix::matrix(const size_t& r, const size_t& c, double init_value)
51    : blas_result_(NULL), m_(gsl_matrix_alloc(r,c)), view_(NULL),
52      view_const_(NULL), proxy_m_(m_)
53  {
54    if (!m_)
55      throw utility::GSL_error("matrix::matrix failed to allocate memory");
56    set_all(init_value);
57  }
58
59
60  matrix::matrix(const matrix& o)
61    : blas_result_(NULL), m_(o.create_gsl_matrix_copy()), view_(NULL),
62      view_const_(NULL), proxy_m_(m_)
63  {
64  }
65
66
67  matrix::matrix(matrix& m, size_t offset_row, size_t offset_column,
68                 size_t n_row, size_t n_column)
69    : blas_result_(NULL), view_const_(NULL)
70  {
71    view_ = new gsl_matrix_view(gsl_matrix_submatrix(m.m_,
72                                                     offset_row,offset_column,
73                                                     n_row,n_column));
74    if (!view_)
75      throw utility::GSL_error("matrix::matrix failed to setup view");
76    proxy_m_ = m_ = &(view_->matrix);
77  }
78
79
80  // Constructor that gets data from istream
81  matrix::matrix(std::istream& is, char sep) 
82    throw (utility::IO_error,std::exception)
83    : blas_result_(NULL), view_(NULL), view_const_(NULL)
84  {
85    // read the data file and store in stl vectors (dynamically
86    // expandable)
87    std::vector<std::vector<double> > data_matrix;
88    u_int nof_columns=0;
89    u_int nof_rows = 0;
90    std::string line;
91    while(getline(is, line, '\n')){
92      // Ignoring empty lines
93      if (!line.size()) {
94        continue;
95      }
96      nof_rows++;
97      std::vector<double> v;
98      std::string element;
99      std::stringstream ss(line);
100     
101      bool ok=true;
102      while(ok) {
103        if(sep=='\0')
104          ok=(ss>>element);
105        else
106          ok=getline(ss, element, sep);
107        if(!ok)
108          break;
109       
110        if(utility::is_double(element)) {
111          v.push_back(atof(element.c_str()));
112        }
113        else if (!element.size() || utility::is_nan(element)) {
114          v.push_back(std::numeric_limits<double>::quiet_NaN());
115        }
116        else {
117          std::stringstream ss("Warning: '");
118          ss << element << "' is not accepted as a matrix element.";
119          throw IO_error(ss.str());
120        }
121      }           
122      if(sep!='\0' && line[line.size()-1]==sep) // add NaN for final separator
123          v.push_back(std::numeric_limits<double>::quiet_NaN());
124      if (!nof_columns)
125        nof_columns=v.size();
126      else if (v.size()!=nof_columns) {
127        std::ostringstream s;
128        s << "matrix::matrix(std::istream&, char) data file error: "
129          << "line " << nof_rows << " has " << v.size()
130          << " columns; expected " << nof_columns << " columns.";
131        throw utility::IO_error(s.str());
132      }
133      data_matrix.push_back(v);
134    }
135
136    // manipulate the state of the stream to be good
137    is.clear(std::ios::goodbit);
138    // convert the data to a gsl matrix
139    proxy_m_ = m_ = gsl_matrix_alloc ( nof_rows, nof_columns );
140    if (!m_)
141      throw utility::GSL_error("matrix::matrix failed to allocate memory");
142
143    // if gsl error handler disabled, out of bounds index will not
144    // abort the program.
145    for(u_int i=0;i<nof_rows;i++)
146      for(u_int j=0;j<nof_columns;j++)
147        gsl_matrix_set( m_, i, j, data_matrix[i][j] );
148  }
149
150
151  matrix::~matrix(void)
152  {
153    if (view_)
154      delete view_;
155    else if (view_const_)
156      delete view_const_;
157    else if (m_)
158      gsl_matrix_free(m_);
159    if (blas_result_)
160      gsl_matrix_free(blas_result_);
161    blas_result_=NULL;
162    m_=NULL;
163  }
164
165
166  const matrix& matrix::clone(const matrix& other)
167  {
168    if (this!=&other) {
169
170      if (view_)
171        delete view_;
172      else if (view_const_)
173        delete view_const_;
174      else if (m_)
175        gsl_matrix_free(m_);
176      if (blas_result_) {
177        gsl_matrix_free(blas_result_);
178        blas_result_=NULL;
179      }
180      proxy_m_=m_=NULL;
181
182      if (other.view_) {
183        view_ = new gsl_matrix_view(*other.view_);
184        proxy_m_ = m_ = &(view_->matrix);
185      }
186      else if (other.view_const_) {
187        view_const_ = new gsl_matrix_const_view(*other.view_const_);
188        proxy_m_ = &(view_const_->matrix);
189      }
190      else if (other.m_)
191        proxy_m_ = m_ = other.create_gsl_matrix_copy();
192
193    }
194    return *this;
195  } 
196
197
198  size_t matrix::columns(void) const
199  {
200    if (!proxy_m_)
201      return 0;
202    return proxy_m_->size2;
203  }
204
205
206  gsl_matrix* matrix::create_gsl_matrix_copy(void) const
207  {
208    gsl_matrix* m = gsl_matrix_alloc(rows(),columns());
209    if (!m)
210      throw utility::GSL_error("matrix::create_gsl_matrix_copy failed to allocate memory");
211    if (gsl_matrix_memcpy(m,proxy_m_))
212      throw utility::GSL_error("matrix::create_gsl_matrix_copy dimension mis-match");
213    return m;
214  }
215
216
217  void matrix::div(const matrix& other)
218  {
219    assert(m_);
220    int status=gsl_matrix_div_elements(m_, other.gsl_matrix_p());
221    if (status)
222      throw utility::GSL_error(std::string("matrix::div_elements",status));
223  }
224
225
226  bool matrix::equal(const matrix& other, const double d) const
227  {
228    if (this==&other)
229      return true;
230    if (columns()!=other.columns() || rows()!=other.rows())
231      return false;
232    for (size_t i=0; i<rows(); i++)
233      for (size_t j=0; j<columns(); j++)
234        // The two last condition checks are needed for NaN detection
235        if (fabs( (*this)(i,j)-other(i,j) ) > d ||
236            (*this)(i,j)!=(*this)(i,j) || other(i,j)!=other(i,j))
237          return false;
238    return true;
239  }
240
241
242  const gsl_matrix* matrix::gsl_matrix_p(void) const
243  {
244    return proxy_m_;
245  }
246
247
248  gsl_matrix* matrix::gsl_matrix_p(void)
249  {
250    return m_;
251  }
252
253
254  bool matrix::isview(void) const
255  {
256    return view_ || view_const_;
257  }
258
259
260  void matrix::mul(const matrix& other)
261  {
262    assert(m_);
263    int status=gsl_matrix_mul_elements(m_, other.gsl_matrix_p());
264    if (status)
265      throw utility::GSL_error(std::string("matrix::mul_elements",status));
266  }
267
268
269  size_t matrix::rows(void) const
270  {
271    if (!proxy_m_)
272      return 0;
273    return proxy_m_->size1;
274  }
275
276
277  void matrix::set(const matrix& other)
278  {
279    assert(m_);
280    if (gsl_matrix_memcpy(m_, other.gsl_matrix_p()))
281      throw utility::GSL_error("matrix::create_gsl_matrix_copy dimension mis-match");
282  }
283
284
285  void matrix::set_all(const double value)
286  {
287    assert(m_);
288    gsl_matrix_set_all(m_, value);
289  }
290
291
292  void matrix::set_column(const size_t column, const vector& vec)
293  {
294    assert(m_);
295    int status=gsl_matrix_set_col(m_, column, vec.gsl_vector_p());
296    if (status)
297      throw utility::GSL_error(std::string("matrix::set_column",status));
298  }
299
300
301  void matrix::set_row(const size_t row, const vector& vec)
302  {
303    assert(m_);
304    int status=gsl_matrix_set_row(m_, row, vec.gsl_vector_p());
305    if (status)
306      throw utility::GSL_error(std::string("matrix::set_row",status));
307  }
308
309
310  void matrix::swap_columns(const size_t i, const size_t j)
311  {
312    assert(m_);
313    int status=gsl_matrix_swap_columns(m_, i, j);
314    if (status)
315      throw utility::GSL_error(std::string("matrix::swap_columns",status));
316  }
317
318
319  void matrix::swap_rowcol(const size_t i, const size_t j)
320  {
321    assert(m_);
322    int status=gsl_matrix_swap_rowcol(m_, i, j);
323    if (status)
324      throw utility::GSL_error(std::string("matrix::swap_rowcol",status));
325  }
326
327
328  void matrix::swap_rows(const size_t i, const size_t j)
329  {
330    assert(m_);
331    int status=gsl_matrix_swap_rows(m_, i, j);
332    if (status)
333      throw utility::GSL_error(std::string("matrix::swap_rows",status));
334  }
335
336
337  void matrix::transpose(void)
338  {
339    assert(m_);
340    if (columns()==rows())
341      gsl_matrix_transpose(m_); // this never fails
342    else {
343      gsl_matrix* transposed = gsl_matrix_alloc(columns(),rows());
344      if (!transposed)
345        throw utility::GSL_error("matrix::transpose failed to allocate memory");
346      // next line never fails if allocation above succeeded.
347      gsl_matrix_transpose_memcpy(transposed,m_);
348      gsl_matrix_free(m_);
349      proxy_m_ = m_ = transposed;
350      if (blas_result_) {
351        gsl_matrix_free(blas_result_);
352        blas_result_=NULL;
353      }
354    }
355  }
356
357
358  double& matrix::operator()(size_t row, size_t column)
359  {
360    assert(m_);
361    double* d=gsl_matrix_ptr(m_, row, column);
362    if (!d)
363      throw utility::GSL_error("matrix::operator()",GSL_EINVAL);
364    return *d;
365  }
366
367
368  const double& matrix::operator()(size_t row, size_t column) const
369  {
370    const double* d=gsl_matrix_const_ptr(proxy_m_, row, column);
371    if (!d)
372      throw utility::GSL_error("matrix::operator()",GSL_EINVAL);
373    return *d;
374  }
375
376
377  bool matrix::operator==(const matrix& other) const
378  {
379    return equal(other);
380  }
381
382
383  bool matrix::operator!=(const matrix& other) const
384  {
385    return !equal(other);
386  }
387
388
389  const matrix& matrix::operator=( const matrix& other )
390  {
391    set(other);
392    return *this;
393  }
394
395
396  const matrix& matrix::operator+=(const matrix& other)
397  {
398    assert(m_);
399    int status=gsl_matrix_add(m_, other.proxy_m_);
400    if (status)
401      throw utility::GSL_error(std::string("matrix::operator+=", status));
402    return *this;
403  }
404
405
406  const matrix& matrix::operator+=(const double d)
407  {
408    assert(m_);
409    gsl_matrix_add_constant(m_, d);
410    return *this;
411  }
412
413
414  const matrix& matrix::operator-=(const matrix& other)
415  {
416    assert(m_);
417    int status=gsl_matrix_sub(m_, other.proxy_m_);
418    if (status)
419      throw utility::GSL_error(std::string("matrix::operator-=", status));
420    return *this;
421  }
422
423
424  const matrix& matrix::operator-=(const double d)
425  {
426    assert(m_);
427    gsl_matrix_add_constant(m_, -d);
428    return *this;
429  }
430
431
432  const matrix& matrix::operator*=(const matrix& other)
433  {
434    assert(m_);
435    if (!blas_result_) {
436      blas_result_ = gsl_matrix_alloc(rows(),other.columns());
437      if (!blas_result_)
438        throw utility::GSL_error("matrix::operator*= failed to allocate memory");
439    }
440    gsl_blas_dgemm(CblasNoTrans, CblasNoTrans, 1.0, m_, other.proxy_m_, 0.0,
441                   blas_result_);
442    gsl_matrix* tmp=m_;
443    proxy_m_ = m_ = blas_result_;
444    blas_result_=tmp;
445    return *this;
446  }
447
448
449  const matrix& matrix::operator*=(const double d)
450  {
451    assert(m_);
452    gsl_matrix_scale(m_, d);
453    return *this;
454  }
455
456
457  bool isnull(const matrix& other)
458  {
459    return gsl_matrix_isnull(other.gsl_matrix_p());
460  }
461
462
463  double max(const matrix& other)
464  {
465    return gsl_matrix_max(other.gsl_matrix_p());
466  }
467
468
469  double min(const matrix& other)
470  {
471    return gsl_matrix_min(other.gsl_matrix_p());
472  }
473
474
475  void minmax_index(const matrix& other,
476                    std::pair<size_t,size_t>& min, std::pair<size_t,size_t>& max)
477  {
478    gsl_matrix_minmax_index(other.gsl_matrix_p(), &min.first, &min.second,
479                            &max.first, &max.second);
480  }
481
482
483  bool nan(const matrix& templat, matrix& flag)
484  {
485    size_t rows=templat.rows();
486    size_t columns=templat.columns();
487    if (rows!=flag.rows() && columns!=flag.columns())
488      flag.clone(matrix(rows,columns,1.0));
489    else
490      flag.set_all(1.0);
491    bool nan=false;
492    for (size_t i=0; i<rows; i++)
493      for (size_t j=0; j<columns; j++) 
494        if (std::isnan(templat(i,j))) {
495          flag(i,j)=0;
496          nan=true;
497        }
498    return nan;
499  }
500
501
502  void swap(matrix& a, matrix& b)
503  {
504    assert(v.gsl_matrix_p()); assert(w.gsl_matrix_p());
505    int status=gsl_matrix_swap(a.gsl_matrix_p(), b.gsl_matrix_p());
506    if (status)
507      throw utility::GSL_error(std::string("swap(matrix&,matrix&)",status));
508  }
509
510
511  std::ostream& operator<<(std::ostream& s, const matrix& m)
512  {
513    s.setf(std::ios::dec);
514    s.precision(12);
515    for(size_t i=0, j=0; i<m.rows(); i++)
516      for (j=0; j<m.columns(); j++) {
517        s << m(i,j);
518        if (j<m.columns()-1)
519          s << s.fill();
520        else if (i<m.rows()-1)
521          s << "\n";
522      }
523    return s;
524  }
525
526
527  vector operator*(const matrix& m, const vector& v)
528  {
529    utility::vector res(m.rows());
530    for (size_t i=0; i<res.size(); ++i)
531      res(i) = vector(m,i) * v;
532    return res;
533  }
534
535
536  vector operator*(const vector& v, const matrix& m)
537  {
538    utility::vector res(m.columns());
539    for (size_t i=0; i<res.size(); ++i)
540      res(i) = v * vector(m,i,false);
541    return res;
542  }
543
544}}} // of namespace utility, yat and thep
Note: See TracBrowser for help on using the repository browser.