mirror of
				https://github.com/catchorg/Catch2.git
				synced 2025-10-31 12:17:11 +01:00 
			
		
		
		
	Add 'Introduced in Catch 2.9.0.' text
This commit is contained in:
		 Clare Macrae
					Clare Macrae
				
			
				
					committed by
					
						 Martin Hořeňovský
						Martin Hořeňovský
					
				
			
			
				
	
			
			
			 Martin Hořeňovský
						Martin Hořeňovský
					
				
			
						parent
						
							1d13d88833
						
					
				
				
					commit
					d5a69cd400
				
			| @@ -1,6 +1,8 @@ | ||||
| <a id="top"></a> | ||||
| # Authoring benchmarks | ||||
|  | ||||
| > [Introduced](https://github.com/catchorg/Catch2/issues/1616) in Catch 2.9.0. | ||||
|  | ||||
| _Note that benchmarking support is disabled by default and to enable it, | ||||
| you need to define `CATCH_CONFIG_ENABLE_BENCHMARKING`. For more details, | ||||
| see the [compile-time configuration documentation](configuration.md#top)._ | ||||
|   | ||||
| @@ -277,6 +277,8 @@ either before running any tests, after running all tests - or both, depending on | ||||
| ## Specify the number of benchmark samples to collect | ||||
| <pre>--benchmark-samples <# of samples></pre> | ||||
|  | ||||
| > [Introduced](https://github.com/catchorg/Catch2/issues/1616) in Catch 2.9.0. | ||||
|  | ||||
| When running benchmarks a number of "samples" is collected. This is the base data for later statistical analysis. | ||||
| Per sample a clock resolution dependent number of iterations of the user code is run, which is independent of the number of samples. Defaults to 100. | ||||
|  | ||||
| @@ -284,6 +286,8 @@ Per sample a clock resolution dependent number of iterations of the user code is | ||||
| ## Specify the number of resamples for bootstrapping | ||||
| <pre>--benchmark-resamples <# of resamples></pre> | ||||
|  | ||||
| > [Introduced](https://github.com/catchorg/Catch2/issues/1616) in Catch 2.9.0. | ||||
|  | ||||
| After the measurements are performed, statistical [bootstrapping] is performed | ||||
| on the samples. The number of resamples for that bootstrapping is configurable | ||||
| but defaults to 100000. Due to the bootstrapping it is possible to give | ||||
| @@ -297,6 +301,8 @@ defaults to 95%). | ||||
| ## Specify the confidence-interval for bootstrapping | ||||
| <pre>--benchmark-confidence-interval <confidence-interval></pre> | ||||
|  | ||||
| > [Introduced](https://github.com/catchorg/Catch2/issues/1616) in Catch 2.9.0. | ||||
|  | ||||
| The confidence-interval is used for statistical bootstrapping on the samples to | ||||
| calculate the upper and lower bounds of mean and standard deviation. | ||||
| Must be between 0 and 1 and defaults to 0.95. | ||||
| @@ -305,6 +311,8 @@ Must be between 0 and 1 and defaults to 0.95. | ||||
| ## Disable statistical analysis of collected benchmark samples | ||||
| <pre>--benchmark-no-analysis</pre> | ||||
|  | ||||
| > [Introduced](https://github.com/catchorg/Catch2/issues/1616) in Catch 2.9.0. | ||||
|  | ||||
| When this flag is specified no bootstrapping or any other statistical analysis is performed. | ||||
| Instead the user code is only measured and the plain mean from the samples is reported. | ||||
|  | ||||
|   | ||||
| @@ -194,6 +194,8 @@ is very high and should not be encountered in practice._ | ||||
|  | ||||
| * **TEMPLATE_LIST_TEST_CASE(** _test name_, _tags_, _type list_ **)** | ||||
|  | ||||
| > [Introduced](https://github.com/catchorg/Catch2/issues/1627) in Catch 2.9.0. | ||||
|  | ||||
| _type list_ is a generic list of types on which test case should be instantiated. | ||||
| List can be `std::tuple`, `boost::mpl::list`, `boost::mp11::mp_list` or anything with | ||||
| `template <typename...>` signature. | ||||
|   | ||||
		Reference in New Issue
	
	Block a user