prng_state_manager.h

Go to the documentation of this file.

/* Author(s)     :     Francois Mauger <mauger@lpccaen.in2p3.fr>
 * Creation date : 2011-03-02
 * Last modified : 2012-06-15
 *
 * 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 byx
 * 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 that record the internal state of some PRNGs
 *
 * History:
 *
 */

#ifndef MYGSL_PRNG_STATE_MANAGER_H
#define MYGSL_PRNG_STATE_MANAGER_H 1

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

// Third party:
// - Boost:
#include <boost/cstdint.hpp>

// This project:
#include <mygsl/rng.h>

namespace mygsl {

  class prng_state_manager
  {
  public:

    class record
    {
    public:

      static const size_t DEFAULT_BUFFER_SIZE = 65536;

      record ();

      virtual ~record ();

    public:

      mygsl::rng::state_buffer_type state_buffer;

    };

    typedef std::map<std::string, record> dict_type;

  public:

    static const int INVALID_COUNTER_VALUE = -1; 

    const std::string & default_filename();

    bool has_filename () const;

    const std::string & get_filename () const;

    void set_filename (const std::string & = "");

    void reset_filename();

    bool has_counter () const;

    int get_counter () const;

    void set_counter (int);

    void reset_counter ();

    void increment_counter (unsigned int a_increment = 1);

    prng_state_manager ();

    prng_state_manager (const std::string &);

    virtual ~prng_state_manager ();

    void invalidate ();

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

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

    void add_state (const std::string & label_, size_t sz_);

    const record & get_state (const std::string & label_) const;

    record & get_state (const std::string & label_);

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

    void clear ();

    void reset ();

    size_t size () const;

    bool empty () const;

    void store (const std::string & filename_ = "") const;

    void load (const std::string & filename_ = "");

    void dump (std::ostream & out_ = std::clog) const;

    bool error() const;

    void reset_error();

  private:

    void _force_error(int e) const;

  private:

    int          _error_code_; 
    std::string  _filename_;   
    int32_t      _counter_;    
    dict_type    _dict_;       

  };

}  // end of namespace mygsl

#endif // MYGSL_PRNG_STATE_MANAGER_H

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