A toolkit for working with phylogenetic data.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
genesis Namespace Reference

Detailed Description

Container namespace for all symbols of genesis in order to keep them separate when used as a library.




std::string ee (int r)
std::string genesis_header ()
 Return the header for genesis. More...
std::string genesis_license ()
 Return the genesis license boilerplate information. More...
std::string genesis_url ()
 Return the URL of the genesis home page. More...
std::string genesis_version ()
 Return the current genesis version. More...
std::string genesis_version_name ()
 Return the current genenis version name. More...

Function Documentation

std::string genesis::ee ( int  r)

Definition at line 138 of file version.hpp.

std::string genesis::genesis_header ( )

Return the header for genesis.

This is simply a text version of the logo, including the current version. It can for example be displayed at the start of a program to indicate that this program uses genesis.

Definition at line 93 of file version.hpp.

std::string genesis::genesis_license ( )

Return the genesis license boilerplate information.

This function is useful for programs with terminal interaction. In such cases, you should include a command to show this license information.

Definition at line 113 of file version.hpp.

std::string genesis::genesis_url ( )

Return the URL of the genesis home page.

Definition at line 82 of file version.hpp.

std::string genesis::genesis_version ( )

Return the current genesis version.

We use semantic versioning 2.0.0 for genesis.

Given a version number MAJOR.MINOR.PATCH, increment the:

  • MAJOR version when you make incompatible API changes,
  • MINOR version when you add functionality in a backwards-compatible manner, and
  • PATCH version when you make backwards-compatible bug fixes.

Additional labels for pre-release and build metadata are available as extensions to the MAJOR.MINOR.PATCH format.

Definition at line 62 of file version.hpp.

std::string genesis::genesis_version_name ( )

Return the current genenis version name.

Just for fun.

Definition at line 73 of file version.hpp.