blob: accc5e47d1576d9f578b00da9188b5eab407f5a0 [file] [log] [blame]
Austin Schuh70cc9552019-01-21 19:46:48 -08001// Ceres Solver - A fast non-linear least squares minimizer
Austin Schuh3de38b02024-06-25 18:25:10 -07002// Copyright 2023 Google Inc. All rights reserved.
Austin Schuh70cc9552019-01-21 19:46:48 -08003// http://ceres-solver.org/
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 <mutex>
36#include <string>
Austin Schuh3de38b02024-06-25 18:25:10 -070037#include <utility>
Austin Schuh70cc9552019-01-21 19:46:48 -080038
Austin Schuh3de38b02024-06-25 18:25:10 -070039#include "ceres/internal/export.h"
Austin Schuh70cc9552019-01-21 19:46:48 -080040#include "ceres/wall_time.h"
41
Austin Schuh3de38b02024-06-25 18:25:10 -070042namespace ceres::internal {
Austin Schuh70cc9552019-01-21 19:46:48 -080043
44struct CallStatistics {
Austin Schuh3de38b02024-06-25 18:25:10 -070045 CallStatistics() = default;
46 double time{0.};
47 int calls{0};
Austin Schuh70cc9552019-01-21 19:46:48 -080048};
49
50// Struct used by various objects to report statistics about their
51// execution.
52class ExecutionSummary {
53 public:
54 void IncrementTimeBy(const std::string& name, const double value) {
55 std::lock_guard<std::mutex> l(mutex_);
56 CallStatistics& call_stats = statistics_[name];
57 call_stats.time += value;
58 ++call_stats.calls;
59 }
60
61 const std::map<std::string, CallStatistics>& statistics() const {
62 return statistics_;
63 }
64
65 private:
66 std::mutex mutex_;
67 std::map<std::string, CallStatistics> statistics_;
68};
69
70class ScopedExecutionTimer {
71 public:
Austin Schuh3de38b02024-06-25 18:25:10 -070072 ScopedExecutionTimer(std::string name, ExecutionSummary* summary)
73 : start_time_(WallTimeInSeconds()),
74 name_(std::move(name)),
75 summary_(summary) {}
Austin Schuh70cc9552019-01-21 19:46:48 -080076
77 ~ScopedExecutionTimer() {
78 summary_->IncrementTimeBy(name_, WallTimeInSeconds() - start_time_);
79 }
80
81 private:
82 const double start_time_;
83 const std::string name_;
84 ExecutionSummary* summary_;
85};
86
Austin Schuh3de38b02024-06-25 18:25:10 -070087} // namespace ceres::internal
Austin Schuh70cc9552019-01-21 19:46:48 -080088
89#endif // CERES_INTERNAL_EXECUTION_SUMMARY_H_