artstime.h

Go to the documentation of this file.

/* Copyright (C) 2020
 * Richard Larsson <ric.larsson@gmail.com>
 * 
 * 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, 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, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
 * USA. */
 
#ifndef ARTSTIME_H
#define ARTSTIME_H
 
#include <chrono>
#include <cmath>
 
#include "array.h"
#include "matpackI.h"
#include "mystring.h"
 
using TimeStep = std::chrono::duration<Numeric>;
 
class Time {
private:
  std::chrono::system_clock::time_point mtime;
 
public:
  using InternalTimeStep = decltype(mtime)::duration;
  
  // Version will be updated when C++20 datetime is available... Version 1 will still assume local time at that time
  [[nodiscard]] Index Version() const noexcept {return 1;}
  
  // Construction
  Time() : mtime(std::chrono::system_clock::now()) {}
  explicit Time(std::time_t t) : mtime(std::chrono::system_clock::from_time_t(t)) {}
  explicit Time(std::tm t) : Time(std::mktime(&t)) {}
  explicit Time(const String& t);
  
  // Data
  [[nodiscard]] const std::chrono::system_clock::time_point& Data() const {return mtime;}
  
  // Conversions
  [[nodiscard]] std::time_t toTimeT() const {return std::chrono::system_clock::to_time_t(mtime);}
  [[nodiscard]] std::tm toStruct() const {std::time_t x=toTimeT();  std::tm* y = std::localtime(&x); return *y;}
  [[nodiscard]] std::tm toGMTStruct() const {std::time_t x=toTimeT();  std::tm* y = std::gmtime(&x); return *y;}
  [[nodiscard]] TimeStep seconds_into_day() const {std::tm x = toStruct(); return TimeStep(x.tm_hour*3600 + x.tm_min*60 + x.tm_sec + PartOfSecond());}
  [[nodiscard]] InternalTimeStep EpochTime() const {return mtime.time_since_epoch();}
  
  // Operations
  InternalTimeStep operator-(const Time& t) const noexcept {return mtime - t.mtime;}
  bool operator<(const Time& t) const noexcept {return mtime < t.mtime;}
  bool operator==(const Time& t) const noexcept {return mtime == t.mtime;}
  bool operator!=(const Time& t) const noexcept {return not this -> operator==(t);}
  bool operator<=(const Time& t) const noexcept {return this -> operator<(t) or this -> operator==(t);}
  bool operator>(const Time& t) const noexcept {return not this -> operator<=(t);}
  bool operator>=(const Time& t) const noexcept {return this -> operator>(t) or this -> operator==(t);}
  template <typename T, typename R> Time& operator+=(const std::chrono::duration<T, R>& dt) {mtime += std::chrono::duration_cast<InternalTimeStep>(dt); return *this;}
  template <typename T, typename R> Time& operator-=(const std::chrono::duration<T, R>& dt) {mtime -= std::chrono::duration_cast<InternalTimeStep>(dt); return *this;}
  template <typename T, typename R> Time operator+(const std::chrono::duration<T, R>& dt) const {return (Time(*this) += dt);}
  template <typename T, typename R> Time operator-(const std::chrono::duration<T, R>& dt) const {return (Time(*this) -= dt);}
  
  // helpers
  [[nodiscard]] Numeric Seconds() const {return std::chrono::duration_cast<TimeStep>(mtime.time_since_epoch()).count();}
  void Seconds(Numeric x) {operator+=(TimeStep(x - Seconds()));}
  [[nodiscard]] Numeric PartOfSecond() const {return std::fmod(Seconds(), 1.0);}
  
  // Conversion
  explicit operator Numeric() const { return Seconds(); }
}; // Time
 
using ArrayOfTime = Array<Time>;
 
using ArrayOfArrayOfTime = Array<ArrayOfTime>;
 
using ArrayOfTimeStep = Array<TimeStep>;
 
std::ostream& operator<<(std::ostream& os, const Time& t);
 
std::istream& operator>>(std::istream& is, Time& t);
 
inline std::ostream& operator<<(std::ostream& os, const TimeStep& dt) {return os << dt.count() << " seconds";}
 
TimeStep time_stepper_selection(const String& time_step);
 
Time next_even(const Time& t, const TimeStep& dt);
 
ArrayOfIndex time_steps(const ArrayOfTime& times, const TimeStep& dt);
 
Time mean_time(const ArrayOfTime& ts, Index s=0, Index e=-1);
 
Vector time_vector(const ArrayOfTime& times);
 
ArrayOfTime time_vector(const Vector& times);
 
TimeStep median(ArrayOfTimeStep);
 
TimeStep mean(const ArrayOfTimeStep&);
 
#endif  // ARTSTIME_H