jade::basic_genotype_matrix_factory< TValue > Class Template Reference

A template for a class that creates genotype matrices based on files and their file extensions. More...

#include <jade.genotype_matrix_factory.hpp>

Collaboration diagram for jade::basic_genotype_matrix_factory< TValue >:

Public Types
typedef TValue	value_type
	The value type. More...
typedef basic_genotype_matrix< value_type >	genotype_matrix_type
	The genotype matrix type. More...
typedef basic_discrete_genotype_matrix< value_type >	discrete_genotype_matrix_type
	The discrete genotype matrix type. More...
typedef basic_likelihood_genotype_matrix< value_type >	likelihood_genotype_matrix_type
	The likelihood genotype matrix type. More...

Static Public Member Functions
static genotype_matrix_type *	create (const std::string &path)
	Creates a genotype matrix based on values from a file. This function determines what kind of genotype matrix to create based on the file extension of the specified path. More...
static genotype_matrix_type *	create (char const *const path)
	Creates a genotype matrix based on values from a file. This function determines what kind of genotype matrix to create based on the file extension of the specified path. More...

Detailed Description

template<typename TValue>
class jade::basic_genotype_matrix_factory< TValue >

A template for a class that creates genotype matrices based on files and their file extensions.

Definition at line 20 of file jade.genotype_matrix_factory.hpp.

Member Typedef Documentation

discrete_genotype_matrix_type

template<typename TValue >

typedef basic_discrete_genotype_matrix<value_type> jade::basic_genotype_matrix_factory< TValue >::discrete_genotype_matrix_type

The discrete genotype matrix type.

Definition at line 32 of file jade.genotype_matrix_factory.hpp.

genotype_matrix_type

template<typename TValue >

typedef basic_genotype_matrix<value_type> jade::basic_genotype_matrix_factory< TValue >::genotype_matrix_type

The genotype matrix type.

Definition at line 28 of file jade.genotype_matrix_factory.hpp.

likelihood_genotype_matrix_type

template<typename TValue >

typedef basic_likelihood_genotype_matrix<value_type> jade::basic_genotype_matrix_factory< TValue >::likelihood_genotype_matrix_type

The likelihood genotype matrix type.

Definition at line 36 of file jade.genotype_matrix_factory.hpp.

value_type

template<typename TValue >

typedef TValue jade::basic_genotype_matrix_factory< TValue >::value_type

The value type.

Definition at line 24 of file jade.genotype_matrix_factory.hpp.

Member Function Documentation

create() [1/2]

template<typename TValue >

static genotype_matrix_type* jade::basic_genotype_matrix_factory< TValue >::create ( char const *const  path )

inlinestatic

Creates a genotype matrix based on values from a file. This function determines what kind of genotype matrix to create based on the file extension of the specified path.

Returns

A pointer to a new genotype matrix.

Exceptions

An	exception if the path has no file extension or if the file cannot be parsed successfully.

Parameters

path	The path to the file.

Definition at line 77 of file jade.genotype_matrix_factory.hpp.

        {
            assert(path != nullptr);
            return create(std::string(path));
        }

Here is the call graph for this function:

create() [2/2]

template<typename TValue >

static genotype_matrix_type* jade::basic_genotype_matrix_factory< TValue >::create ( const std::string &  path )

inlinestatic

Creates a genotype matrix based on values from a file. This function determines what kind of genotype matrix to create based on the file extension of the specified path.

Returns

A pointer to a new genotype matrix.

Exceptions

An	exception if the path has no file extension or if the file cannot be parsed successfully.

Parameters

path	The path to the file.

Definition at line 48 of file jade.genotype_matrix_factory.hpp.

        {
            const auto period = path.find_last_of('.');
            if (period == std::string::npos)
                throw error() << "missing file extension for G matrix '"
                              << path << "'.";
 
            const auto extension = path.substr(period);
            if (extension == ".dgm")
                return new discrete_genotype_matrix_type(path);
 
            if (extension == ".lgm")
                return new likelihood_genotype_matrix_type(path);
 
            throw error() << "unsupported file extension for G matrix '"
                          << path << "'.";
        }

Here is the caller graph for this function:

---

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

• jade.genotype_matrix_factory.hpp