1// Ceres Solver - A fast non-linear least squares minimizer
2// Copyright 2013 Google Inc. All rights reserved.
3// http://code.google.com/p/ceres-solver/
4//
5// Redistribution and use in source and binary forms, with or without
6// modification, are permitted provided that the following conditions are met:
7//
8// * Redistributions of source code must retain the above copyright notice,
9//   this list of conditions and the following disclaimer.
10// * Redistributions in binary form must reproduce the above copyright notice,
11//   this list of conditions and the following disclaimer in the documentation
12//   and/or other materials provided with the distribution.
13// * Neither the name of Google Inc. nor the names of its contributors may be
14//   used to endorse or promote products derived from this software without
15//   specific prior written permission.
16//
17// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
18// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
21// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
22// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
25// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27// POSSIBILITY OF SUCH DAMAGE.
28//
29// Author: sameeragarwal@google.com (Sameer Agarwal)
30
31#ifndef CERES_INTERNAL_EXECUTION_SUMMARY_H_
32#define CERES_INTERNAL_EXECUTION_SUMMARY_H_
33
34#include <map>
35#include <string>
36
37#include "ceres/internal/port.h"
38#include "ceres/wall_time.h"
39#include "ceres/mutex.h"
40
41namespace ceres {
42namespace internal {
43
44// Struct used by various objects to report statistics and other
45// information about their execution. e.g., ExecutionSummary::times
46// can be used for reporting times associated with various activities.
47class ExecutionSummary {
48 public:
49  void IncrementTimeBy(const string& name, const double value) {
50    CeresMutexLock l(&times_mutex_);
51    times_[name] += value;
52  }
53
54  void IncrementCall(const string& name) {
55    CeresMutexLock l(&calls_mutex_);
56    calls_[name] += 1;
57  }
58
59  const map<string, double>& times() const { return times_; }
60  const map<string, int>& calls() const { return calls_; }
61
62 private:
63  Mutex times_mutex_;
64  map<string, double> times_;
65
66  Mutex calls_mutex_;
67  map<string, int> calls_;
68};
69
70class ScopedExecutionTimer {
71 public:
72  ScopedExecutionTimer(const string& name, ExecutionSummary* summary)
73      : start_time_(WallTimeInSeconds()),
74        name_(name),
75        summary_(summary) {}
76
77  ~ScopedExecutionTimer() {
78    summary_->IncrementTimeBy(name_, WallTimeInSeconds() - start_time_);
79  }
80
81 private:
82  const double start_time_;
83  const string name_;
84  ExecutionSummary* summary_;
85};
86
87}  // namespace internal
88}  // namespace ceres
89
90#endif  // CERES_INTERNAL_EXECUTION_SUMMARY_H_
91