changeset 11079:5477bf4e3774 octave-forge

small documentation fixes
author mmarzolla
date Sun, 14 Oct 2012 14:05:48 +0000
parents 12d887c105ea
children 756ff6f2c0c9
files main/queueing/inst/ctmc.m main/queueing/inst/ctmc_bd.m main/queueing/inst/ctmc_exps.m main/queueing/inst/ctmc_fpt.m main/queueing/inst/ctmc_mtta.m main/queueing/inst/ctmc_taexps.m main/queueing/inst/dtmc.m main/queueing/inst/dtmc_bd.m main/queueing/inst/dtmc_exps.m main/queueing/inst/dtmc_fpt.m main/queueing/inst/dtmc_is_irreducible.m main/queueing/inst/dtmc_mtta.m main/queueing/inst/dtmc_taexps.m main/queueing/inst/qnammm.m main/queueing/inst/qnclosed.m main/queueing/inst/qnclosedsingleab.m main/queueing/inst/qnclosedsinglebsb.m main/queueing/inst/qnclosedsinglemvaapprox.m main/queueing/inst/qnconvolution.m
diffstat 19 files changed, 51 insertions(+), 26 deletions(-) [+]
line wrap: on
line diff
--- a/main/queueing/inst/ctmc.m	Sun Oct 14 13:39:34 2012 +0000
+++ b/main/queueing/inst/ctmc.m	Sun Oct 14 14:05:48 2012 +0000
@@ -21,9 +21,10 @@
 ## @deftypefnx {Function File} {@var{p} =} ctmc (@var{Q}, @var{t}. @var{p0})
 ##
 ## @cindex Markov chain, continuous time
-## @cindex Continuous time Markov chain
+## @cindex continuous time Markov chain
 ## @cindex Markov chain, state occupancy probabilities
-## @cindex Stationary probabilities
+## @cindex stationary probabilities
+## @cindex CTMC
 ##
 ## Compute stationary or transient state occupancy probabilities
 ## for a continuous-time Markov chain.
--- a/main/queueing/inst/ctmc_bd.m	Sun Oct 14 13:39:34 2012 +0000
+++ b/main/queueing/inst/ctmc_bd.m	Sun Oct 14 14:05:48 2012 +0000
@@ -20,7 +20,9 @@
 ## @deftypefn {Function File} {@var{Q} =} ctmc_bd (@var{b}, @var{d})
 ##
 ## @cindex Markov chain, continuous time
-## @cindex Birth-death process
+## @cindex continuous time Markov chain
+## @cindex CTMC
+## @cindex birth-death process, CTMC
 ##
 ## Returns the infinitesimal generator matrix @math{Q} for a continuous
 ## birth-death process over state space @math{1, 2, @dots{}, N}.
--- a/main/queueing/inst/ctmc_exps.m	Sun Oct 14 13:39:34 2012 +0000
+++ b/main/queueing/inst/ctmc_exps.m	Sun Oct 14 14:05:48 2012 +0000
@@ -21,7 +21,7 @@
 ## @deftypefnx {Function File} {@var{L} =} ctmc_exps (@var{Q}, @var{p})
 ##
 ## @cindex Markov chain, continuous time
-## @cindex Expected sojourn time
+## @cindex expected sojourn time, CTMC
 ##
 ## With three arguments, compute the expected times @code{@var{L}(i)}
 ## spent in each state @math{i} during the time interval @math{[0,t]},
--- a/main/queueing/inst/ctmc_fpt.m	Sun Oct 14 13:39:34 2012 +0000
+++ b/main/queueing/inst/ctmc_fpt.m	Sun Oct 14 14:05:48 2012 +0000
@@ -20,7 +20,10 @@
 ## @deftypefn {Function File} {@var{M} =} ctmc_fpt (@var{Q})
 ## @deftypefnx {Function File} {@var{m} =} ctmc_fpt (@var{Q}, @var{i}, @var{j})
 ##
