.. _package-rst-math:
==================
Package rst.math
==================
*Not documented*
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"]
"4" [label=< | Vec3DDouble |
|
| FLOAT64 | x |
| FLOAT64 | y |
| FLOAT64 | z |
>,shape=box,style=filled,fillcolor="white"];
"1" [label=< | MatrixDouble |
|
| Size | size |
| Data | data |
>,shape=box,style=filled,fillcolor="white"];
"3" [label=< | Data |
|
| FLOAT64 | value |
>,shape=box,style=filled,fillcolor="white"];
"2" [label=< | Size |
|
| UINT32 | m |
| UINT32 | n |
>,shape=box,style=filled,fillcolor="white"];
"1" -> "3" [];
"1" -> "2" [];
"1":data -> "3" [];
"1":size -> "2" [];
.. container:: mess4ge-list
.. container:: messages
* :ref:`MatrixDouble `
* :ref:`Vec3DDouble `
.. container:: clearer
clearer: should be made invisible via css
.. _message-rst-math-matrixdouble:
Message MatrixDouble
--------------------
.. container:: message-rst-math-matrixdouble-multi
.. container:: message-rst-math-matrixdouble-documentation
.. py:class:: rst.math.MatrixDouble
A matrix of m x n double entries.
.. codeauthor:: Michael Goetting
.. py:attribute:: size
:type: :py:class:`rst.math.MatrixDouble.Size`
The dimensions of the matrix.
.. py:attribute:: data
:type: :py:class:`rst.math.MatrixDouble.Data`
The entries of the matrix
.. container:: message-rst-math-matrixdouble-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-0.14-merge-simulator/upstream/RST-0.14.2-Linux/share/rst0.14/proto/stable/rst/math/MatrixDouble.proto
:lines: 10-53
:language: protobuf
:emphasize-lines: 37-37,42-42
.. _message-rst-math-matrixdouble-size:
Message Size
------------
.. container:: message-rst-math-matrixdouble-size-multi
.. container:: message-rst-math-matrixdouble-size-documentation
.. py:class:: rst.math.MatrixDouble.Size
Dimensions of the matrix.
.. py:attribute:: m
:type: :py:class:`UINT32`
Number of rows of the matrix.
.. py:attribute:: n
:type: :py:class:`UINT32`
Number of columns of the matrix.
.. container:: message-rst-math-matrixdouble-size-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-0.14-merge-simulator/upstream/RST-0.14.2-Linux/share/rst0.14/proto/stable/rst/math/MatrixDouble.proto
:lines: 15-27
:language: protobuf
:emphasize-lines: 6-6,11-11
.. _message-rst-math-matrixdouble-data:
Message Data
------------
.. container:: message-rst-math-matrixdouble-data-multi
.. container:: message-rst-math-matrixdouble-data-documentation
.. py:class:: rst.math.MatrixDouble.Data
Data of the matrix.
Entries are stored in rowwise.
.. py:attribute:: value
:type: array of :py:class:`FLOAT64`
A flat sequence of the entries of the matrix.
.. container:: message-rst-math-matrixdouble-data-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-0.14-merge-simulator/upstream/RST-0.14.2-Linux/share/rst0.14/proto/stable/rst/math/MatrixDouble.proto
:lines: 34-41
:language: protobuf
:emphasize-lines: 6-6
.. _message-rst-math-vec3ddouble:
Message Vec3DDouble
-------------------
.. container:: message-rst-math-vec3ddouble-multi
.. container:: message-rst-math-vec3ddouble-documentation
.. py:class:: rst.math.Vec3DDouble
A 3D vector with double entries.
.. codeauthor:: Michael Goetting
.. py:attribute:: x
:type: :py:class:`FLOAT64`
The X component of the vector.
.. py:attribute:: y
:type: :py:class:`FLOAT64`
The Y component of the vector.
.. py:attribute:: z
:type: :py:class:`FLOAT64`
The Z component of the vector.
.. container:: message-rst-math-vec3ddouble-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-0.14-merge-simulator/upstream/RST-0.14.2-Linux/share/rst0.14/proto/stable/rst/math/Vec3DDouble.proto
:lines: 10-27
:language: protobuf
:emphasize-lines: 6-6,11-11,16-16