src/core/examples/sample-random-variable.cc
author Josh Pelkey <jpelkey@gatech.edu>
Fri, 13 May 2011 14:52:27 -0400
changeset 7169 358f71a624d8
parent 7025 32212c736ab4
child 9063 32755d0516f4
permissions -rw-r--r--
core coding style changes
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
5876
29b330c3a070 Add simple random variable sample
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
     1
/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
29b330c3a070 Add simple random variable sample
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
     2
/*
29b330c3a070 Add simple random variable sample
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
     3
 * This program is free software; you can redistribute it and/or modify
29b330c3a070 Add simple random variable sample
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
     4
 * it under the terms of the GNU General Public License version 2 as
29b330c3a070 Add simple random variable sample
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
     5
 * published by the Free Software Foundation;
29b330c3a070 Add simple random variable sample
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
     6
 *
29b330c3a070 Add simple random variable sample
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
     7
 * This program is distributed in the hope that it will be useful,
29b330c3a070 Add simple random variable sample
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
     8
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
29b330c3a070 Add simple random variable sample
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
     9
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
29b330c3a070 Add simple random variable sample
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    10
 * GNU General Public License for more details.
29b330c3a070 Add simple random variable sample
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    11
 *
29b330c3a070 Add simple random variable sample
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    12
 * You should have received a copy of the GNU General Public License
29b330c3a070 Add simple random variable sample
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    13
 * along with this program; if not, write to the Free Software
29b330c3a070 Add simple random variable sample
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    14
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
29b330c3a070 Add simple random variable sample
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    15
 */
29b330c3a070 Add simple random variable sample
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    16
#include "ns3/simulator.h"
29b330c3a070 Add simple random variable sample
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    17
#include "ns3/nstime.h"
29b330c3a070 Add simple random variable sample
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    18
#include "ns3/command-line.h"
29b330c3a070 Add simple random variable sample
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    19
#include "ns3/random-variable.h"
29b330c3a070 Add simple random variable sample
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    20
#include <iostream>
29b330c3a070 Add simple random variable sample
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    21
29b330c3a070 Add simple random variable sample
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    22
using namespace ns3;
29b330c3a070 Add simple random variable sample
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    23
using namespace std;
29b330c3a070 Add simple random variable sample
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    24
29b330c3a070 Add simple random variable sample
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    25
/*
29b330c3a070 Add simple random variable sample
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    26
 * This program can be run from waf such as "./waf --run sample-random-variable"
29b330c3a070 Add simple random variable sample
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    27
 * 
29b330c3a070 Add simple random variable sample
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    28
 * This program is about as simple as possible to display the use of ns-3 
29b330c3a070 Add simple random variable sample
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    29
 * to generate random numbers.  By default, the uniform random variate that
29b330c3a070 Add simple random variable sample
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    30
 * will be outputted is 0.816532.  Because ns-3 uses a fixed seed for the
29b330c3a070 Add simple random variable sample
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    31
 * pseudo-random number generator, this program should always output the
29b330c3a070 Add simple random variable sample
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    32
 * same number.  Likewise, ns-3 simulations using random variables will
29b330c3a070 Add simple random variable sample
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    33
 * behave deterministically unless the user changes the RunNumber or the
7169
358f71a624d8 core coding style changes
Josh Pelkey <jpelkey@gatech.edu>
parents: 7025
diff changeset
    34
 * Seed.
5876
29b330c3a070 Add simple random variable sample
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    35
 * 
29b330c3a070 Add simple random variable sample
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    36
 * There are three primary mechanisms to change the seed or run numbers
29b330c3a070 Add simple random variable sample
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    37
 * from their default integer value of 1
29b330c3a070 Add simple random variable sample
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    38
 * 1) Through explicit call of SeedManager::SetSeed () and 
29b330c3a070 Add simple random variable sample
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    39
 *    SeedManager::SetRun () (commented out below) 
29b330c3a070 Add simple random variable sample
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    40
 * 2) Through the passing of command line arguments such as:
29b330c3a070 Add simple random variable sample
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    41
 *    "./waf --command-template="%s --RngRun=<value>" --run program-name"
29b330c3a070 Add simple random variable sample
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    42
 * 3) Through the use of the NS_GLOBAL_VALUE environment variable, such as:
29b330c3a070 Add simple random variable sample
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    43
 *    "NS_GLOBAL_VALUE="RngRun=<value>" ./waf --run program-name"
29b330c3a070 Add simple random variable sample
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    44
 * 
29b330c3a070 Add simple random variable sample
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    45
 * For instance, setting the run number to 3 will change the program output to
29b330c3a070 Add simple random variable sample
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    46
 * 0.775417
29b330c3a070 Add simple random variable sample
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    47
 * 
29b330c3a070 Add simple random variable sample
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    48
 * Consult the ns-3 manual for more information about the use of the 
29b330c3a070 Add simple random variable sample
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    49
 * random number generator
29b330c3a070 Add simple random variable sample
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    50
 */
29b330c3a070 Add simple random variable sample
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    51
29b330c3a070 Add simple random variable sample
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    52
int main (int argc, char *argv[])
29b330c3a070 Add simple random variable sample
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    53
{
29b330c3a070 Add simple random variable sample
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    54
  CommandLine cmd;
29b330c3a070 Add simple random variable sample
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    55
  cmd.Parse (argc, argv);
29b330c3a070 Add simple random variable sample
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    56
29b330c3a070 Add simple random variable sample
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    57
  // SeedManager::SetRun (3);
29b330c3a070 Add simple random variable sample
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    58
29b330c3a070 Add simple random variable sample
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    59
  UniformVariable uv;
29b330c3a070 Add simple random variable sample
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    60
29b330c3a070 Add simple random variable sample
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    61
  cout << uv.GetValue () << endl;
7169
358f71a624d8 core coding style changes
Josh Pelkey <jpelkey@gatech.edu>
parents: 7025
diff changeset
    62
5876
29b330c3a070 Add simple random variable sample
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    63
}