genesis Namespace Reference

Detailed Description

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

Namespaces
	placement
	population
	sequence
	taxonomy
	tree
	utils

Functions
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

ee()

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

inline

Definition at line 139 of file version.hpp.

genesis_header()

std::string genesis::genesis_header ( )

inline

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 94 of file version.hpp.

genesis_license()

std::string genesis::genesis_license ( )

inline

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 114 of file version.hpp.

genesis_url()

std::string genesis::genesis_url ( )

inline

Return the URL of the genesis home page.

Definition at line 83 of file version.hpp.

genesis_version()

std::string genesis::genesis_version ( )

inline

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 63 of file version.hpp.

genesis_version_name()

std::string genesis::genesis_version_name ( )

inline

Return the current genenis version name.

Just for fun.

Definition at line 74 of file version.hpp.