seqcounter.h

/***************************************************************************
                          seqcounter.h  -  description
                             -------------------
    begin                : Fri Jan 19 2007
    copyright            : (C) 2000-2021 by Thies H. Jochimsen
    email                : thies@jochimsen.de
 ***************************************************************************/
 
/***************************************************************************
 *                                                                         *
 *   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 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
 
#ifndef SEQCOUNTER_H
#define SEQCOUNTER_H
 
 
#include <odinseq/seqvec.h>
#include <odinseq/seqdriver.h>
#include <odinseq/seqtree.h>
 
class SeqCounter;  // forward declaration
class SeqObjList; // forward declaration
 
class SeqCounterDriver : public SeqDriverBase {
 
 public:
  SeqCounterDriver() {}
  virtual ~SeqCounterDriver() {}
 
  virtual bool prep_driver() = 0;
 
  virtual void update_driver(const SeqCounter* counter, const SeqObjList* seqlist, const List<SeqVector,const SeqVector*,const SeqVector&>* vectors) const = 0;
 
  virtual double get_preduration () const = 0;
 
  virtual double get_postduration() const = 0;
 
  virtual double get_preduration_inloop() const = 0;
 
  virtual double get_postduration_inloop() const = 0;
 
 
  virtual bool create_program(programContext& context, const STD_string& loopkernel) const = 0;
 
  virtual STD_string get_program_head(programContext& context, const STD_string& loopkernel, unsigned int times) const  = 0;
 
  virtual STD_string get_program_tail(programContext& context, const STD_string& loopkernel, unsigned int times) const  = 0;
 
  virtual STD_string get_program_head_unrolled(programContext& context, unsigned int index) const  = 0;
 
  virtual STD_string get_program_iterator(programContext& context) const  = 0;
 
 
  virtual void pre_vecprepevent (eventContext& context) const = 0;
 
  virtual void post_vecprepevent(eventContext& context, int repcounter) const = 0;
 
  virtual void outdate_cache() const = 0;
 
  virtual bool unroll_program(const SeqCounter* counter, const SeqObjList* seqlist, const List<SeqVector,const SeqVector*,const SeqVector&>* vectors, programContext& context) const = 0;
 
  virtual SeqCounterDriver* clone_driver() const = 0;
};
 
 
 
 
 
class SeqCounter : public Handled<const SeqCounter*>, public virtual SeqTreeObj {
 
 public:
  SeqCounter(const STD_string& object_label = "unnamedSeqCounter");
 
  SeqCounter(const SeqCounter& sc);
 
 
  virtual ~SeqCounter() {}
 
  SeqCounter& operator = (const SeqCounter& sc);
 
  virtual int get_times() const;
 
 
  virtual void add_vector(const SeqVector& seqvector);
 
 
 
  // counter functions
  int get_counter() const {return counter;} // also used by SeqVector
  bool counter_is_active() const {return counter!=-1;}
  void init_counter(unsigned int start=0) const;
  void increment_counter() const {counter++;}
  void disable_counter() const {counter=-1;}
 
  // helper functions (also used by platform drivers)
  bool prep_veciterations() const;
 
 
 protected:
 
  // helpers to reduce template code
  mutable STD_list<const SeqVector*>::const_iterator veciter;
  STD_list<const SeqVector*>::const_iterator get_vecbegin() const {return vectors.get_const_begin();}
  STD_list<const SeqVector*>::const_iterator get_vecend() const {return vectors.get_const_end();}
  unsigned int n_vectors() const {return vectors.size();}
 
  List<SeqVector,const SeqVector*,const SeqVector&> vectors;
 
 
  void clear_vectorlist() {vectors.clear();}
 
 
  mutable SeqDriverInterface<SeqCounterDriver> counterdriver;
 
 
  // overwriting virtual functions from SeqClass
  bool prep();
  void clear_container();
 
 private:
  friend class SeqVector;
 
 
  // helper functions (also used by SeqVector)
  virtual bool unroll_program(programContext& context) const {return true;}
 
  void set_vechandler_for_all() const;
 
  mutable int counter;
 
 
};
 
#endif