.. _package-rst-stochastics:
=========================
Package rst.stochastics
=========================
The use of the term stochastic to mean based on the theory of
probability.
.. seealso::
Wikipedia article containing the definition above
http://en.wikipedia.org/wiki/Stochastic
Messages
========
.. container:: mess4ge-multi
.. container:: mess4ge-graph
.. digraph:: message_graph
fontname="Arial";
fontsize=11;
stylesheet="../_static/graphs.css";
node [fontsize=11,fontname="Arial"]
edge [fontsize=11,fontname="Arial"]
"1" [label=< | MixtureOfGaussian1D |
|
| GaussianComponent1D | components |
>,shape=box,style=filled,fillcolor="white"];
"2" [label=< | GaussianComponent1D |
|
| Gaussian1D | gaussian |
| FLOAT32 | weight |
| FLOAT32 | probability_state |
>,shape=box,style=filled,fillcolor="white"];
"3" [label=< | Gaussian1D |
|
| FLOAT32 | mean |
| FLOAT32 | variance |
>,shape=box,style=filled,fillcolor="white"];
"1" -> "2" [];
"1":components -> "2" [];
"2":gaussian -> "3" [];
.. container:: mess4ge-list
.. container:: messages
* :ref:`MixtureOfGaussian1D `
* :ref:`Gaussian1D `
.. container:: clearer
clearer: should be made invisible via css
.. _message-rst-stochastics-mixtureofgaussian1d:
Message MixtureOfGaussian1D
---------------------------
.. container:: message-rst-stochastics-mixtureofgaussian1d-multi
.. container:: message-rst-stochastics-mixtureofgaussian1d-documentation
.. py:class:: rst.stochastics.MixtureOfGaussian1D
**Constraint**: ``sum(.components.weight) = 1``
Weighted mixture of one-dimensional Gaussian distributions.
.. codeauthor:: Xavier Alameda-Pineda
.. codeauthor:: Johannes Wienke
.. py:attribute:: components
:type: array of :py:class:`rst.stochastics.MixtureOfGaussian1D.GaussianComponent1D`
Components of the mixture.
An empty set of components is not allowed.
The order of elements is not significant.
.. container:: message-rst-stochastics-mixtureofgaussian1d-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-0.15-merge-simulator/upstream/RST-0.15.0-Linux/share/rst0.15/proto/stable/rst/stochastics/MixtureOfGaussian1D.proto
:lines: 16-48
:language: protobuf
:emphasize-lines: 31-31
.. _message-rst-stochastics-mixtureofgaussian1d-gaussiancomponent1d:
Message GaussianComponent1D
---------------------------
.. container:: message-rst-stochastics-mixtureofgaussian1d-gaussiancomponent1d-multi
.. container:: message-rst-stochastics-mixtureofgaussian1d-gaussiancomponent1d-documentation
.. py:class:: rst.stochastics.MixtureOfGaussian1D.GaussianComponent1D
A mixture component distribution with its associated weight.
.. py:attribute:: gaussian
:type: :py:class:`rst.stochastics.Gaussian1D`
The Gaussian distribution associated with this component.
.. py:attribute:: weight
:type: :py:class:`FLOAT32`
**Constraint**: ``0 <= value <= 1``
Weight of this component.
.. py:attribute:: probability_state
:type: :py:class:`FLOAT32`
Deprecated implementation detail - do not use.
.. container:: message-rst-stochastics-mixtureofgaussian1d-gaussiancomponent1d-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-0.15-merge-simulator/upstream/RST-0.15.0-Linux/share/rst0.15/proto/stable/rst/stochastics/MixtureOfGaussian1D.proto
:lines: 21-38
:language: protobuf
:emphasize-lines: 6-6,12-12,17-17
.. _message-rst-stochastics-gaussian1d:
Message Gaussian1D
------------------
.. container:: message-rst-stochastics-gaussian1d-multi
.. container:: message-rst-stochastics-gaussian1d-documentation
.. py:class:: rst.stochastics.Gaussian1D
Describes a one-dimensional Gaussian distribution.
.. codeauthor:: Xavier Alameda-Pineda
.. codeauthor:: Johannes Wienke
.. py:attribute:: mean
:type: :py:class:`FLOAT32`
Mean of the distribution.
.. py:attribute:: variance
:type: :py:class:`FLOAT32`
**Constraint**: ``value >= 0``
Variance of the distribution.
.. container:: message-rst-stochastics-gaussian1d-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-0.15-merge-simulator/upstream/RST-0.15.0-Linux/share/rst0.15/proto/stable/rst/stochastics/Gaussian1D.proto
:lines: 13-26
:language: protobuf
:emphasize-lines: 6-6,12-12