source: trunk/test/vector_test.cc @ 1275

// $Id: vector_test.cc 1275 2008-04-11 06:10:12Z jari $

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

  This file is part of the yat library, http://trac.thep.lu.se/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 "Suite.h"

#include "yat/utility/Exception.h"
#include "yat/utility/FileUtil.h"
#include "yat/utility/utility.h"
#include "yat/utility/Vector.h"
#include "yat/utility/VectorConstView.h"
#include "yat/utility/VectorView.h"

#include <cstddef>
#include <fstream>
#include <sstream>

using namespace theplu::yat;

void check_file_access(std::string& str)
{
  
  if (utility::FileUtil(str).permissions("r")) {
    std::cerr << "test_nni: Cannot access file " << str << std::endl;
    exit(-1);
  }
}

int main(int argc,char* argv[])
{  
  test::Suite suite(argc, argv);
  suite.err() << "testing vector" << std::endl;

  utility::Vector vec(12);
  for (size_t i=0; i<vec.size(); i++) 
    vec(i)=i;

  // checking that shuffle works
  suite.err() << "shuffle" << std::endl;
  double sum_before = utility::sum(vec);
  shuffle(vec);
  double sum_after = utility::sum(vec);
  if (sum_after!=sum_before){
    suite.err() << "shuffle failed" << std::endl;
    suite.add(false);
  }

  // checking that view works
  suite.err() << "view" << std::endl;
  sum_before=0;
  for (size_t i=0; i<vec.size(); i+=2) 
    sum_before+=vec(i);
  utility::VectorView vec_view(vec,0,6,2);
  sum_after=utility::sum(vec_view);
  suite.add(suite.equal(sum_after, sum_before));
  vec(0)=0;
  vec_view(0)=24;
  suite.add(suite.equal(vec(0), vec_view(0)));

  // 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!
  {
    suite.err() << "const view implementation" << std::endl;
    const utility::Vector vv(10,3.0);
    utility::VectorConstView vview(vv,0,5,1);
    // const utility::Vector vview(vv,0,5,1); // this is the proper line
    utility::Vector vv2(5,2.0);
    vv2.mul(vview); // should work even without const since const arg passing
    vv2.div(vview); // should work even without const since const arg passing
    suite.add(suite.equal(vview*vview, 3.0*3.0*vview.size()));
  }

  // checking that copy constructor creates an independent object when
  // a non-view vector is copied
  {
    suite.err() << "copy constructor" << std::endl;
    utility::Vector vec2(vec);
    suite.add(vec.size()==vec2.size());
    suite.add(suite.equal_range(vec2.begin(), vec2.end(), vec.begin()));
    suite.add(&vec2 != &vec);
    suite.add(!vec2.isview());
  }

  // checking that copy constructor creates an independent object when
  // a view vector is copied
  {
    suite.err() << "copy contructor on view" << std::endl;
    utility::Vector vec3(vec_view);
    suite.add(vec_view.size()==vec3.size());
    suite.add(suite.equal_range(vec3.begin(), vec3.end(), vec_view.begin()));
    suite.add(!vec3.isview());
  }

  // checking that assignment operator throws an exception if vectors
  // differ in size
  {
    suite.err() << "assignment 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::Vector v(vec_view.size()+1,0.0);
      vec_view=v;
    } catch (utility::GSL_error& err) {
      exception_happens=true;
    }
    if (!exception_happens) {
      suite.err() << "Vector assignment operator did not throw expected exception"
               << std::endl;
      suite.add(false);
    }
    gsl_set_error_handler(err_handler);
  }

  // checking that assignment operator changes the underlying object when
  // a view is changed.
  {
    suite.err() << "assignment operator on view" << std::endl;
    vec(3)=vec(4)=vec(5)=13;
    utility::VectorView vec_view(vec,3,3,1);
    utility::Vector vec2(3,123.0);
    vec_view=vec2;
    if (vec(3)!=vec_view(0) || vec(4)!=vec_view(1) || vec(5)!=vec_view(2)){
      suite.err() << " failed\n";
      suite.add(false);
    }
  }

  // checking clone functionality
  {
    suite.err() << "clone functionality" << std::endl;
    bool this_ok=true;
    suite.err() << "\tcloning normal vector" << std::endl;
    utility::Vector vec2(3,123.0);
    vec2 = vec;
    if (vec.size()!=vec2.size())
      this_ok=false;
    else
      for (size_t i=0; i<vec.size(); ++i)
        if (vec(i)!=vec2(i))
          this_ok=false;
    if (vec.gsl_vector_p()==vec2.gsl_vector_p())
      this_ok=false;
    suite.err() << "\tcloning vector view" << std::endl;
    utility::VectorView* vec_view=new utility::VectorView(vec,3,3,1);
    utility::VectorView vec_view2(*vec_view);
    if (!vec_view2.isview())
      this_ok=false;
    if (vec_view->size()!=vec_view2.size())
      this_ok=false;
    else
      for (size_t i=0; i<vec_view2.size(); ++i)
        if ((*vec_view)(i)!=vec_view2(i))
          this_ok=false;
    suite.err() << "\tcloned vector view independence" << std::endl;
    delete vec_view;
    if (vec(3)!=vec_view2(0) || vec(4)!=vec_view2(1) || vec(5)!=vec_view2(2))
      this_ok=false;

    if (!this_ok) {
      suite.err() << "FAIL: clone test" << std::endl;
      suite.add(false);
    }
  }

  // checking that reading vectors from properly formatted files works
  try {
    suite.err() << "stream" << std::endl;
    std::string data1(test::filename("data/vector1.data"));
    std::string data2(test::filename("data/vector2.data"));
    std::string data3(test::filename("data/vector3.data"));
    std::string data4(test::filename("data/vector4.data"));
    check_file_access(data1);
    check_file_access(data2);
    check_file_access(data3);
    check_file_access(data4);
    std::ifstream data_stream1(data1.c_str());
    std::ifstream data_stream2(data2.c_str());
    std::ifstream data_stream3(data3.c_str());
    std::ifstream data_stream4(data4.c_str());
    utility::Vector vec1(data_stream1);
    suite.add(vec1.size()==9);
    vec1=utility::Vector(data_stream2);
    suite.add(vec1.size()==9);
    utility::Vector vec2(data_stream3);
    suite.add(vec2.size()==12);
    vec2=utility::Vector(data_stream4);
    suite.add(vec2.size()==12);
  } catch (utility::IO_error& err) {
    suite.err() << err.what() << std::endl;
    suite.add(false);
  }

  // Checking that vector stream input operator can read whatever
  // vector stream output operator produces.
  {
    suite.err() << "checking that output stream is valid as an input stream"
             << std::endl;
    std::stringstream s;
    s << vec;
    utility::Vector vec2(s);
    suite.add(suite.equal_range(vec.begin(), vec.end(), vec2.begin()));
  }

  // Checking that badly formatted files are not accepted, or at least
  // throws an exception for the programmer to catch.
  suite.err() << "checking that bad stream are rejected" << std::endl;
  bool this_ok=false;
  // Checking that unexpected characters in a stream gives error. 
  try {
    std::string data5(test::filename("data/vector5.data"));
    check_file_access(data5);
    std::ifstream data_stream5(data5.c_str());
    utility::Vector dummy(data_stream5); // this will give an exception
  } catch (utility::IO_error& err) {
    suite.err() << err.what() << std::endl;
    this_ok=true; // good, exception thrown, test passed
  }
  try {
    std::string data(test::filename("data/vector6.data"));
    check_file_access(data);
    std::ifstream data_stream(data.c_str());
    utility::Vector dummy(data_stream); // this will give an exception
  } catch (utility::IO_error& err) {
    suite.err() << err.what() << std::endl;
    this_ok=true; // good, exceoption thrown, test passed
  }
  suite.add(this_ok);

  this_ok=false;
  try {
    std::string data(test::filename("data/vector7.data"));
    check_file_access(data);
    std::ifstream data_stream(data.c_str());
    vec=utility::Vector(data_stream); // this will give an exception
  } catch (utility::IO_error& err) {
    suite.err() << err.what() << std::endl;
    this_ok=true; // good, exceoption thrown, test passed
  }
  suite.add(this_ok);


  // Test sort algorithms
  {
    std::string data3(test::filename("data/vector3.data"));
    std::ifstream data_stream3(data3.c_str());
    utility::Vector vec3(data_stream3);
    std::vector<size_t> dummy;
    dummy.push_back(100); // To make sure it works starting with a non-empty vector

    utility::sort_index(dummy,vec3);
    if(dummy.size()!=vec3.size()) {
      suite.add(false);
      suite.err() << "Vector of sorted indices has incorrect size" << std::endl;
    }
    if(dummy[0]!=11 || dummy[dummy.size()-1]!=8) {
      suite.add(false);
      suite.err() << "Vector of sorted indices incorrect" << std::endl;
    }
    size_t k=3;

    utility::sort_smallest_index(dummy,k,vec3);
    if(dummy.size()!=k) {
      suite.add(false);
      suite.err() << "Vector of sorted smallest indices has incorrect size" << std::endl;
    }
    if(dummy[0]!=11 || dummy[dummy.size()-1]!=9) {
      suite.add(false);
      suite.err() << "Vector of sorted smallest indices incorrect" << std::endl;
    }

    k=4;
    utility::sort_largest_index(dummy,k,vec3);
    if(dummy.size()!=k) {
      suite.add(false);
      suite.err() << "Vector of sorted largest indices has incorrect size" << std::endl;
    }
    if(dummy[0]!=8 || dummy[dummy.size()-1]!=5) {
      suite.add(false);
      suite.err() << "Vector of sorted largest indices incorrect" << std::endl;
    }
  }

  {
    utility::Vector vec(10, 2.3);
    utility::VectorView vv(vec);
    vec = vv;
    if (vec.size()!=10){
      suite.err() << "indirect self-assignment failed - size should be 10\n";
      suite.add(false);
    }
    if (vec(0)!=2.3){
      suite.err() << "indirect self-assignment failed - vec(0) should be 2.3\n";
      suite.add(false);
    }
    utility::VectorView vv2(vec, 0, 5);
    vec = vv2;
    if (vec.size()!=5){
      suite.err() << "indirect self-assignment failed - size should be 5\n";
      suite.add(false);
    }
    if (vec(0)!=2.3){
      suite.err() << "indirect self-assignment failed - vec(0) should be 2.3\n";
      suite.add(false);
    }
  }

  // test for ticket:285
  {
    theplu::yat::utility::Vector vec(10);
    theplu::yat::utility::Vector vec2;
    vec2 = vec;
  }

  return suite.return_value();
}