-## @cindex First passage times
+## @cindex first passage times, CTMC
+## @cindex CTMC
+## @cindex continuous time Markov chain
+## @cindex Markov chain, continuous time
 ##
 ## Compute mean first passage times for an irreducible continuous-time
 ## Markov chain.
--- a/main/queueing/inst/ctmc_mtta.m	Sun Oct 14 13:39:34 2012 +0000
+++ b/main/queueing/inst/ctmc_mtta.m	Sun Oct 14 14:05:48 2012 +0000
@@ -20,7 +20,9 @@
 ## @deftypefn {Function File} {@var{t} =} ctmc_mtta (@var{Q}, @var{p})
 ##
 ## @cindex Markov chain, continuous time
-## @cindex Mean time to absorption
+## @cindex continuous time Markov chain
+## @cindex CTMC
+## @cindex mean time to absorption, CTMC
 ##
 ## Compute the Mean-Time to Absorption (MTTA) of the CTMC described by
 ## the infinitesimal generator matrix @var{Q}, starting from initial
--- a/main/queueing/inst/ctmc_taexps.m	Sun Oct 14 13:39:34 2012 +0000
+++ b/main/queueing/inst/ctmc_taexps.m	Sun Oct 14 14:05:48 2012 +0000
@@ -21,7 +21,9 @@
 ## @deftypefnx {Function File} {@var{M} =} ctmc_taexps (@var{Q}, @var{p})
 ##
 ## @cindex Markov chain, continuous time
-## @cindex Time-alveraged sojourn time
+## @cindex time-alveraged sojourn time, CTMC
+## @cindex continuous time Markov chain
+## @cindex CTMC
 ##
 ## Compute the @emph{time-averaged sojourn time} @code{@var{M}(i)},
 ## defined as the fraction of the time interval @math{[0,t]} (or until
--- a/main/queueing/inst/dtmc.m	Sun Oct 14 13:39:34 2012 +0000
+++ b/main/queueing/inst/dtmc.m	Sun Oct 14 14:05:48 2012 +0000
@@ -21,11 +21,10 @@
 ## @deftypefnx {Function File} {@var{p} =} dtmc (@var{P}, @var{n}, @var{p0})
 ##
 ## @cindex Markov chain, discrete time
-## @cindex Discrete time Markov chain
+## @cindex discrete time Markov chain
+## @cindex DTMC
 ## @cindex Markov chain, stationary probabilities
-## @cindex Stationary probabilities
 ## @cindex Markov chain, transient probabilities
-## @cindex Transient probabilities
 ##
 ## With a single argument, compute the steady-state occupancy
 ## probability vector @code{@var{p}(1), @dots{}, @var{p}(N)} for a
--- a/main/queueing/inst/dtmc_bd.m	Sun Oct 14 13:39:34 2012 +0000
+++ b/main/queueing/inst/dtmc_bd.m	Sun Oct 14 14:05:48 2012 +0000
@@ -20,7 +20,9 @@
 ## @deftypefn {Function File} {@var{P} =} dtmc_bd (@var{b}, @var{d})
 ##
 ## @cindex Markov chain, discrete time
-## @cindex Birth-death process
+## @cindex DTMC
+## @cindex discrete time Markov chain
+## @cindex birth-death process, DTMC
 ##
 ## Returns the transition probability matrix @math{P} for a discrete
 ## birth-death process over state space @math{1, 2, @dots{}, N}.
--- a/main/queueing/inst/dtmc_exps.m	Sun Oct 14 13:39:34 2012 +0000
+++ b/main/queueing/inst/dtmc_exps.m	Sun Oct 14 14:05:48 2012 +0000
@@ -20,7 +20,10 @@
 ## @deftypefn {Function File} {@var{L} =} dtmc_exps (@var{P}, @var{n}, @var{p0})
 ## @deftypefnx {Function File} {@var{L} =} dtmc_exps (@var{P}, @var{p0})
 ##
