/usr/include/ns3.26/ns3/rng-seed-manager.h is in libns3-dev 3.26+dfsg-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 | /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
* Copyright (c) 2012 Mathieu Lacage
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 2 as
* published by the Free Software Foundation;
*
* 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
*/
#ifndef RNG_SEED_MANAGER_H
#define RNG_SEED_MANAGER_H
#include <stdint.h>
/**
* \file
* \ingroup randomvariable
* ns3::RngSeedManager declaration.
*/
namespace ns3 {
/**
* \ingroup randomvariable
*
* Manage the seed number and run number of the underlying
* random number generator, and automatic assignment of stream numbers.
*/
class RngSeedManager
{
public:
/**
* \brief Set the seed.
*
* This sets the global initial seed which will be used all
* subsequently instantiated RandomVariableStream objects.
*
* \code
* RngSeedManger::SetSeed(15);
* UniformVariable x(2,3); // These will give the same output everytime
* ExponentialVariable y(120); // as long as the seed stays the same.
* \endcode
* \param [in] seed The seed value to use.
*
* \note While the underlying RNG takes six integer values as a seed;
* it is sufficient to set these all to the same integer, so we provide
* a simpler interface here that just takes one integer.
*/
static void SetSeed (uint32_t seed);
/**
* \brief Get the current seed value which will be used by all
* subsequently instantiated RandomVariableStream objects.
*
* \return The seed value.
*
* This returns the current seed value.
*/
static uint32_t GetSeed (void);
/**
* \brief Set the run number of simulation.
*
* \code
* RngSeedManager::SetSeed(12);
* int N = atol(argv[1]); // Read in run number from command line.
* RngSeedManager::SetRun(N);
* UniformVariable x(0,10);
* ExponentialVariable y(2902);
* \endcode
* In this example, \c N could successivly be equal to 1,2,3, _etc._
* and the user would continue to get independent runs out of the
* single simulation. For this simple example, the following might work:
* \code
* ./simulation 0
* ...Results for run 0:...
*
* ./simulation 1
* ...Results for run 1:...
* \endcode
*
* \param [in] run The run number.
*/
static void SetRun (uint64_t run);
/**
* \brief Get the current run number.
* \returns The current run number
* \see SetRun
*/
static uint64_t GetRun (void);
/**
* Get the next automatically assigned stream index.
* \returns The next stream index.
*/
static uint64_t GetNextStreamIndex(void);
};
/** Alias for compatibility. */
typedef RngSeedManager SeedManager;
} // namespace ns3
#endif /* RNG_SEED_MANAGER_H */
|