aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRoman Lebedev <lebedev.ri@gmail.com>2018-08-30 11:59:50 +0300
committerGitHub <noreply@github.com>2018-08-30 11:59:50 +0300
commit5159967520f45d2bb31b226b810f4f8dc03df1c4 (patch)
treee784c16d05e24b403d4522b51a948f0247fc3ec9
parentcaa2fcb19c83e233bdcaf56d299b9951b8414066 (diff)
downloadgoogle-benchmark-5159967520f45d2bb31b226b810f4f8dc03df1c4.tar.gz
Mark Set{Items,Bytes}Processed()/{items,bytes}_processed() as deprecated. (#654)
They are basically proto-version of custom user counters. It does not seem that they do anything that custom user counters don't do. And having two similar entities is not good for generalization. Migration plan: * ``` SetItemsProcessed(<val>) => state.counters.insert({ {"<Name>", benchmark::Counter(<val>, benchmark::Counter::kIsRate)}, ... }); ``` * ``` SetBytesProcessed(<val>) => state.counters.insert({ {"<Name>", benchmark::Counter(<val>, benchmark::Counter::kIsRate, benchmark::Counter::OneK::kIs1024)}, ... }); ``` * ``` <Name>_processed() => state.counters["<Name>"] ``` One thing the custom user counters miss is better support for units of measurement. Refs. https://github.com/google/benchmark/issues/627
-rw-r--r--include/benchmark/benchmark.h16
1 files changed, 16 insertions, 0 deletions
diff --git a/include/benchmark/benchmark.h b/include/benchmark/benchmark.h
index e6ada56..adaeeee 100644
--- a/include/benchmark/benchmark.h
+++ b/include/benchmark/benchmark.h
@@ -542,9 +542,17 @@ class State {
//
// REQUIRES: a benchmark has exited its benchmarking loop.
BENCHMARK_ALWAYS_INLINE
+ BENCHMARK_DEPRECATED_MSG(
+ "The SetItemsProcessed()/items_processed()/SetBytesProcessed()/"
+ "bytes_processed() will be removed in a future release. "
+ "Please use custom user counters.")
void SetBytesProcessed(int64_t bytes) { bytes_processed_ = bytes; }
BENCHMARK_ALWAYS_INLINE
+ BENCHMARK_DEPRECATED_MSG(
+ "The SetItemsProcessed()/items_processed()/SetBytesProcessed()/"
+ "bytes_processed() will be removed in a future release. "
+ "Please use custom user counters.")
int64_t bytes_processed() const { return bytes_processed_; }
// If this routine is called with complexity_n > 0 and complexity report is
@@ -565,9 +573,17 @@ class State {
//
// REQUIRES: a benchmark has exited its benchmarking loop.
BENCHMARK_ALWAYS_INLINE
+ BENCHMARK_DEPRECATED_MSG(
+ "The SetItemsProcessed()/items_processed()/SetBytesProcessed()/"
+ "bytes_processed() will be removed in a future release. "
+ "Please use custom user counters.")
void SetItemsProcessed(int64_t items) { items_processed_ = items; }
BENCHMARK_ALWAYS_INLINE
+ BENCHMARK_DEPRECATED_MSG(
+ "The SetItemsProcessed()/items_processed()/SetBytesProcessed()/"
+ "bytes_processed() will be removed in a future release. "
+ "Please use custom user counters.")
int64_t items_processed() const { return items_processed_; }
// If this routine is called, the specified label is printed at the