unity.scopes.testing.StudentsTTest

Implements different variants of the Student's T-test (see http://en.wikipedia.org/wiki/Student's_t-test) More...

#include <unity/scopes/testing/Statistics.h>

Classes
struct	Result
	Executing the test returns a set of hypothesis that have to be evaluated at the desired confidence level. More...

Public Member Functions
Result	one_sample (const Sample &sample, Sample::ValueType mean, Sample::ValueType std_dev)
	one_sample calculates the Student's T test for one sample and a known mean and std. dev.. More...

Result	two_independent_samples (const Sample &sample1, const Sample &sample2)
	two_independent_samples calculates the Student's T test for two samples More...

Detailed Description

Implements different variants of the Student's T-test (see href="http://en.wikipedia.org/wiki/Student's_t-test">http://en.wikipedia.org/wiki/Student's_t-test)

<a class="code" href="unity.scopes.testing.OutOfProcessBenchmark.md">unity::scopes::testing::OutOfProcessBenchmark</a> benchmark;
<a class="code" href="unity.scopes.testing.Result.md">unity::scopes::testing::Result</a> search_result;
<a class="code" href="unity.scopes.ActionMetadata.md">unity::scopes::ActionMetadata</a> meta_data{default_locale, default_form_factor};
<span class="keyword">static</span> <span class="keyword">const</span> std::size_t sample_size{10};
<span class="keyword">static</span> <span class="keyword">const</span> std::chrono::seconds per_trial_timeout{1};
<a class="code" href="unity.scopes.testing.Benchmark.PreviewConfiguration.md">unity::scopes::testing::Benchmark::PreviewConfiguration</a> config
{
[search_result, meta_data]() { <span class="keywordflow">return</span> std::make_pair(search_result, meta_data); },
{
sample_size,
per_trial_timeout
}
};
<span class="keyword">auto</span> result = benchmark.<a class="code" href="unity.scopes.testing.OutOfProcessBenchmark.md#a397be9ae5eaca3d6ca96fa2957498c86">for_preview</a>(scope, config);
<span class="keyword">auto</span> test_result = <a class="code" href="index.html">unity::scopes::testing::StudentsTTest</a>().<a class="code" href="#aaf584b159766a0a0e605e8365f87107f">one_sample</a>(
reference_preview_performance,
result);
EXPECT_EQ(unity::scopes::testing::HypothesisStatus::not_rejected,
test_result.sample_mean_is_eq_to_reference(0.05));
EXPECT_EQ(unity::scopes::testing::HypothesisStatus::not_rejected,
test_result.sample_mean_is_ge_than_reference(0.05));
EXPECT_EQ(unity::scopes::testing::HypothesisStatus::rejected,
test_result.sample_mean_is_le_than_reference(0.05));

Member Function Documentation

unity::scopes::testing::StudentsTTest::Result unity::scopes::testing::StudentsTTest::one_sample	(	const Sample &	sample,
		Sample::ValueType	mean,
		Sample::ValueType	std_dev
	)

one_sample calculates the Student's T test for one sample and a known mean and std. dev..

Parameters

sample	Sample of values.
mean	The known mean of the underlying distribution
std_dev	The known std. dev. of the underlying distribution

Returns

unity::scopes::testing::StudentsTTest::Result unity::scopes::testing::StudentsTTest::two_independent_samples	(	const Sample &	sample1,
		const Sample &	sample2
	)

two_independent_samples calculates the Student's T test for two samples

Parameters

sample1	The first sample
sample2	The second sample

Returns: An instance of Result.

unity.scopes.testing.StudentsTTest

Classes

Public Member Functions

Detailed Description

Member Function Documentation