options.hpp

Go to the documentation of this file.

#ifndef GENESIS_UTILS_CORE_OPTIONS_H_
#define GENESIS_UTILS_CORE_OPTIONS_H_
 
/*
    Genesis - A toolkit for working with phylogenetic data.
    Copyright (C) 2014-2019 Lucas Czech and HITS gGmbH
 
    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.
 
    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.
 
    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
    Contact:
    Lucas Czech <lucas.czech@h-its.org>
    Exelixis Lab, Heidelberg Institute for Theoretical Studies
    Schloss-Wolfsbrunnenweg 35, D-69118 Heidelberg, Germany
*/
 
#include <random>
#include <string>
#include <utility>
#include <vector>
 
namespace genesis {
namespace utils {
 
// =================================================================================================
//     Options
// =================================================================================================
 
class Options
{
public:
 
    // -------------------------------------------------------------------------
    //     Instance
    // -------------------------------------------------------------------------
 
    inline static Options& get() {
            // Meyers-Singleton
            static Options instance;
            return instance;
    }
 
    // -------------------------------------------------------------------------
    //     Command Line
    // -------------------------------------------------------------------------
 
    inline std::vector<std::string> command_line() const
    {
        return command_line_;
    }
 
    std::string command_line_string() const;
 
    void command_line( int const argc, char const* const* argv );
 
    // -------------------------------------------------------------------------
    //     Number of Threads
    // -------------------------------------------------------------------------
 
    inline unsigned int number_of_threads() const
    {
        return number_of_threads_;
    }
 
    void number_of_threads( unsigned int number );
 
    unsigned int guess_number_of_threads( bool use_openmp = true ) const;
 
    bool hyperthreads_enabled() const;
 
    // -------------------------------------------------------------------------
    //     Random Seed & Engine
    // -------------------------------------------------------------------------
 
    inline unsigned long random_seed() const
    {
        return random_seed_;
    }
 
    void random_seed (const unsigned long seed);
 
    inline std::default_random_engine& random_engine()
    {
        return random_engine_;
    }
 
    // -------------------------------------------------------------------------
    //     Misc Options
    // -------------------------------------------------------------------------
 
    inline bool allow_file_overwriting() const
    {
        return allow_file_overwriting_;
    }
 
    inline void allow_file_overwriting( bool value )
    {
        allow_file_overwriting_ = value;
    }
 
    // -------------------------------------------------------------------------
    //     Object Info
    // -------------------------------------------------------------------------
 
    inline void print_object_infos( bool value )
    {
        print_obj_infos_ = value;
    }
 
    inline bool print_object_infos() const
    {
        return print_obj_infos_;
    }
 
    inline void print_object_gists( long value )
    {
        print_obj_gists_ = value;
    }
 
    inline long print_object_gists() const
    {
        return print_obj_gists_;
    }
 
    // -------------------------------------------------------------------------
    //     Run Time Environment
    // -------------------------------------------------------------------------
 
    static bool stdin_is_terminal();
 
    static bool stdout_is_terminal();
 
    static bool stderr_is_terminal();
 
    static std::pair<int, int> terminal_size();
 
    // -------------------------------------------------------------------------
    //     Compile Time Environment
    // -------------------------------------------------------------------------
 
    static bool is_debug();
 
    static bool is_release();
 
    static std::string build_type();
 
    static bool is_little_endian();
 
    static bool is_big_endian();
 
    static std::string platform();
 
    static std::string compiler_family();
 
    static std::string compiler_version();
 
    static std::string cpp_version();
 
    static std::string compile_date_time();
 
    static bool using_pthreads();
 
    static bool using_openmp();
 
    static bool using_zlib();
 
    // -------------------------------------------------------------------------
    //     Overview
    // -------------------------------------------------------------------------
 
    std::string info() const;
 
    std::string info_compile_time() const;
 
    std::string info_run_time() const;
 
    // -------------------------------------------------------------------------
    //     Data Members
    // -------------------------------------------------------------------------
 
private:
 
    std::vector<std::string>   command_line_;
    unsigned int               number_of_threads_;
 
    unsigned long              random_seed_;
    std::default_random_engine random_engine_;
 
    bool                       allow_file_overwriting_ = false;
 
    bool                       print_obj_infos_ = true;
    long                       print_obj_gists_ = 0;
 
    // -------------------------------------------------------------------------
    //     Hidden Class Members
    // -------------------------------------------------------------------------
 
private:
 
    // Everything private, as it is a singleton.
 
    Options();
 
    ~Options() = default;
 
    Options( const Options& ) = delete;
    Options( Options&& )      = delete;
    Options& operator= ( const Options& ) = delete;
    Options& operator= ( Options&& )      = delete;
 
};
 
} // namespace utils
} // namespace genesis
 
#endif // include guard