mirror of
https://github.com/google/benchmark.git
synced 2024-12-25 20:10:13 +08:00
Clarify the difference between BENCHMARK_TEMPLATE_F
and BENCHMARK_TEMPLATE_DEFINE_F
+ BENCHMARK_REGISTER_F
(#1815)
* Clarify BENCHMARK_REGISTER_F Add comments highlighting the difference between `BENCHMARK_TEMPLATE_F` and `BENCHMARK_TEMPLATE_DEFINE_F`, mirroring those of `BENCHMARK_F ` and `BENCHMARK_DEFINE_F`. * More informative comments. * Update user_guide.md
This commit is contained in:
parent
38df9daf48
commit
d2cd246e19
@ -624,20 +624,22 @@ public:
|
||||
}
|
||||
};
|
||||
|
||||
// Defines and registers `FooTest` using the class `MyFixture`.
|
||||
BENCHMARK_F(MyFixture, FooTest)(benchmark::State& st) {
|
||||
for (auto _ : st) {
|
||||
...
|
||||
}
|
||||
}
|
||||
|
||||
// Only defines `BarTest` using the class `MyFixture`.
|
||||
BENCHMARK_DEFINE_F(MyFixture, BarTest)(benchmark::State& st) {
|
||||
for (auto _ : st) {
|
||||
...
|
||||
}
|
||||
}
|
||||
/* BarTest is NOT registered */
|
||||
// `BarTest` is NOT registered.
|
||||
BENCHMARK_REGISTER_F(MyFixture, BarTest)->Threads(2);
|
||||
/* BarTest is now registered */
|
||||
// `BarTest` is now registered.
|
||||
```
|
||||
|
||||
### Templated Fixtures
|
||||
@ -653,19 +655,22 @@ For example:
|
||||
template<typename T>
|
||||
class MyFixture : public benchmark::Fixture {};
|
||||
|
||||
// Defines and registers `IntTest` using the class template `MyFixture<int>`.
|
||||
BENCHMARK_TEMPLATE_F(MyFixture, IntTest, int)(benchmark::State& st) {
|
||||
for (auto _ : st) {
|
||||
...
|
||||
}
|
||||
}
|
||||
|
||||
// Only defines `DoubleTest` using the class template `MyFixture<double>`.
|
||||
BENCHMARK_TEMPLATE_DEFINE_F(MyFixture, DoubleTest, double)(benchmark::State& st) {
|
||||
for (auto _ : st) {
|
||||
...
|
||||
}
|
||||
}
|
||||
|
||||
// `DoubleTest` is NOT registered.
|
||||
BENCHMARK_REGISTER_F(MyFixture, DoubleTest)->Threads(2);
|
||||
// `DoubleTest` is now registered.
|
||||
```
|
||||
|
||||
<a name="custom-counters" />
|
||||
@ -1012,11 +1017,11 @@ in any way. `<expr>` may even be removed entirely when the result is already
|
||||
known. For example:
|
||||
|
||||
```c++
|
||||
/* Example 1: `<expr>` is removed entirely. */
|
||||
// Example 1: `<expr>` is removed entirely.
|
||||
int foo(int x) { return x + 42; }
|
||||
while (...) DoNotOptimize(foo(0)); // Optimized to DoNotOptimize(42);
|
||||
|
||||
/* Example 2: Result of '<expr>' is only reused */
|
||||
// Example 2: Result of '<expr>' is only reused.
|
||||
int bar(int) __attribute__((const));
|
||||
while (...) DoNotOptimize(bar(0)); // Optimized to:
|
||||
// int __result__ = bar(0);
|
||||
|
Loading…
Reference in New Issue
Block a user