timing.h

Go to the documentation of this file.

// -----------------------------------------------------------------------------
//
// Copyright (C) 2021 CERN & University of Surrey for the benefit of the
// BioDynaMo collaboration. All Rights Reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
//
// See the LICENSE file distributed with this work for details.
// See the NOTICE file distributed with this work for additional information
// regarding copyright ownership.
//
// -----------------------------------------------------------------------------
 
#ifndef CORE_UTIL_TIMING_H_
#define CORE_UTIL_TIMING_H_
 
#include <chrono>
#include <iostream>
#include <string>
 
#include "core/param/param.h"
#include "core/scheduler.h"
#include "core/simulation.h"
#include "core/util/timing_aggregator.h"
 
namespace bdm {
 
class Timing {
 public:
  typedef std::chrono::high_resolution_clock Clock;
 
  static int64_t Timestamp() {
    using std::chrono::duration_cast;
    using std::chrono::milliseconds;
    auto time = Clock::now();
    auto since_epoch = time.time_since_epoch();
    auto millis = duration_cast<milliseconds>(since_epoch);
    return millis.count();
  }
 
  template <typename TFunctor>
  static void Time(const std::string& description, TFunctor&& f) {
    static bool kUseTimer = Simulation::GetActive()->GetParam()->statistics;
    if (kUseTimer) {
      auto* agg = Simulation::GetActive()->GetScheduler()->GetOpTimes();
      Timing timing(description, agg);
      f();
    } else {
      f();
    }
  }
 
  explicit Timing(const std::string& description = "")
      : start_{Timestamp()}, text_{description} {}
 
  Timing(const std::string& description, TimingAggregator* aggregator)
      : start_{Timestamp()}, text_{description}, aggregator_{aggregator} {}
 
  ~Timing() {
    int64_t duration = (Timestamp() - start_);
    if (aggregator_ == nullptr) {
      std::cout << text_ << " " << duration << " ms" << std::endl;
    } else {
      aggregator_->AddEntry(text_, duration);
    }
  }
 
 private:
  int64_t start_;
  std::string text_;
  TimingAggregator* aggregator_ = nullptr;
};
 
}  // namespace bdm
 
#endif  // CORE_UTIL_TIMING_H_