source: trunk/yat/utility/Matrix.cc @ 1487

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

Addresses #436. GPL license copy reference should also be updated.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 13.2 KB
RevLine 
[42]1// $Id: Matrix.cc 1487 2008-09-10 08:41:36Z jari $
[12]2
[570]3/*
4  Copyright (C) 2003 Daniel Dalevi, Peter Johansson
[831]5  Copyright (C) 2004 Jari Häkkinen, Peter Johansson
[1275]6  Copyright (C) 2005, 2006 Jari Häkkinen, Peter Johansson, Markus Ringnér
[1260]7  Copyright (C) 2007, 2008 Jari Häkkinen, Peter Johansson
[570]8
[1437]9  This file is part of the yat library, http://dev.thep.lu.se/yat
[570]10
[675]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
[1486]13  published by the Free Software Foundation; either version 3 of the
[675]14  License, or (at your option) any later version.
[570]15
[675]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
[570]19  General Public License for more details.
20
21  You should have received a copy of the GNU General Public License
[1487]22  along with yat. If not, see <http://www.gnu.org/licenses/>.
[570]23*/
24
[1121]25#include "Matrix.h"
26#include "Vector.h"
[1017]27#include "VectorBase.h"
[1027]28#include "VectorConstView.h"
[1015]29#include "VectorView.h"
[680]30#include "utility.h"
[273]31
[792]32#include <cassert>
[293]33#include <cmath>
[42]34#include <sstream>
[17]35#include <vector>
36
[42]37#include <gsl/gsl_blas.h>
38
39namespace theplu {
[680]40namespace yat {
[616]41namespace utility {
[12]42
43
[1121]44  Matrix::Matrix(void)
[1098]45    : blas_result_(NULL), m_(NULL)
[703]46  {
47  }
[12]48
[703]49
[1121]50  Matrix::Matrix(const size_t& r, const size_t& c, double init_value)
[1098]51    : blas_result_(NULL), m_(gsl_matrix_alloc(r,c))
[703]52  {
[753]53    if (!m_)
[1121]54      throw utility::GSL_error("Matrix::Matrix failed to allocate memory");
[830]55    all(init_value);
[703]56  }
57
58
[1121]59  Matrix::Matrix(const Matrix& o)
[1098]60    : blas_result_(NULL), m_(o.create_gsl_matrix_copy())
[703]61  {
62  }
63
64
[42]65  // Constructor that gets data from istream
[1121]66  Matrix::Matrix(std::istream& is, char sep) 
[434]67    throw (utility::IO_error,std::exception)
[1098]68    : blas_result_(NULL)
[42]69  {
[1147]70    if (!is.good())
71      throw utility::IO_error("Matrix: istream is not good");
72
[42]73    // read the data file and store in stl vectors (dynamically
74    // expandable)
75    std::vector<std::vector<double> > data_matrix;
[1271]76    unsigned int nof_columns=0;
77    unsigned int nof_rows = 0;
[434]78    std::string line;
79    while(getline(is, line, '\n')){
[128]80      // Ignoring empty lines
[434]81      if (!line.size()) {
[128]82        continue;
83      }
[434]84      nof_rows++;
85      std::vector<double> v;
86      std::string element;
87      std::stringstream ss(line);
[439]88     
[434]89      bool ok=true;
90      while(ok) {
91        if(sep=='\0')
92          ok=(ss>>element);
93        else
94          ok=getline(ss, element, sep);
95        if(!ok)
96          break;
[567]97       
[1313]98        if (!element.size())
[434]99          v.push_back(std::numeric_limits<double>::quiet_NaN());
100        else {
[1313]101          try {
102            v.push_back(convert<double>(element));
103          }
104          catch (std::runtime_error& e) {
105            std::stringstream ss(e.what());
106            ss << "\nMatrix.cc: " << element
107               << " is not accepted as a matrix element\n";
108            throw IO_error(ss.str());
109          }
[434]110        }
111      }           
[439]112      if(sep!='\0' && line[line.size()-1]==sep) // add NaN for final separator
113          v.push_back(std::numeric_limits<double>::quiet_NaN());
[420]114      if (!nof_columns)
[42]115        nof_columns=v.size();
[420]116      else if (v.size()!=nof_columns) {
117        std::ostringstream s;
[1121]118        s << "Matrix::Matrix(std::istream&, char) data file error: "
[444]119          << "line " << nof_rows << " has " << v.size()
[420]120          << " columns; expected " << nof_columns << " columns.";
121        throw utility::IO_error(s.str());
[42]122      }
123      data_matrix.push_back(v);
124    }
[273]125
[42]126    // manipulate the state of the stream to be good
127    is.clear(std::ios::goodbit);
[1147]128   
129    // if stream was empty, create nothing
130    if (!nof_columns || !nof_rows)
131      return;
132
[42]133    // convert the data to a gsl matrix
[1098]134    m_ = gsl_matrix_alloc ( nof_rows, nof_columns );
[753]135    if (!m_)
[1121]136      throw utility::GSL_error("Matrix::Matrix failed to allocate memory");
[754]137
138    // if gsl error handler disabled, out of bounds index will not
139    // abort the program.
[1271]140    for(size_t i=0;i<nof_rows;i++)
141      for(size_t j=0;j<nof_columns;j++)
[42]142        gsl_matrix_set( m_, i, j, data_matrix[i][j] );
143  }
[12]144
145
[1121]146  Matrix::~Matrix(void)
[42]147  {
[810]148    delete_allocated_memory();
[792]149    if (blas_result_)
150      gsl_matrix_free(blas_result_);
[1098]151    blas_result_=NULL;
[42]152  }
[12]153
154
[1121]155  void Matrix::all(const double value)
[1098]156  {
157    assert(m_);
158    gsl_matrix_set_all(m_, value);
159  }
160
161
[1121]162  Matrix::iterator Matrix::begin(void)
[1064]163  {
164    return iterator(&(*this)(0,0), 1);
165  }
166
167
[1121]168  Matrix::const_iterator Matrix::begin(void) const
[1064]169  {
170    return const_iterator(&(*this)(0,0), 1);
171  }
172
173
[1121]174  Matrix::column_iterator Matrix::begin_column(size_t i)
[1064]175  {
176    return iterator(&(*this)(0,i), this->columns());
177  }
178
179
[1121]180  Matrix::const_column_iterator Matrix::begin_column(size_t i) const
[1064]181  {
182    return const_iterator(&(*this)(0,i), this->columns());
183  }
184
185
[1121]186  Matrix::row_iterator Matrix::begin_row(size_t i)
[1064]187  {
188    return iterator(&(*this)(i,0), 1);
189  }
190
191
[1121]192  Matrix::const_row_iterator Matrix::begin_row(size_t i) const
[1064]193  {
194    return const_iterator(&(*this)(i,0), 1);
195  }
196
197
[1121]198  VectorView Matrix::column_view(size_t col)
[792]199  {
[1098]200    VectorView res(*this, col, false);
201    return res;
202  }
[792]203
204
[1121]205  const VectorConstView Matrix::column_const_view(size_t col) const
[1098]206  {
207    return VectorConstView(*this, col, false);
208  }
[792]209
210
[1121]211  size_t Matrix::columns(void) const
[716]212  {
[1098]213    return (m_ ? m_->size2 : 0);
[716]214  }
215
216
[1121]217  gsl_matrix* Matrix::create_gsl_matrix_copy(void) const
[716]218  {
219    gsl_matrix* m = gsl_matrix_alloc(rows(),columns());
[753]220    if (!m)
[1121]221      throw utility::GSL_error("Matrix::create_gsl_matrix_copy failed to allocate memory");
[1098]222    if (gsl_matrix_memcpy(m,m_))
[1121]223      throw utility::GSL_error("Matrix::create_gsl_matrix_copy dimension mis-match");
[716]224    return m;
225  }
226
227
[1121]228  void Matrix::delete_allocated_memory(void)
[810]229  {
[1098]230    if (m_)
[810]231      gsl_matrix_free(m_);
[1098]232    m_=NULL;
[810]233  }
234
235
[1121]236  void Matrix::div(const Matrix& other)
[716]237  {
[792]238    assert(m_);
239    int status=gsl_matrix_div_elements(m_, other.gsl_matrix_p());
[755]240    if (status)
241      throw utility::GSL_error(std::string("matrix::div_elements",status));
[716]242  }
243
244
[1121]245  Matrix::iterator Matrix::end(void)
[1064]246  {
247    return iterator(&(*this)(0,0)+rows()*columns(), 1);
248  }
249
250
[1121]251  Matrix::const_iterator Matrix::end(void) const
[1064]252  {
253    return const_iterator(&(*this)(0,0)+rows()*columns(), 1);
254  }
255
256
[1121]257  Matrix::column_iterator Matrix::end_column(size_t i)
[1064]258  {
[1103]259    return column_iterator(&(*this)(0,i)+rows()*columns(), this->columns());
[1064]260  }
261
262
[1121]263  Matrix::const_column_iterator Matrix::end_column(size_t i) const
[1064]264  {
[1103]265    return const_column_iterator(&(*this)(0,i)+rows()*columns(),this->columns());
[1064]266  }
267
268
[1121]269  Matrix::row_iterator Matrix::end_row(size_t i)
[1064]270  {
[1103]271    return row_iterator(&(*this)(i,0)+columns(), 1);
[1064]272  }
273
274
[1121]275  Matrix::const_row_iterator Matrix::end_row(size_t i) const
[1064]276  {
[1103]277    return const_row_iterator(&(*this)(i,0)+columns(), 1);
[1064]278  }
279
280
[1121]281  bool Matrix::equal(const Matrix& other, const double d) const
[272]282  {
[788]283    if (this==&other)
284      return true;
[272]285    if (columns()!=other.columns() || rows()!=other.rows())
286      return false;
[420]287    for (size_t i=0; i<rows(); i++)
288      for (size_t j=0; j<columns(); j++)
289        // The two last condition checks are needed for NaN detection
290        if (fabs( (*this)(i,j)-other(i,j) ) > d ||
[293]291            (*this)(i,j)!=(*this)(i,j) || other(i,j)!=other(i,j))
[272]292          return false;
293    return true;
294  }
[12]295
296
[1121]297  const gsl_matrix* Matrix::gsl_matrix_p(void) const
[716]298  {
[1098]299    return m_;
[716]300  }
[12]301
[716]302
[1121]303  gsl_matrix* Matrix::gsl_matrix_p(void)
[42]304  {
[716]305    return m_;
[42]306  }
[12]307
308
[1121]309  void Matrix::mul(const Matrix& other)
[716]310  {
[792]311    assert(m_);
312    int status=gsl_matrix_mul_elements(m_, other.gsl_matrix_p());
[755]313    if (status)
[1121]314      throw utility::GSL_error(std::string("Matrix::mul_elements",status));
[716]315  }
[516]316
[716]317
[1121]318  void Matrix::resize(size_t r, size_t c, double init_value)
[808]319  {
[810]320    delete_allocated_memory();
[808]321
[1172]322    assert( (r&&c) || (!r&&!c) );
323    if (r && c){
324      m_ = gsl_matrix_alloc(r,c);
325      if (!m_)
326        throw utility::GSL_error("Matrix::Matrix failed to allocate memory");
327      all(init_value);
328    }
[808]329
[810]330    // no need to delete blas_result_ if the number of rows fit, it
331    // may be useful later.
332    if (blas_result_ && (blas_result_->size1!=rows())) {
333      gsl_matrix_free(blas_result_);
334      blas_result_=NULL;
335    }
336  }
[808]337
[810]338
[1121]339  size_t Matrix::rows(void) const
[716]340  {
[1098]341    return (m_ ? m_->size1 : 0);
[716]342  }
343
344
[1121]345  const VectorConstView Matrix::row_const_view(size_t col) const
[1009]346  {
[1027]347    return VectorConstView(*this, col, true);
[1009]348  }
349
350
[1121]351  VectorView Matrix::row_view(size_t row)
[1009]352  {
[1015]353    VectorView res(*this, row, true);
[1009]354    return res;
355  }
356
357
[1121]358  void Matrix::swap_columns(const size_t i, const size_t j)
[716]359  {
[792]360    assert(m_);
[755]361    int status=gsl_matrix_swap_columns(m_, i, j);
362    if (status)
[1121]363      throw utility::GSL_error(std::string("Matrix::swap_columns",status));
[716]364  }
365
366
[1121]367  void Matrix::swap_rowcol(const size_t i, const size_t j)
[716]368  {
[792]369    assert(m_);
[755]370    int status=gsl_matrix_swap_rowcol(m_, i, j);
371    if (status)
[1121]372      throw utility::GSL_error(std::string("Matrix::swap_rowcol",status));
[716]373  }
374
375
[1121]376  void Matrix::swap_rows(const size_t i, const size_t j)
[716]377  {
[792]378    assert(m_);
[755]379    int status=gsl_matrix_swap_rows(m_, i, j);
380    if (status)
[1121]381      throw utility::GSL_error(std::string("Matrix::swap_rows",status));
[716]382  }
383
384
[1121]385  void Matrix::transpose(void)
[42]386  {
[792]387    assert(m_);
[420]388    if (columns()==rows())
[754]389      gsl_matrix_transpose(m_); // this never fails
[420]390    else {
391      gsl_matrix* transposed = gsl_matrix_alloc(columns(),rows());
[753]392      if (!transposed)
[1121]393        throw utility::GSL_error("Matrix::transpose failed to allocate memory");
[754]394      // next line never fails if allocation above succeeded.
[420]395      gsl_matrix_transpose_memcpy(transposed,m_);
396      gsl_matrix_free(m_);
[1098]397      m_ = transposed;
[762]398      if (blas_result_) {
399        gsl_matrix_free(blas_result_);
400        blas_result_=NULL;
401      }
[420]402    }
[42]403  }
[21]404
[12]405
[1121]406  double& Matrix::operator()(size_t row, size_t column)
[716]407  {
[792]408    assert(m_);
[813]409    assert(row<rows());
410    assert(column<columns());
[755]411    double* d=gsl_matrix_ptr(m_, row, column);
412    if (!d)
[1121]413      throw utility::GSL_error("Matrix::operator()",GSL_EINVAL);
[755]414    return *d;
[716]415  }
[12]416
[716]417
[1121]418  const double& Matrix::operator()(size_t row, size_t column) const
[716]419  {
[813]420    assert(row<rows());
421    assert(column<columns());
[1098]422    const double* d=gsl_matrix_const_ptr(m_, row, column);
[755]423    if (!d)
[1121]424      throw utility::GSL_error("Matrix::operator()",GSL_EINVAL);
[755]425    return *d;
[716]426  }
427
428
[1121]429  bool Matrix::operator==(const Matrix& other) const
[716]430  {
431    return equal(other);
432  }
[421]433
[716]434
[1121]435  bool Matrix::operator!=(const Matrix& other) const
[716]436  {
437    return !equal(other);
438  }
439
440
[1121]441  const Matrix& Matrix::operator=( const Matrix& other )
[12]442  {
[1098]443    assert(other.m_);
444    if (this!=&other) {
445      if ( !m_ || (other.m_->size1!=m_->size1) || (other.m_->size2!=m_->size2) )
446        resize(other.m_->size1,other.m_->size2);
[916]447      if (gsl_matrix_memcpy(m_, other.gsl_matrix_p()))
[1121]448        throw utility::GSL_error("Matrix::create_gsl_matrix_copy dimension mis-match");
[1098]449    }
[42]450    return *this;
451  }
[12]452
453
[1121]454  const Matrix& Matrix::operator+=(const Matrix& other)
[703]455  {
[792]456    assert(m_);
[1098]457    int status=gsl_matrix_add(m_, other.m_);
[773]458    if (status)
[1121]459      throw utility::GSL_error(std::string("Matrix::operator+=", status));
[703]460    return *this;
461  }
[20]462
[703]463
[1121]464  const Matrix& Matrix::operator+=(const double d)
[703]465  {
[792]466    assert(m_);
[773]467    gsl_matrix_add_constant(m_, d);
[703]468    return *this;
469  }
470
471
[1121]472  const Matrix& Matrix::operator-=(const Matrix& other)
[703]473  {
[792]474    assert(m_);
[1098]475    int status=gsl_matrix_sub(m_, other.m_);
[773]476    if (status)
[1121]477      throw utility::GSL_error(std::string("Matrix::operator-=", status));
[703]478    return *this;
479  }
480
481
[1121]482  const Matrix& Matrix::operator-=(const double d)
[773]483  {
[792]484    assert(m_);
[773]485    gsl_matrix_add_constant(m_, -d);
486    return *this;
487  }
488
489
[1121]490  const Matrix& Matrix::operator*=(const Matrix& other)
[42]491  {
[792]492    assert(m_);
[796]493    if ( blas_result_ && ((blas_result_->size1!=rows()) ||
494                          (blas_result_->size2!=other.columns())) ) {
495      gsl_matrix_free(blas_result_);
496      blas_result_=NULL;
497    }
[762]498    if (!blas_result_) {
499      blas_result_ = gsl_matrix_alloc(rows(),other.columns());
500      if (!blas_result_)
[1121]501        throw utility::GSL_error("Matrix::operator*= failed to allocate memory");
[762]502    }
[1098]503    gsl_blas_dgemm(CblasNoTrans, CblasNoTrans, 1.0, m_, other.m_, 0.0, blas_result_);
[762]504    gsl_matrix* tmp=m_;
[1098]505    m_ = blas_result_;
[762]506    blas_result_=tmp;
[420]507    return *this;
[42]508  }
[20]509
[12]510
[1121]511  const Matrix& Matrix::operator*=(const double d)
[703]512  {
[792]513    assert(m_);
[773]514    gsl_matrix_scale(m_, d);
[703]515    return *this;
516  }
[12]517
[703]518
[1121]519  bool isnull(const Matrix& other)
[774]520  {
[792]521    return gsl_matrix_isnull(other.gsl_matrix_p());
[774]522  }
523
524
[1121]525  double max(const Matrix& other)
[774]526  {
[792]527    return gsl_matrix_max(other.gsl_matrix_p());
[774]528  }
529
530
[1121]531  double min(const Matrix& other)
[774]532  {
[792]533    return gsl_matrix_min(other.gsl_matrix_p());
[774]534  }
535
536
[1121]537  void minmax_index(const Matrix& other,
[774]538                    std::pair<size_t,size_t>& min, std::pair<size_t,size_t>& max)
539  {
[792]540    gsl_matrix_minmax_index(other.gsl_matrix_p(), &min.first, &min.second,
[774]541                            &max.first, &max.second);
542  }
543
544
[1121]545  bool nan(const Matrix& templat, Matrix& flag)
[774]546  {
547    size_t rows=templat.rows();
548    size_t columns=templat.columns();
549    if (rows!=flag.rows() && columns!=flag.columns())
[1098]550      flag.resize(rows,columns,1.0);
[774]551    else
[830]552      flag.all(1.0);
[774]553    bool nan=false;
554    for (size_t i=0; i<rows; i++)
555      for (size_t j=0; j<columns; j++) 
556        if (std::isnan(templat(i,j))) {
557          flag(i,j)=0;
558          nan=true;
559        }
560    return nan;
561  }
562
563
[1121]564  void swap(Matrix& a, Matrix& b)
[774]565  {
[794]566    assert(a.gsl_matrix_p()); assert(b.gsl_matrix_p());
[774]567    int status=gsl_matrix_swap(a.gsl_matrix_p(), b.gsl_matrix_p());
568    if (status)
[1121]569      throw utility::GSL_error(std::string("swap(Matrix&,Matrix&)",status));
[774]570  }
571
572
[1121]573  std::ostream& operator<<(std::ostream& s, const Matrix& m)
[42]574  {
[420]575    s.setf(std::ios::dec);
[42]576    s.precision(12);
[420]577    for(size_t i=0, j=0; i<m.rows(); i++)
[273]578      for (j=0; j<m.columns(); j++) {
579        s << m(i,j);
580        if (j<m.columns()-1)
[593]581          s << s.fill();
[273]582        else if (i<m.rows()-1)
583          s << "\n";
584      }
[420]585    return s;
[42]586  }
[12]587
[737]588
[1121]589  Vector operator*(const Matrix& m, const VectorBase& v)
[737]590  {
[1120]591    utility::Vector res(m.rows());
[737]592    for (size_t i=0; i<res.size(); ++i)
[1027]593      res(i) = VectorConstView(m,i) * v;
[737]594    return res;
595  }
596
597
[1121]598  Vector operator*(const VectorBase& v, const Matrix& m)
[737]599  {
[1120]600    utility::Vector res(m.columns());
[737]601    for (size_t i=0; i<res.size(); ++i)
[1027]602      res(i) = v * VectorConstView(m,i,false);
[737]603    return res;
604  }
605
[680]606}}} // of namespace utility, yat and thep
Note: See TracBrowser for help on using the repository browser.