Sequence::HKAresults Struct Reference
[Molecular Population Genetics]

results of calculations of the HKA test More...

#include <Sequence/HKA.hpp>

Public Types
enum	chisq_tuple_elements { POLY, DIV, POLYA, POLYB }
typedef boost::tuple< double, double, double, double >	chisq_tuple
Public Member Functions
	HKAresults (const std::vector< double > &_thetas, const std::vector< chisq_tuple > &_chisquareds, const double &_fhat, const double &_That, const double &_xsq, const double &_xsqA, const double &_xsqB)
Public Attributes
const std::vector< double >	thetas
std::vector< chisq_tuple >	chisquareds
const double	fhat
const double	That
const double	xsq
const double	xsqA
const double	xsqB

Detailed Description

results of calculations of the HKA test

Store the list of estimates of theta for each locus, as well as f (ratio of Ne of spp B relative to sppA), and T, the divergence time between species (on the scale of the Ne of spp A).

Definition at line 67 of file HKA.hpp.

Member Typedef Documentation

typedef boost::tuple<double,double,double,double> Sequence::HKAresults::chisq_tuple

The tuple represents the contribution of a locus to the total value of the HKA chi-squared statistic

Definition at line 79 of file HKA.hpp.

Member Enumeration Documentation

enum Sequence::HKAresults::chisq_tuple_elements

The enum documents the order in which the deviations are stored in chisq_tuple

Definition at line 84 of file HKA.hpp.

Constructor & Destructor Documentation

Sequence::HKAresults::HKAresults	(	const std::vector< double > &	_thetas,
		const std::vector< chisq_tuple > &	_chisquareds,
		const double &	_fhat,
		const double &	_That,
		const double &	_xsq,
		const double &	_xsqA,
		const double &	_xsqB
	)			`[explicit]`

Parameters:

	_thetas	a vector containing the estimats of theta for each locus
	_chisquareds	a vector of the per-locus contributions to the test statistic
	_fhat	an estimate of the relative Ne of species b to species a
	_That	an estimate of the divergence time, on the scale of Ne in species a.
	_xsq	the Chi-squared statistic for the HKA test
	_xsqA	The HKA chi-squared statistic, only considering species A
	_xsqB	The HKA chi-squared statistic, only considering species B

Definition at line 85 of file HKA.cc.

Member Data Documentation

std::vector< chisq_tuple > Sequence::HKAresults::chisquareds

The order of elements is the same as the loci that were placed in the std::vector< HKAdata > passed to calcHKA. Members of the tuple are accessed via the boost::get<int> template function. For example, if you have an HKAresults object called hkares, and you want to retrieve the deviation in divergence of the first locus:

      boost::get< DIV >(hkares.chisquareds[0]);

The template argument to boost::get can be taken from chisq_tuple_elements so that it's readable.

Definition at line 98 of file HKA.hpp.

const double Sequence::HKAresults::fhat

The relative Ne of species B relative to species A

Definition at line 103 of file HKA.hpp.

const double Sequence::HKAresults::That

The estimate of the species divergence time, on the scale (1+fhat)*4Ne generations

Definition at line 108 of file HKA.hpp.

const std::vector< double > Sequence::HKAresults::thetas

Vector of theta estimates from the HKA test. They are in the same order as the loci that were placed in the std::vector< HKAdata > passed to calcHKA

Definition at line 74 of file HKA.hpp.

const double Sequence::HKAresults::xsq

The HKA chi-squared statistic

Definition at line 112 of file HKA.hpp.

const double Sequence::HKAresults::xsqA

The HKA chi-squared statistic, only considering species A

Definition at line 117 of file HKA.hpp.

const double Sequence::HKAresults::xsqB

The HKA chi-squared statistic, only considering species B

Definition at line 122 of file HKA.hpp.

The documentation for this struct was generated from the following files:

Sequence::HKAresults Struct Reference [Molecular Population Genetics]

Public Types