per_thread_bool_indicator.h

Go to the documentation of this file.

/*
 *  per_thread_bool_indicator.h
 *
 *  This file is part of NEST.
 *
 *  Copyright (C) 2004 The NEST Initiative
 *
 *  NEST 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.
 *
 *  NEST 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 NEST.  If not, see <http://www.gnu.org/licenses/>.
 *
 */
 
#ifndef PER_THREAD_BOOL_INDICATOR_H
#define PER_THREAD_BOOL_INDICATOR_H
 
// C++ includes:
#include <atomic>
#include <cassert>
#include <cstddef>
#include <cstdint>
 
// Includes from nestkernel:
#include "nest_types.h"
#include "vp_manager.h"
 
 
namespace nest
{
 
class BoolIndicatorUInt64
{
public:
  BoolIndicatorUInt64();
  BoolIndicatorUInt64( const bool status );
 
  bool is_true() const;
  bool is_false() const;
 
 
protected:
  void set_true();
  void set_false();
  void logical_and( const bool status );
 
private:
  static constexpr std::uint_fast64_t true_uint64 = true;
  static constexpr std::uint_fast64_t false_uint64 = false;
  std::uint_fast64_t status_;
  friend class PerThreadBoolIndicator;
};
 
inline bool
BoolIndicatorUInt64::is_true() const
{
  return ( status_ == true_uint64 );
}
 
inline bool
BoolIndicatorUInt64::is_false() const
{
  return ( status_ == false_uint64 );
}
 
inline void
BoolIndicatorUInt64::set_true()
{
  status_ = true_uint64;
}
 
inline void
BoolIndicatorUInt64::set_false()
{
  status_ = false_uint64;
}
 
inline void
BoolIndicatorUInt64::logical_and( const bool status )
{
  status_ = ( static_cast< bool >( status_ ) and status );
}
 
class PerThreadBoolIndicator
{
public:
  PerThreadBoolIndicator() {};
 
  BoolIndicatorUInt64& operator[]( const size_t tid );
 
  void
  set_true( const size_t tid )
  {
    if ( per_thread_status_[ tid ].is_false() )
    {
      are_true_++;
      per_thread_status_[ tid ].set_true();
    }
  }
 
  void
  set_false( const size_t tid )
  {
    if ( per_thread_status_[ tid ].is_true() )
    {
      are_true_--;
      per_thread_status_[ tid ].set_false();
    }
  }
 
  void
  logical_and( const size_t tid, const bool status )
  {
    if ( per_thread_status_[ tid ].is_true() and not status )
    {
      are_true_--;
      per_thread_status_[ tid ].set_false();
    }
  }
 
  void initialize( const size_t num_threads, const bool status );
 
  bool all_false() const;
 
  bool all_true() const;
 
  bool any_false() const;
 
  bool any_true() const;
 
private:
  std::vector< BoolIndicatorUInt64 > per_thread_status_;
  int size_ { 0 };
 
  std::atomic< int > are_true_ { 0 };
};
 
}  // namespace nest
 
#endif /* PER_THREAD_BOOL_INDICATOR_H */