history.h

Go to the documentation of this file.

/*
 * history.h - history class definitions
 *
 * Copyright (C) 2006, 2007 Stefan Jahn <stefan@lkcc.org>
 *
 * This 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, or (at your option)
 * any later version.
 *
 * This software 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 package; see the file COPYING.  If not, write to
 * the Free Software Foundation, Inc., 51 Franklin Street - Fifth Floor,
 * Boston, MA 02110-1301, USA.
 *
 * $Id$
 *
 */

#ifndef __HISTORY_H__
#define __HISTORY_H__

#include <memory>
#include <vector>
#include <utility>

namespace qucs {

class history
{
public:
  history ():
    sign(false),
    age(0),
    values(std::make_shared<std::vector<nr_double_t>>()),
    t(std::make_shared<std::vector<nr_double_t>>()) 
  {};
  
  history (const history &h)
  {
      this->age = h.age;
      this->t = std::make_shared<std::vector<nr_double_t>>(*(h.t));
      this->values = std::make_shared<std::vector<nr_double_t>>(*(h.values));
  }

  void push_back (const nr_double_t val) {
    this->values->push_back(val);
    if (this->values != this->t) 
      this->drop ();
  }

  /* This function drops the most recent n values in the history. */
  void truncate (const std::size_t n) = delete;
  void resize(const std::size_t n)
  {
    this->t->resize (n);
    this->values->resize (n);
  }

  std::size_t size (void) const
  {
    return t->size ();
  }

  void setAge (const nr_double_t a) { this->age = a; }
  nr_double_t getAge (void) const { return this->age; }

  // apply history
  void apply (const history & h) {
    this->t = h.t;
  }

  nr_double_t last (void) const {
    return this->t->empty() ? 0.0 : this->t->back();
  }

  nr_double_t first (void) const {
    return this->t->empty() ? 0.0 : (*this->t)[leftidx ()];
  }

  // Returns left-most valid index into the time value vector.
  unsigned int leftidx (void) const {
    int ts = this->t->size ();
    int vs = this->values->size ();
    return ts - vs > 0 ? ts - vs : 0;
  }

  std::size_t unused (void) {
    int ts = t->size ();
    int vs = values->size ();
    return vs - ts > 0 ? vs - ts : 0;
  }
  
  nr_double_t duration(void) const {
     return last () - first ();
  }
  
  void truncate (const nr_double_t);
  
  void drop (void);
  void self (void) { this->t = this->values; }

  nr_double_t interpol (nr_double_t, int, bool);
  nr_double_t nearest (nr_double_t, bool interpolate = true);
  int seek (nr_double_t, int, int, nr_double_t&, int);

  nr_double_t getTfromidx (const int idx)  {
    return this->t == NULL ? 0.0 : (*this->t)[idx];
  }
  nr_double_t getValfromidx (const int idx) {
    return this->values == NULL ? 0.0 : (*this->values)[idx];
  }

 private:
  bool sign;
  nr_double_t age;
  std::shared_ptr<std::vector<nr_double_t>> values;
  std::shared_ptr<std::vector<nr_double_t>> t;
};

} // namespace qucs

#endif /* __HISTORY_H__ */