.. _package-rst-math: ================== Package rst.math ================== This package contains data types representing mathematical concepts. Examples include vectors over different bodies and precisions (e.g. :py:class:`Vec2DInt `, :py:class:`Vec2DFloat `) and similar matrices (e.g. :py:class:`MatrixDouble `). 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"] "9" [label=<
Vec3DFloat
FLOAT32x
FLOAT32y
FLOAT32z
>,shape=box,style=filled,fillcolor="white"]; "8" [label=<
Vec2DInt
INT32x
INT32y
>,shape=box,style=filled,fillcolor="white"]; "7" [label=<
Vec3DDouble
FLOAT64x
FLOAT64y
FLOAT64z
>,shape=box,style=filled,fillcolor="white"]; "6" [label=<
VectorDouble
FLOAT64data
>,shape=box,style=filled,fillcolor="white"]; "5" [label=<
Vec3DInt
INT32x
INT32y
INT32z
>,shape=box,style=filled,fillcolor="white"]; "4" [label=<
Vec2DFloat
FLOAT32x
FLOAT32y
>,shape=box,style=filled,fillcolor="white"]; "1" [label=<
MatrixDouble
Sizesize
Datadata
>,shape=box,style=filled,fillcolor="white"]; "3" [label=<
Data
FLOAT64value
>,shape=box,style=filled,fillcolor="white"]; "2" [label=<
Size
UINT32m
UINT32n
>,shape=box,style=filled,fillcolor="white"]; "1" -> "3" []; "1" -> "2" []; "1":data -> "3" []; "1":size -> "2" []; .. container:: mess4ge-list .. container:: messages * :ref:`MatrixDouble ` * :ref:`Vec2DFloat ` * :ref:`Vec3DInt ` * :ref:`VectorDouble ` * :ref:`Vec3DDouble ` * :ref:`Vec2DInt ` * :ref:`Vec3DFloat ` .. 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.15-merge-simulator/upstream/RST-0.15.0-Linux/share/rst0.15/proto/stable/rst/math/MatrixDouble.proto :lines: 12-55 :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.15-merge-simulator/upstream/RST-0.15.0-Linux/share/rst0.15/proto/stable/rst/math/MatrixDouble.proto :lines: 17-29 :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.15-merge-simulator/upstream/RST-0.15.0-Linux/share/rst0.15/proto/stable/rst/math/MatrixDouble.proto :lines: 36-43 :language: protobuf :emphasize-lines: 6-6 .. _message-rst-math-vec2dfloat: Message Vec2DFloat ------------------ .. container:: message-rst-math-vec2dfloat-multi .. container:: message-rst-math-vec2dfloat-documentation .. py:class:: rst.math.Vec2DFloat A 2D vector with float entries. .. codeauthor:: Michael Goetting .. py:attribute:: x :type: :py:class:`FLOAT32` The X component of the vector. .. py:attribute:: y :type: :py:class:`FLOAT32` The Y component of the vector. .. container:: message-rst-math-vec2dfloat-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/math/Vec2DFloat.proto :lines: 12-24 :language: protobuf :emphasize-lines: 6-6,11-11 .. _message-rst-math-vec3dint: Message Vec3DInt ---------------- .. container:: message-rst-math-vec3dint-multi .. container:: message-rst-math-vec3dint-documentation .. py:class:: rst.math.Vec3DInt A 3D vector with integer entries. .. codeauthor:: Michael Goetting .. py:attribute:: x :type: :py:class:`INT32` The X component of the vector. .. py:attribute:: y :type: :py:class:`INT32` The Y component of the vector. .. py:attribute:: z :type: :py:class:`INT32` The Z component of the vector. .. container:: message-rst-math-vec3dint-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/math/Vec3DInt.proto :lines: 12-29 :language: protobuf :emphasize-lines: 6-6,11-11,16-16 .. _message-rst-math-vectordouble: Message VectorDouble -------------------- .. container:: message-rst-math-vectordouble-multi .. container:: message-rst-math-vectordouble-documentation .. py:class:: rst.math.VectorDouble A vector of double entries. Use fixed-dimensions data-types whenever possible. .. codeauthor:: Arne Nordmann .. py:attribute:: data :type: array of :py:class:`FLOAT64` Vector elements. .. container:: message-rst-math-vectordouble-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/math/VectorDouble.proto :lines: 14-21 :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.15-merge-simulator/upstream/RST-0.15.0-Linux/share/rst0.15/proto/stable/rst/math/Vec3DDouble.proto :lines: 12-29 :language: protobuf :emphasize-lines: 6-6,11-11,16-16 .. _message-rst-math-vec2dint: Message Vec2DInt ---------------- .. container:: message-rst-math-vec2dint-multi .. container:: message-rst-math-vec2dint-documentation .. py:class:: rst.math.Vec2DInt A 2D vector with integer entries. .. codeauthor:: Michael Goetting .. py:attribute:: x :type: :py:class:`INT32` The X component of the vector. .. py:attribute:: y :type: :py:class:`INT32` The Y component of the vector. .. container:: message-rst-math-vec2dint-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/math/Vec2DInt.proto :lines: 12-24 :language: protobuf :emphasize-lines: 6-6,11-11 .. _message-rst-math-vec3dfloat: Message Vec3DFloat ------------------ .. container:: message-rst-math-vec3dfloat-multi .. container:: message-rst-math-vec3dfloat-documentation .. py:class:: rst.math.Vec3DFloat A 3D vector with float entries. .. codeauthor:: Michael Goetting .. py:attribute:: x :type: :py:class:`FLOAT32` The X-component of the vector. .. py:attribute:: y :type: :py:class:`FLOAT32` The Y-component of the vector. .. py:attribute:: z :type: :py:class:`FLOAT32` The Z-component of the vector. .. container:: message-rst-math-vec3dfloat-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/math/Vec3DFloat.proto :lines: 12-29 :language: protobuf :emphasize-lines: 6-6,11-11,16-16