Sequence::SimParams Class Reference

Parameters for Hudson's simulation program. More...

#include <Sequence/SimParams.hpp>

Public Member Functions
std::istream &	read (std::istream &s)
int	fromfile (FILE *openfile)
std::string	params (void) const
unsigned	totsam (void) const
unsigned	runs (void) const

Friends
std::ostream &	operator<< (std::ostream &, class SimParams &object)

Detailed Description

Parameters for Hudson's simulation program.

include SimParams.h Allows reading in and printing out of the parameter list that Hudson's coalescent simulation program spits out at the beginning of its execution. An example of use is found in tajd.cc in the Examples section.

Author

Kevin Thornton

Examples:

msstats.cc.

Definition at line 48 of file SimParams.hpp.

Member Function Documentation

params()

std::string Sequence::SimParams::params ( void  ) const

inline

Returns

the command-line input to ms

Note

for complicated models, this can be parsed with a stringstream to figure out what the parameters are

Definition at line 58 of file SimParams.hpp.

read()

std::istream & Sequence::SimParams::read

(

std::istream &

s

)

reads in the data from a istream

Definition at line 59 of file SimParams.cc.

runs()

unsigned Sequence::SimParams::runs ( void  ) const

inline

Returns

number of genealogies to generate

Definition at line 74 of file SimParams.hpp.

totsam()

unsigned Sequence::SimParams::totsam ( void  ) const

inline

Returns

the total sample size (# gametes)

Definition at line 67 of file SimParams.hpp.

Friends And Related Function Documentation

operator<<

std::ostream& operator<< ( std::ostream &  stream, class SimParams &  object  )

friend

Writes the parameters passed to Dick Hudson's coalescent simulation program to an output stream.

Definition at line 99 of file SimParams.cc.

---

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

• SimParams.hpp
• SimParams.cc