source: trunk/test/iterator_test.cc @ 1532

// $Id: iterator_test.cc 1532 2008-09-24 22:06:47Z peter $

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

  This file is part of the yat library, http://dev.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 3 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 yat. If not, see <http://www.gnu.org/licenses/>.
*/

#include "Suite.h"

#include "yat/classifier/DataLookup1D.h"

#include "yat/classifier/DataLookupWeighted1D.h"
#include "yat/classifier/MatrixLookupWeighted.h"
#include "yat/utility/Container2DIterator.h"
#include "yat/utility/DataIterator.h"
#include "yat/utility/Matrix.h"
#include "yat/utility/MatrixWeighted.h"
#include "yat/utility/stl_utility.h"
#include "yat/utility/Vector.h"
#include "yat/utility/VectorView.h"
#include "yat/utility/VectorConstView.h"
#include "yat/utility/WeightedIterator.h"
#include "yat/utility/WeightIterator.h"

#include <boost/iterator/transform_iterator.hpp>

#include <algorithm>
#include <fstream>
#include <iterator>
#include <string>
#include <vector>

using namespace theplu::yat;

void old_main(test::Suite&);

template<typename Iterator>
void is_weighted(Iterator, test::Suite&);

bool is_weighted(utility::unweighted_iterator_tag x) { return false; } 
bool is_weighted(utility::weighted_iterator_tag x) { return true; }

void test_boost_util(test::Suite&);

template<typename TrivialIterator>
void test_trivial_iterator(const TrivialIterator&, test::Suite&);

template<typename InputIterator>
void test_input_iterator(InputIterator&, test::Suite&);

template<typename OutputIterator>
void test_output_iterator(OutputIterator&, test::Suite&);

template<typename ForwardIterator>
void test_forward_iterator(ForwardIterator, test::Suite&);

template<typename BidirectionalIterator>
void test_bidirectional_iterator(BidirectionalIterator, test::Suite&);

template<typename RandomAccessIterator>
void test_random_access_iterator(RandomAccessIterator, test::Suite&);

void test_stride_iterator(test::Suite& suite);
void test_weighted_iterator(test::Suite& suite);

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

  test_stride_iterator(suite);
  old_main(suite);
  test_boost_util(suite);
  test_weighted_iterator(suite);
  return suite.return_value();
}
  
template<typename Iterator>
void is_weighted(Iterator i, test::Suite& suite)
{
  suite.err() << "testing that iterator is unweighted... ";
  typename utility::weighted_iterator_traits<Iterator>::type tag;
  if (is_weighted(tag))
    suite.err() << "ok.\n";
  else {
    suite.err() << "failed.\n";
    suite.add(false);
  }
    
}


void old_main(test::Suite& suite)
{
  suite.err() << "testing utility::Vector::iterator" << std::endl;
  utility::Vector vec(12);
  classifier::DataLookup1D lookup(vec);
  utility::Vector::iterator begin=vec.begin();
  test_random_access_iterator(begin, suite);
  // test iterator to const_iterator conversion
  utility::Vector::const_iterator ci = vec.begin();
  test_random_access_iterator(ci, suite);
  ci = begin;
  if (begin!=ci)
    suite.add(false);

  suite.err() << "sorting...";
  utility::Vector::iterator end=vec.end();
  std::sort(begin, end);
  suite.err() << " sorting done\n";

  suite.err() << "testing classifier::DataLookup1D::const_iterator" << std::endl;
  classifier::DataLookup1D::const_iterator lbegin=lookup.begin();
  classifier::DataLookup1D::const_iterator lend=lookup.end();
  test_random_access_iterator(lbegin, suite);
  
  suite.err() << "copy from DataLookup1D to Vector" << std::endl;
  std::copy(lbegin, lend, begin);
  suite.err() << "copy from Vector to Vector" << std::endl;
  std::copy(begin, end, begin);
  suite.err() << "sort Vector" << std::endl;
  std::sort(begin, end);

  // test std algorithm on IteratorWeighted
  utility::Matrix m(1,3,1);
  m(0,1)=2.0;
  utility::Matrix w(1,3,1);
  classifier::MatrixLookupWeighted mw(m,w);
  classifier::DataLookupWeighted1D aw(mw,0,true);
  size_t nof1=std::count(aw.begin(),aw.end(),
                         std::pair<double, double>(1.0, 1.0));
  if(nof1!=2) {
    suite.err() << "std algoritm with IteratorWeighted failed" << std::endl;
    suite.add(false);
  }
  if (aw.begin()!=mw.begin_row(0))
    suite.add(false);
  if (aw.end()!=mw.end_row(0))
    suite.add(false);
  classifier::DataLookupWeighted1D aw2(mw,0,false);
  if (aw2.begin()!=mw.begin_column(0))
    suite.add(false);
  if (aw2.end()!=mw.end_column(0))
    suite.add(false);

  utility::DataIterator<classifier::DataLookupWeighted1D::const_iterator> 
    data_iter(aw2.begin());
  suite.add(*data_iter == 1.0);
  suite.add(*data_iterator(aw2.begin()) == 1.0);
  std::vector<double> stl_vec(1,0);
  utility::DataIterator<std::vector<double>::iterator>  
    data_iter2(stl_vec.begin());
  suite.add(*data_iter2 == 0.0);
  *data_iter2 = 3.14;
  suite.add(*data_iter2 == 3.14);
  utility::WeightIterator<std::vector<double>::iterator>  
    data_iter3(stl_vec.begin());
  suite.add(*data_iter3 == 1.0);

  // testing constness conversion
  std::vector<double>::const_iterator c_iter(stl_vec.begin());
  std::vector<double>::iterator iter(stl_vec.begin());
  suite.add(iter==c_iter);
  utility::DataIterator<std::vector<double>::const_iterator>  
    data_iter4(c_iter);
  utility::DataIterator<std::vector<double>::iterator>  
    data_iter5(iter);
  suite.add(data_iter2 == data_iter5);
  suite.add(data_iter4 == data_iter5);
  utility::StrideIterator<std::vector<double>::const_iterator> stride_ci(c_iter);
  utility::StrideIterator<std::vector<double>::iterator> stride_i(iter);
  suite.add(stride_ci==stride_i);
  suite.add(stride_i==stride_ci);

  utility::MatrixWeighted x_weighted(3,4);
  x_weighted.begin();
  *x_weighted.begin();
  utility::DataWeight element = *x_weighted.begin();
  *(x_weighted.begin()+1) = element;
  double element_data = *data_iterator(x_weighted.begin());
  suite.add(element_data==x_weighted.begin()->data());

  classifier::MatrixLookup ml(m);
  classifier::DataLookup1D dl1(ml,0,true);
  if (dl1.begin()!=ml.begin_row(0))
    suite.add(false);
  if (dl1.end()!=ml.end_row(0))
    suite.add(false);
  classifier::DataLookup1D dl2(ml,0,false);
  if (dl2.begin()!=ml.begin_column(0))
    suite.add(false);
  if (dl2.end()!=ml.end_column(0))
    suite.add(false);

}