-## @cindex Expected sojourn times
+## @cindex expected sojourn times, DTMC
+## @cindex DTMC
+## @cindex discrete time Markov chain
+## @cindex Markov chain, discrete time
 ##
 ## Compute the expected number of visits to each state during the first
 ## @var{n} transitions, or until abrosption.
--- a/main/queueing/inst/dtmc_fpt.m	Sun Oct 14 13:39:34 2012 +0000
+++ b/main/queueing/inst/dtmc_fpt.m	Sun Oct 14 14:05:48 2012 +0000
@@ -19,8 +19,11 @@
 ##
 ## @deftypefn {Function File} {@var{M} =} dtmc_fpt (@var{P})
 ##
-## @cindex First passage times
-## @cindex Mean recurrence times
+## @cindex first passage times
+## @cindex mean recurrence times
+## @cindex discrete time Markov chain
+## @cindex Markov chain, discrete time
+## @cindex DTMC
 ##
 ## Compute mean first passage times and mean recurrence times
 ## for an irreducible discrete-time Markov chain.
--- a/main/queueing/inst/dtmc_is_irreducible.m	Sun Oct 14 13:39:34 2012 +0000
+++ b/main/queueing/inst/dtmc_is_irreducible.m	Sun Oct 14 14:05:48 2012 +0000
@@ -20,8 +20,9 @@
 ## @deftypefn {Function File} {[@var{r} @var{s}] =} dtmc_is_irreducible (@var{P})
 ##
 ## @cindex Markov chain, discrete time
-## @cindex Discrete time Markov chain
-## @cindex Irreducible Markov chain
+## @cindex discrete time Markov chain
+## @cindex DTMC
+## @cindex irreducible Markov chain
 ##
 ## Check if @var{P} is irreducible, and identify Strongly Connected
 ## Components (SCC) in the transition graph of the DTMC with transition
--- a/main/queueing/inst/dtmc_mtta.m	Sun Oct 14 13:39:34 2012 +0000
+++ b/main/queueing/inst/dtmc_mtta.m	Sun Oct 14 14:05:48 2012 +0000
@@ -20,9 +20,12 @@
 ## @deftypefn {Function File} {[@var{t} @var{N} @var{B}] =} dtmc_mtta (@var{P})
 ## @deftypefnx {Function File} {[@var{t} @var{N} @var{B}] =} dtmc_mtta (@var{P}, @var{p0})
 ##
-## @cindex Mean time to absorption
-## @cindex Absorption probabilities
-## @cindex Fundamental matrix
+## @cindex mean time to absorption, DTMC
+## @cindex absorption probabilities, DTMC
+## @cindex fundamental matrix
+## @cindex DTMC
+## @cindex discrete time Markov chain
+## @cindex Markov chain, discrete time
 ##
 ## Compute the expected number of steps before absorption for a
 ## DTMC with @math{N \times N} transition probability matrix @var{P};
--- a/main/queueing/inst/dtmc_taexps.m	Sun Oct 14 13:39:34 2012 +0000
+++ b/main/queueing/inst/dtmc_taexps.m	Sun Oct 14 14:05:48 2012 +0000
@@ -20,7 +20,10 @@
 ## @deftypefn {Function File} {@var{L} =} dtmc_exps (@var{P}, @var{n}, @var{p0})
 ## @deftypefnx {Function File} {@var{L} =} dtmc_exps (@var{P}, @var{p0})
 ##
-## @cindex Time-alveraged sojourn time
+## @cindex time-alveraged sojourn time, DTMC
+## @cindex discrete time Markov chain
+## @cindex Markov chain, discrete time
+## @cindex DTMC
 ##
 ## Compute the @emph{time-averaged sojourn time} @code{@var{M}(i)},
 ## defined as the fraction of time steps @math{@{0, 1, @dots{}, n@}} (or
--- a/main/queueing/inst/qnammm.m	Sun Oct 14 13:39:34 2012 +0000
+++ b/main/queueing/inst/qnammm.m	Sun Oct 14 14:05:48 2012 +0000
@@ -19,7 +19,7 @@
 ##
 ## @deftypefn {Function File} {[@var{U}, @var{R}, @var{Q}, @var{X}] =} qnammm (@var{lambda}, @var{mu})
 ##
