zipf: Small changes (style and small logic correction) and adding documentation section
diff --git a/docs/source/_static/apps/zipf-n100-frq100-duration10.png b/docs/source/_static/apps/zipf-n100-frq100-duration10.png
new file mode 100644
index 0000000..b9918f3
--- /dev/null
+++ b/docs/source/_static/apps/zipf-n100-frq100-duration10.png
Binary files differ
diff --git a/docs/source/_static/apps/zipf-n100-frq100-duration100.png b/docs/source/_static/apps/zipf-n100-frq100-duration100.png
new file mode 100644
index 0000000..c560df5
--- /dev/null
+++ b/docs/source/_static/apps/zipf-n100-frq100-duration100.png
Binary files differ
diff --git a/docs/source/_static/apps/zipf-n100-frq100-duration1000.png b/docs/source/_static/apps/zipf-n100-frq100-duration1000.png
new file mode 100644
index 0000000..25818f9
--- /dev/null
+++ b/docs/source/_static/apps/zipf-n100-frq100-duration1000.png
Binary files differ
diff --git a/docs/source/_static/apps/zipf-n100-frq100-duration50.png b/docs/source/_static/apps/zipf-n100-frq100-duration50.png
new file mode 100644
index 0000000..ecc4291
--- /dev/null
+++ b/docs/source/_static/apps/zipf-n100-frq100-duration50.png
Binary files differ
diff --git a/docs/source/applications.rst b/docs/source/applications.rst
index bef7395..97aa326 100644
--- a/docs/source/applications.rst
+++ b/docs/source/applications.rst
@@ -18,7 +18,7 @@
This applications has the following attributes:
-* Frequency
+* ``Frequency``
.. note::
default: ``1.0`` (1 per second)
@@ -30,7 +30,7 @@
// Set attribute using the app helper
helper.SetAttribute ("Frequency", DoubleValue (1.0));
-* Randomize
+* ``Randomize``
.. note::
default: ``"none"``
@@ -48,6 +48,47 @@
// Set attribute using the app helper
helper.SetAttribute ("Randomize", StringValue ("uniform"));
+ConsumerZipfMandelbrot
+^^^^^^^^^^^^^^^^^^^^^^
+
+.. note::
+ Author: Xiaoke Jiang
+
+An app that requests contents (names in the requests) following Zipf-Mandelbrot distribution (number of Content frequency Distribution).
+This class is a subclass of :ndnsim:`ConsumerCbr`.
+
+.. code-block:: c++
+
+ // Create application using the app helper
+ ndn::AppHelper helper ("ns3::ndn::ConsumerZipfMandelbrot");
+
+``Frequency`` and ``Randomize`` attributes can be used in the same way as in the base :ndnsim:`ConsumerCbr` applications.
+
+Additional attributes:
+
+* ``NumberOfContents``
+
+ .. note::
+ default: 100
+
+ Number of different content (sequence numbers) that will be requested by the applications
+
+
+THE following pictures show basic comparison of the generated stream of Interests versus theoretical `Zipf-Mandelbrot <http://en.wikipedia.org/wiki/Zipf%E2%80%93Mandelbrot_law>`_ function (``NumberOfContents`` set to 100 and ``Frequency`` set to 100)
+
+.. image:: _static/apps/zipf-n100-frq100-duration10.png
+ :alt: Comparsion between simulation and theory with simulation duration 10 seconds
+
+.. image:: _static/apps/zipf-n100-frq100-duration50.png
+ :alt: Comparsion between simulation and theory with simulation duration 50 seconds
+
+.. image:: _static/apps/zipf-n100-frq100-duration100.png
+ :alt: Comparsion between simulation and theory with simulation duration 100 seconds
+
+.. image:: _static/apps/zipf-n100-frq100-duration1000.png
+ :alt: Comparsion between simulation and theory with simulation duration 1000 seconds
+
+
ConsumerBatches
^^^^^^^^^^^^^^^^^^^
@@ -60,7 +101,7 @@
This applications has the following attributes:
-* Batches
+* ``Batches``
.. note::
default: Empty
@@ -87,21 +128,21 @@
This applications has the following attributes:
-* Window
+* ``Window``
.. note::
default: ``1``
Initial number of Interests that will be send out without waiting for the data (number of outstanding Interests)
-* PayloadSize
+* ``PayloadSize``
.. note::
default: ``1040``
Expected size of the Data payload (necessary only when Size is specified)
-* Size
+* ``Size``
.. note::
default: ``-1``
@@ -223,3 +264,4 @@
:linenos:
:lines: 21-
+
