global.hpp

Go to the documentation of this file.

#ifndef FSTGLOBAL_H
#define FSTGLOBAL_H
 /* 
=========================================================================
Copyright and license:
  * FST4 software (with the exception of any bundled or externally linked
    third-party components) is Copyright (C) 2000-present Institute of
    Information Theory and Automation of the Czech Academy of Sciences (UTIA).
  * FST4 is free software: you can redistribute it and/or modify it under
    the terms of the GNU Affero General Public License as published by the
    Free Software Foundation, version 3. The full text of the license is in
    the file LICENSE in the distribution root and at
    https://www.gnu.org/licenses/agpl-3.0.html.
  * FST4 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 Affero General Public
    License for more details.
  * Closed-source use without the AGPL's copyleft obligations requires a
    commercial license from UTIA; in case of interest write to
    utia@utia.cas.cz. LICENSING.md in the distribution root explains both
    options, the contributor license agreement that every contribution
    requires, and the contacts (technical questions and pull requests:
    somol@utia.cas.cz, with "FST" in the subject line).
========================================================================== */
 
#include <string>
#include <ostream>
#include <iostream> // std::cout in the inline notify() bodies (DEBUG builds)
#include <sstream>
#ifdef FST_THREADED
#include <mutex>
#endif

namespace FST {

enum OutputDetail {
  SILENT=0, 
  NORMAL=1, 
  DETAILED=2
};

class syncout
{
public:
        static void print(std::ostream& os, std::ostringstream &sos)
        {
#ifdef FST_THREADED
                std::unique_lock<std::mutex> lockio(get_io_mutex());
#endif
                os << sos.str() << std::flush;
        }
private:
#ifdef FST_THREADED
        static std::mutex& get_io_mutex()
        {
                static std::mutex io_mutex;
                return io_mutex;
        }
#endif
        syncout();
};
 
// notify(): DEBUG-mode-only diagnostic output. The overloads are inline, so the library is
// header-only and needs no compiled translation unit; _src_global/global.cpp is an empty
// compatibility stub for build setups that still list it.
inline void notify(const std::string msg)
{
#ifdef DEBUG
        std::ostringstream ss;
        ss << msg << std::endl;
        syncout::print(std::cout,ss);
#else
        (void)msg;
#endif
}

inline void notify(const std::string msg1, const double num, const std::string msg2="")
{
#ifdef DEBUG
        std::ostringstream ss;
        ss << msg1 << num << msg2 << std::endl;
        syncout::print(std::cout,ss);
#else
        (void)msg1; (void)num; (void)msg2;
#endif
}

inline void notify(const std::string msg1, const double num1, const std::string msg2, const double num2, const std::string msg3="")
{
#ifdef DEBUG
        std::ostringstream ss;
        ss << msg1 << num1 << msg2 << num2 << msg3 << std::endl;
        syncout::print(std::cout,ss);
#else
        (void)msg1; (void)num1; (void)msg2; (void)num2; (void)msg3;
#endif
}

inline void notify(const std::string msg1, const double num1, const std::string msg2, const double num2, const std::string msg3, const double num3, const std::string msg4="")
{
#ifdef DEBUG
        std::ostringstream ss;
        ss << msg1 << num1 << msg2 << num2 << msg3 << num3 << msg4 << std::endl;
        syncout::print(std::cout,ss);
#else
        (void)msg1; (void)num1; (void)msg2; (void)num2; (void)msg3; (void)num3; (void)msg4;
#endif
}

template<typename VALUE>
inline VALUE maxf(const VALUE &x, const VALUE &y)
{
        return (x>y)?x:y;
}

template<typename VALUE>
inline VALUE minf(const VALUE &x, const VALUE &y)
{
        return (x<y)?x:y;
}
 
} //namespace
#endif // FSTGLOBAL_H ///:~