Cmaple

Functions
std::string	cmaple::getVersion ()
	Get the version of CMAPLE.
std::string	cmaple::getCitations ()
	Get a citation string of [C]Maple manuscript(s)
bool	cmaple::isEffective (const Alignment &aln, const double max_subs_per_site=MAX_SUBS_PER_SITE, const double mean_subs_per_site=MEAN_SUBS_PER_SITE)
	Check if the [C]Maple algorithm is effective to analyse an input alignment.
std::ostream &	cmaple::operator<< (std::ostream &out_stream, cmaple::Tree &tree)
	Customized << operator to output the tree string in a (bifurcating) NEWICK format to a stream.
std::istream &	cmaple::operator>> (std::istream &in_stream, cmaple::Tree &tree)
	Customized >> operator to read a tree from a stream.
auto	cmaple::operator<< (std::ostream &out_stream, cmaple::Alignment &aln) -> std::ostream &
	Customized << operator to output the alignment (in MAPLE format) to a stream.
auto	cmaple::operator>> (std::istream &in_stream, cmaple::Alignment &aln) -> std::istream &
	Customized >> operator to read an alignment from a stream.

Detailed Description

Function Documentation

getVersion()

std::string cmaple::getVersion

(

)

Get the version of CMAPLE.

Returns

CMAPLE version in a string

getCitations()

std::string cmaple::getCitations

(

)

Get a citation string of [C]Maple manuscript(s)

Returns

A citation string

isEffective()

bool cmaple::isEffective	(	const Alignment &	aln,
		const double	max_subs_per_site = MAX_SUBS_PER_SITE,
		const double	mean_subs_per_site = MEAN_SUBS_PER_SITE
	)

Check if the [C]Maple algorithm is effective to analyse an input alignment.

Parameters

[in]	aln	an alignment
[in]	max_subs_per_site	the maximum number of substitution per sites that CMAPLE is effective (optional)
[in]	mean_subs_per_site	the mean number of substitution per sites that CMAPLE is effective (optional)

Returns

TRUE if the [C]Maple algorithm is effective to analyse the alignment; otherwise, classical methods (e.g., IQ-TREE, RAXML) are recommended.

Exceptions

std::invalid_argument

if the input alignment is empty or invalid