Rename spec to sig in state-related API functions.
(to avoid confusion with mjSpec) PiperOrigin-RevId: 795848898 Change-Id: I0b64eb85f5c7a3ee889a746c751d9f5561650277
This commit is contained in:
committed by
Copybara-Service
parent
5a24eb2d34
commit
1447711037
@@ -235,7 +235,7 @@ computations, and are documented in more detail below.
|
||||
|
||||
.. mujoco-include:: mj_stateSize
|
||||
|
||||
Returns the number of :ref:`mjtNum` |-| s required for a given state specification. The bits of the integer ``spec``
|
||||
Returns the number of :ref:`mjtNum` |-| s required for a given state signature. The bits of the integer ``sig``
|
||||
correspond to element fields of :ref:`mjtState`.
|
||||
|
||||
.. _mj_getState:
|
||||
@@ -245,8 +245,8 @@ correspond to element fields of :ref:`mjtState`.
|
||||
|
||||
.. mujoco-include:: mj_getState
|
||||
|
||||
Copy concatenated state components specified by ``spec`` from ``d`` into ``state``. The bits of the integer
|
||||
``spec`` correspond to element fields of :ref:`mjtState`. Fails with :ref:`mju_error` if ``spec`` is invalid.
|
||||
Copy concatenated state components specified by ``sig`` from ``d`` into ``state``. The bits of the integer
|
||||
``sig`` correspond to element fields of :ref:`mjtState`. Fails with :ref:`mju_error` if ``sig`` is invalid.
|
||||
|
||||
.. _mj_setState:
|
||||
|
||||
@@ -255,8 +255,8 @@ Copy concatenated state components specified by ``spec`` from ``d`` into ``state
|
||||
|
||||
.. mujoco-include:: mj_setState
|
||||
|
||||
Copy concatenated state components specified by ``spec`` from ``state`` into ``d``. The bits of the integer
|
||||
``spec`` correspond to element fields of :ref:`mjtState`. Fails with :ref:`mju_error` if ``spec`` is invalid.
|
||||
Copy concatenated state components specified by ``sig`` from ``state`` into ``d``. The bits of the integer
|
||||
``sig`` correspond to element fields of :ref:`mjtState`. Fails with :ref:`mju_error` if ``sig`` is invalid.
|
||||
|
||||
.. _mj_setKeyframe:
|
||||
|
||||
|
||||
@@ -181,18 +181,18 @@ computations, and are documented in more detail below.
|
||||
|
||||
.. _mj_stateSize:
|
||||
|
||||
Returns the number of :ref:`mjtNum` |-| s required for a given state specification. The bits of the integer ``spec``
|
||||
Returns the number of :ref:`mjtNum` |-| s required for a given state signature. The bits of the integer ``sig``
|
||||
correspond to element fields of :ref:`mjtState`.
|
||||
|
||||
.. _mj_getState:
|
||||
|
||||
Copy concatenated state components specified by ``spec`` from ``d`` into ``state``. The bits of the integer
|
||||
``spec`` correspond to element fields of :ref:`mjtState`. Fails with :ref:`mju_error` if ``spec`` is invalid.
|
||||
Copy concatenated state components specified by ``sig`` from ``d`` into ``state``. The bits of the integer
|
||||
``sig`` correspond to element fields of :ref:`mjtState`. Fails with :ref:`mju_error` if ``sig`` is invalid.
|
||||
|
||||
.. _mj_setState:
|
||||
|
||||
Copy concatenated state components specified by ``spec`` from ``state`` into ``d``. The bits of the integer
|
||||
``spec`` correspond to element fields of :ref:`mjtState`. Fails with :ref:`mju_error` if ``spec`` is invalid.
|
||||
Copy concatenated state components specified by ``sig`` from ``state`` into ``d``. The bits of the integer
|
||||
``sig`` correspond to element fields of :ref:`mjtState`. Fails with :ref:`mju_error` if ``sig`` is invalid.
|
||||
|
||||
.. _mj_mulJacVec:
|
||||
|
||||
|
||||
Reference in New Issue
Block a user