void test_boost_util(test::Suite& suite)
{
  bool ok_cached=suite.ok();
  utility::PairFirst<std::pair<std::string, int> > pf;
  std::pair<std::string, int> p("July", 31);
  std::string str=pf(p);
  suite.add(str=="July");
  pf(p)="juli";
  suite.add(pf(p)=="juli");

  typedef utility::PairFirst<std::pair<const std::string, int> > PF2;
  PF2 pf2;
  std::pair<const std::string, int> p2("July", 31);
  suite.add(pf2(p2)=="July");

  utility::PairFirst<const std::pair<std::string, int> > pf3;
  std::pair<std::string, int> p3("July", 31);
  suite.add(pf3(p3)=="July");

  utility::PairFirst<std::pair<std::string, const int> > pf4;
  std::pair<std::string, const int> p4("July", 31);
  suite.add(pf4(p4)=="July");
  pf4(p4)="juli";
  suite.add(pf4(p4)=="juli");

  utility::PairFirst<std::pair<const std::string, const int> > pf5;
  std::pair<const std::string, const int> p5("July", 31);
  suite.add(pf5(p5)=="July");

  typedef std::map<std::string, int> Map;
  Map m;
  m["July"]=31;
  m["September"]=30;
  m["June"]=30;
  m["April"]=30;

  boost::transform_iterator<PF2, Map::iterator> first_iterator(m.begin(), pf2);
  boost::transform_iterator<PF2, Map::iterator> first_iterator_end(m.end(), pf2);
  std::vector<std::string> vec(m.size());
  std::copy(first_iterator, first_iterator_end, vec.begin());
  std::vector<std::string> correct;
  correct.push_back("April");
  correct.push_back("July");
  correct.push_back("June");
  correct.push_back("September");
  for (size_t i=0; i<vec.size(); ++i)
    if (!suite.add(vec[i]==correct[i]))
      suite.err() << "Error: vec[" << i << "] = " << vec[i] 
                  << " expected " << correct[i] << "\n";

  std::vector<std::string> vec2(m.size());
  std::copy(utility::pair_first_iterator(m.begin()), 
            utility::pair_first_iterator(m.end()),
            vec2.begin());
  suite.add(vec2==vec);
  
  std::vector<int> days;
  days.resize(m.size());
  std::copy(utility::pair_second_iterator(m.begin()), 
            utility::pair_second_iterator(m.end()),
            days.begin());
  std::vector<int> days_correct;
  days_correct.push_back(30);
  days_correct.push_back(31);
  days_correct.push_back(30);
  days_correct.push_back(30);
  for (size_t i=0; i<days.size(); ++i)
    if (!suite.add(days[i]==days_correct[i]))
      suite.err() << "Error: days[" << i << "] = " << days[i] 
                  << " expected " << days_correct[i] << "\n";
  days = std::vector<int>(days.size(), 0);
  std::copy(days.begin(), days.end(), utility::pair_second_iterator(m.begin()));
  for (std::map<std::string, int>::const_iterator i=m.begin(); i!=m.end(); ++i)
    if (!suite.add(i->second==0) )
      suite.err() << "Error: m[" << i->first << "] = " << i->second 
                  << " expected 0\n";

  if (ok_cached && !suite.ok())
    suite.err() << "test_bool_util failed" << std::endl;
}

