source: branches/mtl-test/test/mtlmatrix_test.cc @ 987

// $Id: mtlmatrix_test.cc 987 2007-10-26 20:31:39Z jari $

/*
  Copyright (C) 2005 Jari Häkkinen, Peter Johansson
  Copyright (C) 2006 Jari Häkkinen, Markus Ringnér, Peter Johansson
  Copyright (C) 2007 Jari Häkkinen

  This file is part of the yat library, http://trac.thep.lu.se/trac/yat

  The yat library is free software; you can redistribute it and/or
  modify it under the terms of the GNU General Public License as
  published by the Free Software Foundation; either version 2 of the
  License, or (at your option) any later version.

  The yat library is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with this program; if not, write to the Free Software
  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
  02111-1307, USA.
*/

#include "yat/utility/matrix.h"

#include <cstdio>
#include <fstream>
#include <iostream>

class matrixwrapper
{
public:
  matrixwrapper(size_t i,size_t j,double value=7)
    : m_(i,j,value) {}

  inline theplu::yat::utility::vector
  row(const size_t& i) { return theplu::yat::utility::vector(m_,i); }

  inline const theplu::yat::utility::matrix& matrix(void) const { return m_; }

private:
  theplu::yat::utility::matrix m_;
};


int main(const int argc,const char* argv[])
{
  using namespace theplu::yat;
  std::ostream* error;
  if (argc>1 && argv[1]==std::string("-v"))
    error = &std::cerr;
  else {
    error = new std::ofstream("/dev/null");
    if (argc>1)
      std::cout << "matrix_test -v : for printing extra information\n";
  }

  *error << "Testing matrix class" << std::endl;
  bool ok = true;
  utility::matrix unit3x3(3,3);
  for (size_t i=0; i<unit3x3.rows(); ++i)
    unit3x3(i,i)=1;

  *error << "\tcopy constructor and operator!=" << std::endl;
  utility::matrix m(3,3,9);
  utility::matrix m2(m);
  if (m2!=m)
    ok=false;

  *error << "\toutput operator and istream constructor" << std::endl;
  // Checking that the matrix output operator writes a file that the
  // input operator can read.
  std::ofstream my_out("data/tmp_test_matrix.txt");
  my_out << m2;
  my_out.close();
  std::ifstream is("data/tmp_test_matrix.txt");
  utility::matrix m3(is);
  is.close();
  if (m3!=m2)
    ok=false;
  std::remove("data/tmp_test_matrix.txt");

  *error << "\toperator*=(double)" << std::endl;
  utility::matrix m4(3,3,1);
  m4 *= 9;
  if (m4!=m) {
    ok=false;
    *error << "error operator*=(double)" << std::endl;
  }

  *error << "\tsub-matrix" << std::endl;
  // Checking that sub-matrices work, i.e. mutation to the view are
  // reflected in the viewed object.
  is.open("data/knni_matrix.data");
  // The stream input is a proper matrix file, with some stray empty
  // lines and other whitespaces. The file is not expected to break
  // things.
  utility::matrix m5(is);
  is.close();
  double m5_sum=0;
  for (size_t i=0; i<m5.rows(); ++i)
    for (size_t j=0; j<m5.columns(); ++j)
      m5_sum+=m5(i,j);
  utility::matrix* m5sub=new utility::matrix(m5,3,3,3,3);
  double m5sub_sum=0;
  for (size_t i=0; i<m5sub->rows(); ++i)
    for (size_t j=0; j<m5sub->columns(); ++j) {
      m5sub_sum+=(*m5sub)(i,j);
      (*m5sub)(i,j)=1;
    }
  delete m5sub;
  double m5_sum2=0;
  for (size_t i=0; i<m5.rows(); ++i)
    for (size_t j=0; j<m5.columns(); ++j)
      m5_sum2+=m5(i,j);
  if (m5_sum2-m5_sum-9+m5sub_sum>1e-13) {
    ok=false;
    *error << "error sub-matrix test" << std::endl;
  }

  // Test of const view implementation (make sure no zero pointer is
  // used). Here we use the bad style of not making the view const!
  // If test fails with a null pointer exception it is an uncatchable
  // core dump!
  {
    *error << "\tconst view implementation" << std::endl;
    // Change the next statement to
    // const utility::matrix m(10,10,3.0);
    // when ticket:202 is fixes
    utility::matrix m(10,10,3.0);
    utility::matrix mview(m,3,3,3,3);
    // const utility::vector vview(vv,0,5,1); // this is the proper line
    utility::matrix m2(3,3,2.0);
    m2.mul(mview); // should work even without const since const arg passing
    m2.div(mview); // should work even without const since const arg passing
  }

  // checking that copy constructor creates an independent object when
  // a non-view matrix is copied
  {
    *error << "\tcopy constructor" << std::endl;
    utility::matrix m2(m5);
    ok &= (m2.rows()==m5.rows());
    ok &= (m2.columns()==m5.columns());
    ok &= (m2==m5);
    ok &= (&m2 != &m5);
    ok &= !m2.isview();
  }

  // checking that copy constructor creates an independent object when
  // a view matrix is copied
  {
    *error << "\tcopy contructor on view" << std::endl;
    // Change the next statement to
    // const utility::matrix m(10,10,3.0);
    // when ticket:202 is fixes
    utility::matrix m(10,10,3.0);
    utility::matrix mview(m,3,3,3,3);
    utility::matrix m3(mview);
    ok &= (mview.rows()==m3.rows());
    ok &= (mview.columns()==m3.columns());
    ok &= (m3 == mview);
    ok &= (&m3 != &mview);
    ok &= !m3.isview();
  }

  // checking that assignment operator throws an exception if matrices
  // differ in size
  {
    *error << "\tassignment operator" << std::endl;
    // GSL will catch the error in this test there for the GSL error
    // handling must be disabled until after the exception is
    // catched. The GSL error handler is reinstated after the
    // try-catch construct.
    gsl_error_handler_t* err_handler=gsl_set_error_handler_off();
    bool exception_happens=false;
    try {
      utility::matrix m(m5.rows()+1,3,0.0);
      m=m5;
    } catch (utility::GSL_error& err) {
      exception_happens=true;
    }
    if (!exception_happens) {
      *error << "Matrix assignment operator did not throw expected exception"
             << std::endl;
      ok=false;
    }
    gsl_set_error_handler(err_handler);
  }

  // checking that assignment operator changes the underlying object when
  // a view is changed.
  {
    *error << "\tassignment operator on view" << std::endl;
    bool this_ok(true);
    utility::matrix mat_view(m5,3,3,3,3);
    utility::matrix m2(3,3,12.0);
    mat_view=m2;
    for (u_int i=0; i<mat_view.rows(); ++i)
      for (u_int j=0; j<mat_view.columns(); ++j)
        if (m5(i+3,j+3)!=mat_view(i,j))
          this_ok=false;
    if (!this_ok) {
      *error << "FAIL: assignemnt operator on view" << std::endl;
      ok=false;
    }
  }

  // checking clone functionality
  {
    *error << "\tclone functionality" << std::endl;
    bool this_ok=true;
    *error << "\t\tcloning normal matrix" << std::endl;
    utility::matrix mat2;
    mat2.clone(m5);
    if (mat2.rows()!=m5.rows() || mat2.columns()!=m5.columns())
      this_ok=false;
    else
      for (u_int i=0; i<m5.rows(); ++i)
        for (u_int j=0; j<m5.columns(); ++j)
          if (mat2(i,j)!=m5(i,j))
            this_ok=false;
    if (mat2.gsl_matrix_p()==m5.gsl_matrix_p())
      this_ok=false;
    *error << "\t\tcloning matrix view (sub matrix)" << std::endl;
    utility::matrix* mat_view=new utility::matrix(m5,3,3,3,3);
    utility::matrix mat_view2;
    mat_view2.clone(*mat_view);
    if (!mat_view2.isview())
      this_ok=false;
    if ( (mat_view->rows()!=mat_view2.rows()) ||
         (mat_view->columns()!=mat_view2.columns()) )
      this_ok=false;
    else
      for (u_int i=0; i<mat_view2.rows(); ++i)
        for (u_int j=0; j<mat_view2.columns(); ++j)
          if ((*mat_view)(i,j)!=mat_view2(i,j))
            this_ok=false;
    *error << "\t\tcloned matrix view independence" << std::endl;
    delete mat_view;
    for (u_int i=0; i<mat_view2.rows(); ++i)
      for (u_int j=0; j<mat_view2.columns(); ++j)
        if (m5(i+3,j+3)!=mat_view2(i,j))
          this_ok=false;
    if (!this_ok) {
      *error << "FAIL: clone test" << std::endl;
      ok=false;
    }
  }

  *error << "\tsub-(row)vector" << std::endl;
  // Checking that the row view works, i.e. mutation to the view are
  // reflected in the viewed object.
  m5_sum2=0;
  for (size_t i=0; i<m5.rows(); ++i)
    for (size_t j=0; j<m5.columns(); ++j)
      m5_sum2+=m5(i,j);
  utility::vector v5subrow(m5,3);
  double v5subrow_sum=0;
  for (size_t i=0; i<v5subrow.size(); ++i) {
    v5subrow_sum+=v5subrow(i);
    v5subrow[i]=0;
  }
  double m5_sum3=0;
  for (size_t i=0; i<m5.rows(); ++i)
    for (size_t j=0; j<m5.columns(); ++j)
      m5_sum3+=m5(i,j);
  if (m5_sum3-m5_sum2+v5subrow_sum>1e-13) {
    ok=false;
    *error << "error sub-vector test 1" << std::endl;
  }

  *error << "\tsub-(column)vector" << std::endl;
  // Checking that the column view works, i.e. mutation to the view
  // are reflected in the viewed object.
  m5_sum3=0;
  for (size_t i=0; i<m5.rows(); ++i)
    for (size_t j=0; j<m5.columns(); ++j)
      m5_sum3+=m5(i,j);
  utility::vector v5subcolumn(m5,0,false);
  double v5subcolumn_sum=0;
  for (size_t i=0; i<v5subcolumn.size(); ++i) {
    v5subcolumn_sum+=v5subcolumn(i);
    v5subcolumn(i)=1;
  }
  double m5_sum4=0;
  for (size_t i=0; i<m5.rows(); ++i)
    for (size_t j=0; j<m5.columns(); ++j)
      m5_sum4+=m5(i,j);
  if (m5_sum4-m5_sum3-v5subcolumn.size()+v5subcolumn_sum>1e-13) {
    ok=false;
    *error << "error sub-vector test 2" << std::endl;
  }

  // Checking that the column view above mutates the values in the row
  // view.
  double v5subrow_sum2=0;
  for (size_t i=0; i<v5subrow.size(); ++i)
    v5subrow_sum2+=v5subrow(i);
  if (v5subrow_sum2-v5subcolumn(3)>1e-13) {
    ok=false;
    *error << "error sub-vector test 3" << std::endl;
  }

  *error << "\tsub-vector and vector copying" << std::endl;
  // Checking that a view is not inherited through the copy
  // contructor.
  utility::vector v6(v5subrow);
  v6.all(2);
  double v5subrow_sum3=0;
  for (size_t i=0; i<v5subrow.size(); ++i)
    v5subrow_sum3+=v5subrow(i);
  if (v5subrow_sum3-v5subrow_sum2>1e-13) {
    ok=false;
    *error << "error sub-vector test 4" << std::endl;
  }
  // Checking that values in a vector is copied into a viewed matrix.
  v5subrow = v6;
  double m5_sum5=0;
  for (size_t i=0; i<m5.rows(); ++i)
    for (size_t j=0; j<m5.columns(); ++j)
      m5_sum5+=m5(i,j);
  if (m5_sum5-m5_sum4-v5subrow.size()*2+v5subrow_sum3>1e-13) {
    ok=false;
    *error << "error sub-vector test 5" << std::endl;
  }

  // Checking that the memberfunction matrixwrapper::row() returns a
  // view
  *error << "\tthat class member returns a view" << std::endl;
  matrixwrapper mw(5,2);
  utility::vector mwrow=mw.row(2);
  if (mwrow.gsl_vector_p()->data != &(mw.matrix()(2,0))) {
    ok=false;
    *error << "error sub-vector test 7" << std::endl;
  }

  *error << "\tsub-matrix of a sub-matrix" << std::endl;
  // Checking that a sub-matrix of a sub-matrix can be created.
  utility::matrix sub(m5,3,3,3,3);
  utility::matrix subsub(sub,2,1,1,2);
  subsub(0,0)=23221121;
  if (&sub(2,1)!=&subsub(0,0) || subsub(0,0)!=m5(5,4) || &subsub(0,0)!=&m5(5,4)){
    ok=false;
    *error << "error sub-matrix test 1" << std::endl;
  }

  *error << "\tmatrix::nan()" << std::endl;
  is.open("data/sorlie_centroid_data.txt");
  utility::matrix* m_nan = new utility::matrix(is,'\t');
  utility::matrix m_weight;
  utility::nan(*m_nan,m_weight);
  is.close();
  if (m_weight(0,0)!=1){
    *error << "error in matrix::nan(): element(0,0) is " << m_weight(0,0)
           << " expected 1." << std::endl;
    ok=false;
  }
  if (m_weight(3,2)!=0){
    *error << "error in matrix::nan(): element(3,2) is " << m_weight(3,2)
           << " expected 0." << std::endl;
    ok=false;
  }
  delete m_nan;

  *error << "\toperator*=(matrix&)" << std::endl;
  utility::matrix m6(unit3x3);
  m6 *= m;
  if (m6!=m) {
    ok=false;
    *error << "error operator*=(matrix) 1" << std::endl;
  }
  m6 *= unit3x3;
  if (m6!=m) {
    ok=false;
    *error << "error operator*=(matrix) 2" << std::endl;
  }
  m6*= utility::matrix(3,4,1.0);
  m6*= utility::matrix(4,3,1.0);
  m6*= utility::matrix(3,5,2.0);
  m6*= utility::matrix(5,5,2.0);
  m6*= utility::matrix(5,3,2.0);
  m6*= unit3x3;

  if (error!=&std::cerr)
    delete error;

  return (ok ? 0 : -1);
}