Skip to content

Commit 203cc78

Browse files
committed
Fix ik docs
1 parent 590dcca commit 203cc78

File tree

1 file changed

+12
-17
lines changed

1 file changed

+12
-17
lines changed

docs/source/IK/ik.rst

Lines changed: 12 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -90,22 +90,18 @@ The C++ solvers can be identified as methods which start with ``ik_``.
9090
.. autosummary::
9191
:toctree: stubs
9292

93-
~roboticstoolbox.robot.ETS.ETS.ik_lm_chan
94-
~roboticstoolbox.robot.ETS.ETS.ik_lm_sugihara
95-
~roboticstoolbox.robot.ETS.ETS.ik_lm_wampler
96-
~roboticstoolbox.robot.ETS.ETS.ik_gn
97-
~roboticstoolbox.robot.ETS.ETS.ik_nr
93+
~roboticstoolbox.robot.ETS.ETS.ik_LM
94+
~roboticstoolbox.robot.ETS.ETS.ik_GN
95+
~roboticstoolbox.robot.ETS.ETS.ik_NR
9896

9997
.. rubric:: Robot C++ IK Methods
10098

10199
.. autosummary::
102100
:toctree: stubs
103101

104-
~roboticstoolbox.robot.ERobot.ERobot.ik_lm_chan
105-
~roboticstoolbox.robot.ERobot.ERobot.ik_lm_sugihara
106-
~roboticstoolbox.robot.ERobot.ERobot.ik_lm_wampler
107-
~roboticstoolbox.robot.ERobot.ERobot.ik_gn
108-
~roboticstoolbox.robot.ERobot.ERobot.ik_nr
102+
~roboticstoolbox.robot.Robot.Robot.ik_LM
103+
~roboticstoolbox.robot.Robot.Robot.ik_GN
104+
~roboticstoolbox.robot.Robot.Robot.ik_NR
109105

110106
In the following example, we create a :py:class:`~roboticstoolbox.models.URDF.Panda` robot and one of the fast IK solvers available within the :py:class:`~roboticstoolbox.robot.Robot.Robot` class.
111107

@@ -117,7 +113,7 @@ In the following example, we create a :py:class:`~roboticstoolbox.models.URDF.Pa
117113
>>> # Make a goal pose
118114
>>> Tep = panda.fkine([0, -0.3, 0, -2.2, 0, 2, 0.7854])
119115
>>> # Solve the IK problem
120-
>>> panda.ik_lm_chan(Tep)
116+
>>> panda.ik_LM(Tep)
121117

122118
In the following example, we create a :py:class:`~roboticstoolbox.models.URDF.Panda` robot and and then get the :py:class:`~roboticstoolbox.robot.ETS.ETS` representation. Subsequently, we use one of the fast IK solvers available within the :py:class:`~roboticstoolbox.robot.ETS.ETS` class.
123119

@@ -131,7 +127,7 @@ In the following example, we create a :py:class:`~roboticstoolbox.models.URDF.Pa
131127
>>> # Make a goal pose
132128
>>> Tep = ets.fkine([0, -0.3, 0, -2.2, 0, 2, 0.7854])
133129
>>> # Solve the IK problem
134-
>>> ets.ik_lm_chan(Tep)
130+
>>> ets.ik_LM(Tep)
135131

136132

137133

@@ -230,11 +226,10 @@ Additionally, these :py:class:`Class` based solvers have been implemented as met
230226
.. autosummary::
231227
:toctree: stubs
232228

233-
~roboticstoolbox.robot.ERobot.ERobot.ikine_LM
234-
235-
236-
.. ~roboticstoolbox.robot.ERobot.ERobot.ikine_GN
237-
.. ~roboticstoolbox.robot.ERobot.ERobot.ikine_NR
229+
~roboticstoolbox.robot.Robot.Robot.ikine_LM
230+
~roboticstoolbox.robot.Robot.Robot.ikine_QP
231+
~roboticstoolbox.robot.Robot.Robot.ikine_GN
232+
~roboticstoolbox.robot.Robot.Robot.ikine_NR
238233

239234

240235
.. rubric:: Example

0 commit comments

Comments
 (0)