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

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

Fixes #138. Removed add, sub, scale and added appropriate operators.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 10.8 KB
Line 
1// $Id: matrix.cc 773 2007-03-01 00:51:25Z 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 <cmath>
32#include <sstream>
33#include <vector>
34
35#include <gsl/gsl_blas.h>
36
37namespace theplu {
38namespace yat {
39namespace utility {
40
41
42  matrix::matrix(void)
43    : blas_result_(NULL), m_(NULL), view_(NULL)
44  {
45  }
46
47
48  matrix::matrix(const size_t& r, const size_t& c, double init_value)
49    : blas_result_(NULL), m_(gsl_matrix_alloc(r,c)), view_(NULL)
50  {
51    if (!m_)
52      throw utility::GSL_error("matrix::matrix failed to allocate memory");
53    set_all(init_value);
54  }
55
56
57  matrix::matrix(const matrix& o)
58    : blas_result_(NULL), m_(o.create_gsl_matrix_copy()), view_(NULL)
59  {
60  }
61
62
63  matrix::matrix(matrix& m, size_t offset_row, size_t offset_column,
64                 size_t n_row, size_t n_column)
65    : blas_result_(NULL)
66  {
67    view_ = new gsl_matrix_view(gsl_matrix_submatrix(m.m_,
68                                                     offset_row,offset_column,
69                                                     n_row,n_column));
70    if (!view_)
71      throw utility::GSL_error("matrix::matrix failed to setup view");
72    m_ = &(view_->matrix);
73  }
74
75
76  // Constructor that gets data from istream
77  matrix::matrix(std::istream& is, char sep) 
78    throw (utility::IO_error,std::exception)
79    : blas_result_(NULL), view_(NULL)
80  {
81    // read the data file and store in stl vectors (dynamically
82    // expandable)
83    std::vector<std::vector<double> > data_matrix;
84    u_int nof_columns=0;
85    u_int nof_rows = 0;
86    std::string line;
87    while(getline(is, line, '\n')){
88      // Ignoring empty lines
89      if (!line.size()) {
90        continue;
91      }
92      nof_rows++;
93      std::vector<double> v;
94      std::string element;
95      std::stringstream ss(line);
96     
97      bool ok=true;
98      while(ok) {
99        if(sep=='\0')
100          ok=(ss>>element);
101        else
102          ok=getline(ss, element, sep);
103        if(!ok)
104          break;
105       
106        if(utility::is_double(element)) {
107          v.push_back(atof(element.c_str()));
108        }
109        else if (!element.size() || utility::is_nan(element)) {
110          v.push_back(std::numeric_limits<double>::quiet_NaN());
111        }
112        else {
113          std::stringstream ss("Warning: '");
114          ss << element << "' is not accepted as a matrix element.";
115          throw IO_error(ss.str());
116        }
117      }           
118      if(sep!='\0' && line[line.size()-1]==sep) // add NaN for final separator
119          v.push_back(std::numeric_limits<double>::quiet_NaN());
120      if (!nof_columns)
121        nof_columns=v.size();
122      else if (v.size()!=nof_columns) {
123        std::ostringstream s;
124        s << "matrix::matrix(std::istream&, char) data file error: "
125          << "line " << nof_rows << " has " << v.size()
126          << " columns; expected " << nof_columns << " columns.";
127        throw utility::IO_error(s.str());
128      }
129      data_matrix.push_back(v);
130    }
131
132    // manipulate the state of the stream to be good
133    is.clear(std::ios::goodbit);
134    // convert the data to a gsl matrix
135    m_ = gsl_matrix_alloc ( nof_rows, nof_columns );
136    if (!m_)
137      throw utility::GSL_error("matrix::matrix failed to allocate memory");
138
139    // if gsl error handler disabled, out of bounds index will not
140    // abort the program.
141    for(u_int i=0;i<nof_rows;i++)
142      for(u_int j=0;j<nof_columns;j++)
143        gsl_matrix_set( m_, i, j, data_matrix[i][j] );
144  }
145
146
147  matrix::~matrix(void)
148  {
149    if (view_)
150      delete view_;
151    else {
152      if (blas_result_)
153        gsl_matrix_free(blas_result_);
154      if (m_)
155        gsl_matrix_free(m_);
156    }
157    blas_result_=NULL;
158    m_=NULL;
159  }
160
161
162  size_t matrix::columns(void) const
163  {
164    if (!m_)
165      return 0;
166    return m_->size2;
167  }
168
169
170  gsl_matrix* matrix::create_gsl_matrix_copy(void) const
171  {
172    gsl_matrix* m = gsl_matrix_alloc(rows(),columns());
173    if (!m)
174      throw utility::GSL_error("matrix::create_gsl_matrix_copy failed to allocate memory");
175    if (gsl_matrix_memcpy(m,m_))
176      throw utility::GSL_error("matrix::create_gsl_matrix_copy dimension mis-match");
177    return m;
178  }
179
180
181  void matrix::div_elements(const matrix& b)
182  {
183    int status=gsl_matrix_div_elements(m_, b.m_);
184    if (status)
185      throw utility::GSL_error(std::string("matrix::div_elements",status));
186  }
187
188
189  bool matrix::equal(const matrix& other, const double d) const
190  {
191    if (columns()!=other.columns() || rows()!=other.rows())
192      return false;
193    for (size_t i=0; i<rows(); i++)
194      for (size_t j=0; j<columns(); j++)
195        // The two last condition checks are needed for NaN detection
196        if (fabs( (*this)(i,j)-other(i,j) ) > d ||
197            (*this)(i,j)!=(*this)(i,j) || other(i,j)!=other(i,j))
198          return false;
199    return true;
200  }
201
202
203  const gsl_matrix* matrix::gsl_matrix_p(void) const
204  {
205    return m_;
206  }
207
208
209  gsl_matrix* matrix::gsl_matrix_p(void)
210  {
211    return m_;
212  }
213
214
215  bool matrix::isnull(void) const
216  {
217    return gsl_matrix_isnull(m_);
218  }
219
220
221  bool matrix::isview(void) const
222  {
223    return view_;
224  }
225
226
227  double matrix::max(void) const
228  {
229    return gsl_matrix_max(m_);
230  }
231
232
233  double matrix::min(void) const
234  {
235    return gsl_matrix_min(m_);
236  }
237
238
239  void matrix::minmax_index(std::pair<size_t,size_t>& min,
240                            std::pair<size_t,size_t>& max) const
241  {
242    gsl_matrix_minmax_index(m_, &min.first, &min.second, &max.first,
243                            &max.second);
244  }
245
246
247  bool matrix::nan(matrix &m) const
248  {
249    m=matrix(rows(),columns(),1.0);
250    bool nan=false;
251    for (size_t i=0; i<rows(); i++)
252      for (size_t j=0; j<columns(); j++) 
253        if (std::isnan(operator()(i,j))) {
254          m(i,j)=0;
255          nan=true;
256        }
257    return nan;
258  }
259
260
261  void matrix::mul_elements(const matrix& b)
262  {
263    int status=gsl_matrix_mul_elements(m_, b.m_);
264    if (status)
265      throw utility::GSL_error(std::string("matrix::mul_elements",status));
266   
267  }
268
269
270  size_t matrix::rows(void) const
271  {
272    if (!m_)
273      return 0;
274    return m_->size1;
275  }
276
277
278  void matrix::set(const matrix& mat)
279  {
280    if (gsl_matrix_memcpy(m_, mat.m_))
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    gsl_matrix_set_all(m_, value);
288  }
289
290
291  void matrix::set_column(const size_t column, const vector& vec)
292  {
293    int status=gsl_matrix_set_col(m_, column, vec.gsl_vector_p());
294    if (status)
295      throw utility::GSL_error(std::string("matrix::set_column",status));
296  }
297
298
299  void matrix::set_row(const size_t row, const vector& vec)
300  {
301    int status=gsl_matrix_set_row(m_, row, vec.gsl_vector_p());
302    if (status)
303      throw utility::GSL_error(std::string("matrix::set_row",status));
304  }
305
306
307  void matrix::swap(matrix& other)
308  {
309    int status=gsl_matrix_swap(m_, other.m_);
310    if (status)
311      throw utility::GSL_error(std::string("matrix::swap",status));
312  }
313
314
315  void matrix::swap_columns(const size_t i, const size_t j)
316  {
317    int status=gsl_matrix_swap_columns(m_, i, j);
318    if (status)
319      throw utility::GSL_error(std::string("matrix::swap_columns",status));
320  }
321
322
323  void matrix::swap_rowcol(const size_t i, const size_t j)
324  {
325    int status=gsl_matrix_swap_rowcol(m_, i, j);
326    if (status)
327      throw utility::GSL_error(std::string("matrix::swap_rowcol",status));
328  }
329
330
331  void matrix::swap_rows(const size_t i, const size_t j)
332  {
333    int status=gsl_matrix_swap_rows(m_, i, j);
334    if (status)
335      throw utility::GSL_error(std::string("matrix::swap_rows",status));
336  }
337
338
339  void matrix::transpose(void)
340  {
341    if (columns()==rows())
342      gsl_matrix_transpose(m_); // this never fails
343    else {
344      gsl_matrix* transposed = gsl_matrix_alloc(columns(),rows());
345      if (!transposed)
346        throw utility::GSL_error("matrix::transpose failed to allocate memory");
347      // next line never fails if allocation above succeeded.
348      gsl_matrix_transpose_memcpy(transposed,m_);
349      gsl_matrix_free(m_);
350      m_=transposed;
351      if (blas_result_) {
352        gsl_matrix_free(blas_result_);
353        blas_result_=NULL;
354      }
355    }
356  }
357
358
359  double& matrix::operator()(size_t row, size_t column)
360  {
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(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    if ( this != &other ) {
392      if (view_)
393        delete view_;
394      else if (m_)
395        gsl_matrix_free(m_);
396      m_ = other.create_gsl_matrix_copy();
397    }
398    return *this;
399  }
400
401
402  const matrix& matrix::operator+=(const matrix& m)
403  {
404    int status=gsl_matrix_add(m_, m.m_);
405    if (status)
406      throw utility::GSL_error(std::string("matrix::operator+=", status));
407    return *this;
408  }
409
410
411  const matrix& matrix::operator+=(const double d)
412  {
413    gsl_matrix_add_constant(m_, d);
414    return *this;
415  }
416
417
418  const matrix& matrix::operator-=(const matrix& m)
419  {
420    int status=gsl_matrix_sub(m_, m.m_);
421    if (status)
422      throw utility::GSL_error(std::string("matrix::operator-=", status));
423    return *this;
424  }
425
426
427  const matrix& matrix::operator-=(const double d)
428  {
429    gsl_matrix_add_constant(m_, -d);
430    return *this;
431  }
432
433
434  const matrix& matrix::operator*=(const matrix& other)
435  {
436    if (!blas_result_) {
437      blas_result_ = gsl_matrix_alloc(rows(),other.columns());
438      if (!blas_result_)
439        throw utility::GSL_error("matrix::operator*= failed to allocate memory");
440    }
441    gsl_blas_dgemm(CblasNoTrans, CblasNoTrans, 1.0, m_, other.m_, 0.0,
442                   blas_result_);
443    gsl_matrix* tmp=m_;
444    m_=blas_result_;
445    blas_result_=tmp;
446    return *this;
447  }
448
449
450  const matrix& matrix::operator*=(const double d)
451  {
452    gsl_matrix_scale(m_, d);
453    return *this;
454  }
455
456
457  std::ostream& operator<<(std::ostream& s, const matrix& m)
458  {
459    s.setf(std::ios::dec);
460    s.precision(12);
461    for(size_t i=0, j=0; i<m.rows(); i++)
462      for (j=0; j<m.columns(); j++) {
463        s << m(i,j);
464        if (j<m.columns()-1)
465          s << s.fill();
466        else if (i<m.rows()-1)
467          s << "\n";
468      }
469    return s;
470  }
471
472
473  vector operator*(const matrix& m, const vector& v)
474  {
475    utility::vector res(m.rows());
476    for (size_t i=0; i<res.size(); ++i)
477      res(i) = vector(m,i) * v;
478    return res;
479  }
480
481
482  vector operator*(const vector& v, const matrix& m)
483  {
484    utility::vector res(m.columns());
485    for (size_t i=0; i<res.size(); ++i)
486      res(i) = v * vector(m,i,false);
487    return res;
488  }
489
490}}} // of namespace utility, yat and thep
Note: See TracBrowser for help on using the repository browser.