counter.h

/*    This file is part of the Gudhi Library. The Gudhi library
 *    (Geometric Understanding in Higher Dimensions) is a generic C++
 *    library for computational topology.
 *
 *    Author(s):       Pawel Dlotko
 *
 *    Copyright (C) 2015  INRIA Sophia-Saclay (France)
 *
 *    This program 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.
 *
 *    This program 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, see <http://www.gnu.org/licenses/>.
 */

#ifndef BITMAP_CUBICAL_COMPLEX_COUNTER_H_
#define BITMAP_CUBICAL_COMPLEX_COUNTER_H_

#include <iostream>
#include <vector>

namespace Gudhi {

namespace cubical_complex {

class counter {
 public:
  counter(const std::vector<unsigned>& endd) : begin(endd.size(), 0), end(endd), current(endd.size(), 0) { }

  counter(const std::vector< unsigned >& beginn, const std::vector< unsigned >& endd) : begin(beginn), end(endd), current(endd.size(), 0) {
    if (beginn.size() != endd.size())
      throw "In constructor of a counter, begin and end vectors do not have the same size. Program terminate";
  }

  bool increment() {
    size_t i = 0;
    while ((i != this->end.size()) && (this->current[i] == this->end[i])) {
      ++i;
    }

    if (i == this->end.size())return false;
    ++this->current[i];
    for (size_t j = 0; j != i; ++j) {
      this->current[j] = this->begin[j];
    }
    return true;
  }

  bool isFinal() {
    for (size_t i = 0; i != this->current.size(); ++i) {
      if (this->current[i] == this->end[i])return true;
    }
    return false;
  }

  std::vector< unsigned > find_opposite(const std::vector< bool >& directionsForPeriodicBCond) {
    std::vector< unsigned > result;
    for (size_t i = 0; i != this->current.size(); ++i) {
      if ((this->current[i] == this->end[i]) && (directionsForPeriodicBCond[i] == true)) {
        result.push_back(this->begin[i]);
      } else {
        result.push_back(this->current[i]);
      }
    }
    return result;
  }

  std::vector< bool > directions_of_finals() {
    std::vector< bool > result;
    for (size_t i = 0; i != this->current.size(); ++i) {
      if (this->current[i] == this->end[i]) {
        result.push_back(true);
      } else {
        result.push_back(false);
      }
    }
    return result;
  }

  friend std::ostream& operator<<(std::ostream& out, const counter& c) {
    // std::cerr << "c.current.size() : " << c.current.size() << endl;
    for (size_t i = 0; i != c.current.size(); ++i) {
      out << c.current[i] << " ";
    }
    return out;
  }

 private:
  std::vector< unsigned > begin;
  std::vector< unsigned > end;
  std::vector< unsigned > current;
};

}  // namespace cubical_complex

namespace Cubical_complex = cubical_complex;

}  // namespace Gudhi

#endif  // BITMAP_CUBICAL_COMPLEX_COUNTER_H_