template<typename TrivialIterator>
void test_trivial_iterator(const TrivialIterator& iter, test::Suite& suite)
{
  suite.err() << "  testing Trivial features" << std::endl;
  typename std::iterator_traits<TrivialIterator>::value_type tmp = *iter;
  suite.add(tmp==*iter);
}

template<typename InputIterator>
void test_input_iterator(InputIterator& iter, test::Suite& suite)
{
  test_trivial_iterator(iter, suite);
  suite.err() << "  testing Input features" << std::endl;
  // just to check compilation
  if (false) {
    ++iter;
    iter++;
  }
}

template<typename OutputIterator>
void test_output_iterator(OutputIterator& iter, test::Suite& suite)
{
  test_trivial_iterator(iter, suite);
  suite.err() << "  testing Output features" << std::endl;
}

template<typename ForwardIterator>
void test_forward_iterator(ForwardIterator iter, test::Suite& suite)
{
  test_output_iterator(iter, suite);
  test_input_iterator(iter, suite);
  suite.err() << "  testing Forward features" << std::endl;

  typename std::iterator_traits<ForwardIterator>::value_type tmp = *iter;
  // testing multiple traversing is possible and does not change the data
  ForwardIterator iter1 = iter;
  ++iter1;
  suite.add(iter!=iter1);
  ForwardIterator iter2 = iter;
  ++iter2;
  suite.add(tmp==*iter);

}

template<typename BidirectionalIterator>
void test_bidirectional_iterator(BidirectionalIterator iter, test::Suite& suite)
{
  test_forward_iterator(iter, suite);
  bool ok_cached = suite.ok();
  suite.err() << "  testing Bidirectional features" << std::endl;
  const BidirectionalIterator i = iter;
  BidirectionalIterator tmp = iter--;
  suite.add(tmp==i);
  ++iter;
  tmp = --iter;
  if (!suite.add(tmp==iter))
    suite.err() << "operator-- failed" << std::endl;
  suite.add(++tmp==i);
  if (ok_cached && !suite.ok())
    suite.err() << "failed" << std::endl;
}

template<typename RandomAccessIterator>
void test_random_access_iterator(RandomAccessIterator iter, test::Suite& suite)
{
  test_bidirectional_iterator(iter, suite);
  suite.err() << "  testing RandomAccess features" << std::endl;
  bool ok_cached = suite.ok();
  RandomAccessIterator iter2 = iter;
  iter2 += 1;
  iter2 -= 1;
  RandomAccessIterator& iter3 = (iter2 += 1);
  RandomAccessIterator& iter4 = (iter3 -= 1);
  if (!suite.add(iter2 == iter4))
    suite.err() << "operator-(int) failed" << std::endl;
  suite.add(++iter2 == iter3);
  
  RandomAccessIterator iter5 = iter + 0;
  RandomAccessIterator iter6 = 0 + iter;
  suite.add(iter6 == iter5);

  RandomAccessIterator iter7 = iter - 0;
  suite.add(iter7 == iter);
  suite.add(iter7 - iter == 0);
  suite.add(! (iter7<iter));

  if (!suite.add(iter[0] == *iter))
    suite.err() << "operator[] failed" << std::endl;
  if (ok_cached && !suite.ok())
    suite.err() << "failed" << std::endl;
}

void test_stride_iterator(test::Suite& suite)
{
  suite.err() << "testing StrideIterator" << std::endl;
  using utility::Vector;
  Vector a(10);
  // stride 2
  utility::VectorConstView b(a, 0, 5, 2);
  if (!suite.add(b.end()-b.begin()==5))
    suite.err() << "ERROR: StrideIterator::operator- returned: " 
                << b.end()-b.begin() 
                << " expected 5\n";
  utility::VectorView c(a, 0, 3, 2);
  Vector::iterator begin = c.begin();
  Vector::iterator end = c.end();
  Vector::const_iterator cbegin = begin;
  Vector::const_iterator cend = end;

  if (!suite.add(c.size()==3))
    suite.err() << "c.size() incorrect" << std::endl;
  if (!suite.add(cend-cbegin == 3))
    suite.err() << "cend-cbegin failed\n"; 
}

void test_weighted_iterator(test::Suite& suite)
{
  std::vector<double> vec(3,1);
  typedef std::vector<double>::iterator Iter;
  utility::WeightedIterator<Iter, Iter> iter(vec.begin(), vec.begin());

  test_random_access_iterator(iter, suite);

}