seed_manager.h

Go to the documentation of this file.

/* Author(s)     :     Francois Mauger <mauger@lpccaen.in2p3.fr>
 * Creation date : 2011-02-26
 * Last modified : 2012-06-08
 *
 * Copyright (C) 2011 Francois Mauger <mauger@lpccaen.in2p3.fr>
 *
 * 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, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
 * MA 02110-1301, USA.
 *
 * Description:
 *
 *   A manager for PRNG's seeds
 *
 * History:
 *
 */

#ifndef MYGSL_SEED_MANAGER_H
#define MYGSL_SEED_MANAGER_H 1

// Standard library:
#include <iostream>
#include <map>
#include <string>
#include <vector>

// Third party:
// - Boost:
#include <boost/cstdint.hpp>
// - Bayeux/datatools :
#include <datatools/bit_mask.h>

namespace mygsl {
class rng;

class seed_manager {
 public:
  enum init_seed_from_type {
    INIT_SEED_FROM_UNDEFINED     = 0,
    INIT_SEED_FROM_CURRENT_TIME  = datatools::bit_mask::bit00,
    INIT_SEED_FROM_CURRENT_PID   = datatools::bit_mask::bit01,
    INIT_SEED_FROM_URANDOM       = datatools::bit_mask::bit02,
    INIT_SEED_FROM_RANDOM_DEVICE = datatools::bit_mask::bit03,
    INIT_SEED_FROM_USER          = datatools::bit_mask::bit04,
    INIT_SEED_FROM_CURRENT_TIME_AND_PID = INIT_SEED_FROM_CURRENT_TIME | INIT_SEED_FROM_CURRENT_PID ,
    INIT_SEED_FROM_DEFAULT       = INIT_SEED_FROM_RANDOM_DEVICE
  };

  static bool seed_is_valid(int32_t seed);

 public:
  seed_manager ();

  virtual ~seed_manager ();

  void get_labels (std::vector<std::string> & labels_) const;

  bool has_seed (const std::string & label_) const;

  void add_seed (const std::string & label_, int32_t seed_);

  int32_t get_seed (const std::string & label_) const;

  void update_seed (const std::string & label_, int32_t seed_);

  void invalidate_seed (const std::string & label_);

  void clear ();

  void invalidate ();

  void all_time_seeds ();

  void all_auto_seeds ();

  void transform_time_seeds (bool allow_duplication_ = false);

  void ensure_different_seeds ();

  bool all_different_seeds () const;

  bool has_auto_seeds () const;

  bool has_time_seeds () const;

  bool has_invalid_seeds () const;

  size_t size () const;

  bool empty () const;


  void set_init_seed_flags (uint32_t);

  uint32_t get_init_seed_flags () const;

  void dump (std::ostream &) const;

  friend std::ostream & operator<< (std::ostream &, const seed_manager &);

  friend std::istream & operator>> (std::istream &, seed_manager &);

 protected:
  void _ensure_different_seeds (mygsl::rng * random_ = 0);

  int32_t _set_seed_for_seeds ();

  void _set_seed(const std::string & label_, int32_t seed_);

 private:
  void _set_init_seed_flags_();

 private:
  uint32_t  _init_seed_flags_;                    
  typedef std::map<std::string, int32_t> dict_type;
  dict_type _dict_;                               
};

typedef seed_manager prng_seed_manager;

}  // end of namespace mygsl

#endif // MYGSL_SEED_MANAGER_H

// Local Variables:
// mode: c++
// coding: utf-8
// End: