Loading...
Searching...
No Matches
LimitedWarning.hh
#ifndef __FASTJET_LIMITEDWARNING_HH__
#define __FASTJET_LIMITEDWARNING_HH__
//FJSTARTHEADER
// $Id$
//
// Copyright (c) 2005-2021, Matteo Cacciari, Gavin P. Salam and Gregory Soyez
//
//----------------------------------------------------------------------
// This file is part of FastJet.
//
// FastJet 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 2 of the License, or
// (at your option) any later version.
//
// The algorithms that underlie FastJet have required considerable
// development. They are described in the original FastJet paper,
// hep-ph/0512210 and in the manual, arXiv:1111.6097. If you use
// FastJet as part of work towards a scientific publication, please
// quote the version you use and include a citation to the manual and
// optionally also to hep-ph/0512210.
//
// FastJet 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 FastJet. If not, see <http://www.gnu.org/licenses/>.
//----------------------------------------------------------------------
//FJENDHEADER
#include "fastjet/internal/base.hh"
#include <iostream>
#include <string>
#include <list>
#include "fastjet/config.h"
#ifdef FASTJET_HAVE_LIMITED_THREAD_SAFETY
#include <atomic>
#include <mutex>
#endif // FASTJET_HAVE_LIMITED_THREAD_SAFETY
#include "fastjet/internal/thread_safety_helpers.hh" // provides a counter, thread-safe if needed
FASTJET_BEGIN_NAMESPACE
/// @ingroup error_handling
/// \class LimitedWarning
/// class to provide facilities for giving warnings up to some maximum
/// number of times and to provide global summaries of warnings that have
/// been issued.
class LimitedWarning {
public:
/// constructor that provides a default maximum number of warnings
LimitedWarning() : _max_warn(_max_warn_default),_this_warning_summary(0) {}
/// constructor that provides a user-set max number of warnings
LimitedWarning(int max_warn_in) : _max_warn(max_warn_in), _this_warning_summary(0) {}
#ifdef FASTJET_HAVE_LIMITED_THREAD_SAFETY
/// copy ctor (have to be specified explicitly because of the atomic variable)
LimitedWarning(const LimitedWarning &other)
: _max_warn(other._max_warn), _this_warning_summary{other._this_warning_summary.load()} {}
#endif
/// outputs a warning to standard error (or the user's default
/// warning stream if set)
void warn(const char * warning) {warn(warning, _default_ostr);}
/// outputs a warning to standard error (or the user's default
/// warning stream if set)
void warn(const std::string & warning) {warn(warning.c_str(), _default_ostr);}
/// outputs a warning to the specified stream
void warn(const char * warning, std::ostream * ostr);
/// outputs a warning to the specified stream
void warn(const std::string & warning, std::ostream * ostr) {warn(warning.c_str(), ostr);}
/// sets the default output stream for all warnings (by default
/// cerr; passing a null pointer prevents warnings from being output)
static void set_default_stream(std::ostream * ostr) {
_default_ostr = ostr;
}
#ifdef FASTJET_HAVE_LIMITED_THREAD_SAFETY
/// sets the default output stream for all warnings (by default
/// cerr; passing a null pointer prevents warnings from being output)
/// The second argument is a mutex that would be used to guarantee
/// that only a single thread writes to the stream at a time
static void set_default_stream_and_mutex(std::ostream * ostr,
std::mutex * warnings_mutex) {
_default_ostr = ostr;
_stream_mutex = warnings_mutex;
}
#endif // FASTJET_HAVE_LIMITED_THREAD_SAFETY
/// sets the default maximum number of warnings of a given kind
/// before warning messages are silenced.
static void set_default_max_warn(int max_warn) {
_max_warn_default = max_warn;
}
/// the maximum number of warning messages that will be printed
/// by this instance of the class
int max_warn() const {return _max_warn;}
/// the number of times so far that a warning has been registered
/// with this instance of the class.
int n_warn_so_far() const;
/// returns a summary of all the warnings that came through the
/// LimiteWarning class
static std::string summary();
private:
const int _max_warn;
typedef std::pair<std::string, thread_safety_helpers::AtomicCounter<unsigned int> > Summary;
#ifdef FASTJET_HAVE_LIMITED_THREAD_SAFETY
static std::atomic<int> _max_warn_default;
static std::atomic<std::ostream *> _default_ostr;
static std::atomic<std::mutex *> _stream_mutex;
static std::mutex _global_warnings_summary_mutex;
std::atomic<Summary*> _this_warning_summary;
#else
static int _max_warn_default;
static std::ostream * _default_ostr;
Summary* _this_warning_summary;
#endif // FASTJET_HAVE_LIMITED_THREAD_SAFETY
// Note that this is updated internally and we use a mutex for the
// thread-safe version. So no other specific treatment is needed at
// this level.
static std::list< Summary > _global_warnings_summary;
};
FASTJET_END_NAMESPACE
#endif // __FASTJET_LIMITEDWARNING_HH__
fastjet::LimitedWarning
class to provide facilities for giving warnings up to some maximum number of times and to provide glo...
Definition LimitedWarning.hh:54
fastjet::LimitedWarning::warn
void warn(const std::string &warning)
outputs a warning to standard error (or the user's default warning stream if set)
Definition LimitedWarning.hh:75
fastjet::LimitedWarning::set_default_stream
static void set_default_stream(std::ostream *ostr)
sets the default output stream for all warnings (by default cerr; passing a null pointer prevents war...
Definition LimitedWarning.hh:85
fastjet::LimitedWarning::set_default_max_warn
static void set_default_max_warn(int max_warn)
sets the default maximum number of warnings of a given kind before warning messages are silenced.
Definition LimitedWarning.hh:103
fastjet::LimitedWarning::warn
void warn(const char *warning)
outputs a warning to standard error (or the user's default warning stream if set)
Definition LimitedWarning.hh:71
fastjet::LimitedWarning::LimitedWarning
LimitedWarning()
constructor that provides a default maximum number of warnings
Definition LimitedWarning.hh:58
fastjet::LimitedWarning::warn
void warn(const std::string &warning, std::ostream *ostr)
outputs a warning to the specified stream
Definition LimitedWarning.hh:81
fastjet::LimitedWarning::max_warn
int max_warn() const
the maximum number of warning messages that will be printed by this instance of the class
Definition LimitedWarning.hh:109
fastjet::LimitedWarning::LimitedWarning
LimitedWarning(int max_warn_in)
constructor that provides a user-set max number of warnings
Definition LimitedWarning.hh:61