mapgd  0.4
A program for the Maximum-likelihood analysis of population genomic data.
 All Data Structures Functions Variables Friends Groups Pages
Public Member Functions | Data Fields | Static Public Attributes | Private Member Functions | Static Private Member Functions | Private Attributes | Static Private Attributes
Relatedness Class Reference

Relatedness data. More...

#include <relatedness_data.h>

Inheritance diagram for Relatedness:
Inheritance graph
[legend]
Collaboration diagram for Relatedness:
Collaboration graph
[legend]

Public Member Functions

 Relatedness (const std::vector< std::string > &)
 delegating a necessary constructor.
 
 Relatedness (const std::string &, const std::string &)
 construct with names.
 
std::string header (void) const
 The header line of plain text files.
 
size_t size (void) const
 Size in bytes for binary read/write.
 
void set_X_name (const std::string &)
 Sets the name of the X sample.
 
void set_X_name (const id0_t &)
 
void set_Y_name (const std::string &)
 Sets the name of the Y sample.
 
void set_Y_name (const id0_t &)
 
void clear (void)
 zeros statistics and sets names to empty.
 
void zero (void)
 zeros statistics, but doesn't set names to empty. More...
 
const std::string get_file_name (void) const
 
const std::string get_table_name (void) const
 
const bool get_binary () const
 
Relatednessoperator= (const Relatedness &rhs)
 
- Public Member Functions inherited from Data
void read_binary (std::istream &str)
 
void write_binary (std::ostream &str) const
 
 Data (std::vector< std::string > &)
 
virtual const bool indexed () const
 
virtual const std::string sql_header (void) const
 Return the names of the columns, along with variable type.
 
virtual const std::string sql_column_names (void) const
 Return the names of the columns.
 
virtual const std::string sql_values (void) const
 Return the values to be placed in columns.
 
virtual void sql_read (std::istream &)
 Reads the values...
 

Data Fields

char delim
 the delimiter used when reading/writing the class in text mode.
 
std::string X_str_
 the name of the first (X) sample in the compairison.
 
std::string Y_str_
 the name of the second (Y) sample in the compairison.
 
id0_t X_
 
id0_t Y_
 the
 
id1_t sites
 the number of sites analyzed.
 
float_t e_X_ [E_LIM]
 
float_t e_X_ll
 
float_t e_Y_ [E_LIM]
 
float_t e_Y_ll
 
float_t f_X_
 
float_t f_X_ll
 
float_t f_Y_
 
float_t f_Y_ll
 
float_t theta_XY_
 
float_t theta_XY_ll
 
float_t gamma_XY_
 
float_t gamma_XY_ll
 
float_t gamma_YX_
 
float_t gamma_YX_ll
 
float_t delta_XY_
 
float_t delta_XY_ll
 
float_t Delta_XY_
 
float_t Delta_XY_ll
 
float_t null_ll_
 
float_t max_ll_
 

Static Public Attributes

static const std::string file_name =".rel"
 The dafualt extention for files.
 
static const std::string table_name ="RELATEDNESS"
 Destination table in Db.
 
static const bool binary =false
 
- Static Public Attributes inherited from Data
static const std::string file_name =".txt"
 The read function must be defined in the child class. More...
 
static const std::string table_name ="NONE"
 The read function must be defined in the child class. More...
 

Private Member Functions

void write (std::ostream &) const
 use to write Allele. Inherits <<
 
void read (std::istream &)
 use to read Allele. Inherits >>
 

Static Private Member Functions

static Datacreate (const std::vector< std::string > &Columns)
 

Private Attributes

bool likelihoods_
 indicate whether likelihoods are recorded.
 

Static Private Attributes

static const Registration registered =Registration(Relatedness::table_name, Relatedness::create)
 

Additional Inherited Members

- Static Public Member Functions inherited from Data
static Datanew_from_str (const std::string &, const std::vector< std::string > &)
 Constructs an instance of the class Registered w/ string.
 

Detailed Description

Relatedness data.

Member Function Documentation

void Relatedness::zero ( void  )

zeros statistics, but doesn't set names to empty.

< the number of sites analyzed.


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