-## @cindex Asymmetric @math{M/M/m} system
+## @cindex asymmetric @math{M/M/m} system
 ##
 ## Compute @emph{approximate} utilization, response time, average number
 ## of requests in service and throughput for an asymmetric  @math{M/M/m}
--- a/main/queueing/inst/qnclosed.m	Sun Oct 14 13:39:34 2012 +0000
+++ b/main/queueing/inst/qnclosed.m	Sun Oct 14 14:05:48 2012 +0000
@@ -19,7 +19,8 @@
 ##
 ## @deftypefn {Function File} {[@var{U}, @var{R}, @var{Q}, @var{X}] =} qnclosed (@var{N}, @var{S}, @var{V}, @dots{})
 ##
-## @cindex closed network
+## @cindex closed network, single class
+## @cindex closed network, multiple classes
 ##
 ## This function computes steady-state performance measures of closed
 ## queueing networks using the Mean Value Analysis (MVA) algorithm. The
--- a/main/queueing/inst/qnclosedsingleab.m	Sun Oct 14 13:39:34 2012 +0000
+++ b/main/queueing/inst/qnclosedsingleab.m	Sun Oct 14 14:05:48 2012 +0000
@@ -23,7 +23,7 @@
 ## @deftypefnx {Function File} {[@var{Xl}, @var{Xu}, @var{Rl}, @var{Ru}] =} qnclosedsingleab (@var{N}, @var{S}, @var{V}, @var{m}, @var{Z})
 ##
 ## @cindex bounds, asymptotic
-## @cindex closed network
+## @cindex closed network, single class
 ##
 ## Compute Asymptotic Bounds for throughput and response time of closed,
 ## single-class networks.
--- a/main/queueing/inst/qnclosedsinglebsb.m	Sun Oct 14 13:39:34 2012 +0000
+++ b/main/queueing/inst/qnclosedsinglebsb.m	Sun Oct 14 14:05:48 2012 +0000
@@ -23,7 +23,7 @@
 ## @deftypefnx {Function File} {[@var{Xl}, @var{Xu}, @var{Rl}, @var{Ru}] =} qnclosedsinglebsb (@var{N}, @var{S}, @var{V}, @var{m}, @var{Z})
 ##
 ## @cindex bounds, balanced system
-## @cindex closed network
+## @cindex closed network, single class
 ##
 ## Compute Balanced System Bounds on system throughput and response time for closed, single-class networks.
 ##
--- a/main/queueing/inst/qnclosedsinglemvaapprox.m	Sun Oct 14 13:39:34 2012 +0000
+++ b/main/queueing/inst/qnclosedsinglemvaapprox.m	Sun Oct 14 14:05:48 2012 +0000
@@ -25,7 +25,7 @@
 ##
 ## @cindex Mean Value Analysys (MVA), approximate
 ## @cindex MVA, approximate
-## @cindex Approximate MVA
+## @cindex approximate MVA
 ## @cindex closed network, single class
 ## @cindex closed network, approximate analysis
 ##
--- a/main/queueing/inst/qnconvolution.m	Sun Oct 14 13:39:34 2012 +0000
+++ b/main/queueing/inst/qnconvolution.m	Sun Oct 14 14:05:48 2012 +0000
@@ -20,7 +20,7 @@
 ## @deftypefn {Function File} {[@var{U}, @var{R}, @var{Q}, @var{X}, @var{G}] =} qnconvolution (@var{N}, @var{S}, @var{V})
 ## @deftypefnx {Function File} {[@var{U}, @var{R}, @var{Q}, @var{X}, @var{G}] =} qnconvolution (@var{N}, @var{S}, @var{V}, @var{m})
 ##
-## @cindex closed network
+## @cindex closed network, single class
 ## @cindex normalization constant
 ## @cindex convolution algorithm
 ##