random_manager.h

Go to the documentation of this file.

/*
 *  random_manager.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 RANDOM_MANAGER_H
#define RANDOM_MANAGER_H
 
// Generated includes:
#include "config.h"
 
// C++ includes:
#include <string>
#include <vector>
 
// Includes from libnestutil:
#include "manager_interface.h"
 
// Includes from nestkernel:
#include "nest_types.h"
#include "random_generators.h"
 
namespace nest
{
 
class RandomManager : public ManagerInterface
{
public:
  RandomManager();
  ~RandomManager() override;
 
  void initialize( const bool ) override;
  void finalize( const bool ) override;
  void set_status( const Dictionary& ) override;
  void get_status( Dictionary& ) override;
 
  RngPtr get_rank_synced_rng() const;
 
  RngPtr get_vp_synced_rng( size_t tid ) const;
 
  RngPtr get_vp_specific_rng( size_t tid ) const;
 
  void check_rng_synchrony() const;
 
  template < typename RNG_TYPE >
  void register_rng_type( const std::string& name );
 
private:
  std::map< std::string, BaseRandomGeneratorFactory* > rng_types_;
 
  std::string current_rng_type_;
 
  std::uint32_t base_seed_;
 
  RngPtr rank_synced_rng_;
 
  std::vector< RngPtr > vp_synced_rngs_;
 
  std::vector< RngPtr > vp_specific_rngs_;
 
  static const std::string DEFAULT_RNG_TYPE_;
 
  static const std::uint32_t DEFAULT_BASE_SEED_;
 
  static const std::uint32_t RANK_SYNCED_SEEDER_;
 
  static const std::uint32_t THREAD_SYNCED_SEEDER_;
 
  static const std::uint32_t THREAD_SPECIFIC_SEEDER_;
};
 
inline RngPtr
RandomManager::get_rank_synced_rng() const
{
  return rank_synced_rng_;
}
 
inline RngPtr
RandomManager::get_vp_synced_rng( size_t tid ) const
{
  assert( tid < static_cast< size_t >( vp_specific_rngs_.size() ) );
  return vp_synced_rngs_[ tid ];
}
 
inline RngPtr
RandomManager::get_vp_specific_rng( size_t tid ) const
{
  assert( tid < static_cast< size_t >( vp_specific_rngs_.size() ) );
  return vp_specific_rngs_[ tid ];
}
 
}  // namespace nest
 
#endif /* RANDOM_MANAGER_H */