Skip to content

Commit eb85c86

Browse files
1 parent 5ec3e1b commit eb85c86

File tree

608 files changed

+13814
-13871
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

608 files changed

+13814
-13871
lines changed

doxygen_cxx/classdrake_1_1planning_1_1trajectory__optimization_1_1_kinematic_trajectory_optimization-members.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -165,10 +165,10 @@
165165

166166
<p>This is the complete list of members for <a class="el" href="classdrake_1_1planning_1_1trajectory__optimization_1_1_kinematic_trajectory_optimization.html">KinematicTrajectoryOptimization</a>, including all inherited members.</p>
167167
<table class="directory">
168-
<tr class="even"><td class="entry"><a class="el" href="classdrake_1_1planning_1_1trajectory__optimization_1_1_kinematic_trajectory_optimization.html#a712d19c4728dc4e70244c8c192377032">AddAccelerationBounds</a>(const Eigen::Ref&lt; const Eigen::VectorXd &gt; &amp;lb, const Eigen::Ref&lt; const Eigen::VectorXd &gt; &amp;ub)</td><td class="entry"><a class="el" href="classdrake_1_1planning_1_1trajectory__optimization_1_1_kinematic_trajectory_optimization.html">KinematicTrajectoryOptimization</a></td><td class="entry"></td></tr>
168+
<tr class="even"><td class="entry"><a class="el" href="classdrake_1_1planning_1_1trajectory__optimization_1_1_kinematic_trajectory_optimization.html#a850317f5fe8fa8343e0690a51556bbbe">AddAccelerationBounds</a>(const Eigen::Ref&lt; const Eigen::VectorXd &gt; &amp;lb, const Eigen::Ref&lt; const Eigen::VectorXd &gt; &amp;ub)</td><td class="entry"><a class="el" href="classdrake_1_1planning_1_1trajectory__optimization_1_1_kinematic_trajectory_optimization.html">KinematicTrajectoryOptimization</a></td><td class="entry"></td></tr>
169169
<tr><td class="entry"><a class="el" href="classdrake_1_1planning_1_1trajectory__optimization_1_1_kinematic_trajectory_optimization.html#afe1106b68562afbcfec8556500df5f90">AddDurationConstraint</a>(std::optional&lt; double &gt; lb, std::optional&lt; double &gt; ub)</td><td class="entry"><a class="el" href="classdrake_1_1planning_1_1trajectory__optimization_1_1_kinematic_trajectory_optimization.html">KinematicTrajectoryOptimization</a></td><td class="entry"></td></tr>
170170
<tr class="even"><td class="entry"><a class="el" href="classdrake_1_1planning_1_1trajectory__optimization_1_1_kinematic_trajectory_optimization.html#ae3f60fe9552c90c9a3986f023ba18a56">AddDurationCost</a>(double weight=1.0)</td><td class="entry"><a class="el" href="classdrake_1_1planning_1_1trajectory__optimization_1_1_kinematic_trajectory_optimization.html">KinematicTrajectoryOptimization</a></td><td class="entry"></td></tr>
171-
<tr><td class="entry"><a class="el" href="classdrake_1_1planning_1_1trajectory__optimization_1_1_kinematic_trajectory_optimization.html#ab13f393292d6592dc959f55625fe0f5d">AddJerkBounds</a>(const Eigen::Ref&lt; const Eigen::VectorXd &gt; &amp;lb, const Eigen::Ref&lt; const Eigen::VectorXd &gt; &amp;ub)</td><td class="entry"><a class="el" href="classdrake_1_1planning_1_1trajectory__optimization_1_1_kinematic_trajectory_optimization.html">KinematicTrajectoryOptimization</a></td><td class="entry"></td></tr>
171+
<tr><td class="entry"><a class="el" href="classdrake_1_1planning_1_1trajectory__optimization_1_1_kinematic_trajectory_optimization.html#a8c266cf092028fbabcc0bca77054d3a3">AddJerkBounds</a>(const Eigen::Ref&lt; const Eigen::VectorXd &gt; &amp;lb, const Eigen::Ref&lt; const Eigen::VectorXd &gt; &amp;ub)</td><td class="entry"><a class="el" href="classdrake_1_1planning_1_1trajectory__optimization_1_1_kinematic_trajectory_optimization.html">KinematicTrajectoryOptimization</a></td><td class="entry"></td></tr>
172172
<tr class="even"><td class="entry"><a class="el" href="classdrake_1_1planning_1_1trajectory__optimization_1_1_kinematic_trajectory_optimization.html#a67ebb878e71a66ac8d6ea1e739766d3b">AddPathAccelerationConstraint</a>(const Eigen::Ref&lt; const Eigen::VectorXd &gt; &amp;lb, const Eigen::Ref&lt; const Eigen::VectorXd &gt; &amp;ub, double s)</td><td class="entry"><a class="el" href="classdrake_1_1planning_1_1trajectory__optimization_1_1_kinematic_trajectory_optimization.html">KinematicTrajectoryOptimization</a></td><td class="entry"></td></tr>
173173
<tr><td class="entry"><a class="el" href="classdrake_1_1planning_1_1trajectory__optimization_1_1_kinematic_trajectory_optimization.html#a411b4823b494999f0d51e7d0afac17c0">AddPathEnergyCost</a>(double weight=1.0)</td><td class="entry"><a class="el" href="classdrake_1_1planning_1_1trajectory__optimization_1_1_kinematic_trajectory_optimization.html">KinematicTrajectoryOptimization</a></td><td class="entry"></td></tr>
174174
<tr class="even"><td class="entry"><a class="el" href="classdrake_1_1planning_1_1trajectory__optimization_1_1_kinematic_trajectory_optimization.html#a6da88e725b9e65eb10ffe19f25742ad4">AddPathLengthCost</a>(double weight=1.0, bool use_conic_constraint=false)</td><td class="entry"><a class="el" href="classdrake_1_1planning_1_1trajectory__optimization_1_1_kinematic_trajectory_optimization.html">KinematicTrajectoryOptimization</a></td><td class="entry"></td></tr>

doxygen_cxx/classdrake_1_1planning_1_1trajectory__optimization_1_1_kinematic_trajectory_optimization.html

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -237,12 +237,12 @@
237237
<tr class="memitem:a8529eb42d4e8ce382c0a53ee9b26e236"><td class="memItemLeft" align="right" valign="top">std::vector&lt; <a class="el" href="classdrake_1_1solvers_1_1_binding.html">solvers::Binding</a>&lt; <a class="el" href="classdrake_1_1solvers_1_1_linear_constraint.html">solvers::LinearConstraint</a> &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdrake_1_1planning_1_1trajectory__optimization_1_1_kinematic_trajectory_optimization.html#a8529eb42d4e8ce382c0a53ee9b26e236">AddVelocityBounds</a> (const Eigen::Ref&lt; const Eigen::VectorXd &gt; &amp;lb, const Eigen::Ref&lt; const Eigen::VectorXd &gt; &amp;ub)</td></tr>
238238
<tr class="memdesc:a8529eb42d4e8ce382c0a53ee9b26e236"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adds linear constraints to enforce upper and lower bounds on the velocity trajectory, q̇(t). <a href="#a8529eb42d4e8ce382c0a53ee9b26e236">More...</a><br /></td></tr>
239239
<tr class="separator:a8529eb42d4e8ce382c0a53ee9b26e236"><td class="memSeparator" colspan="2">&#160;</td></tr>
240-
<tr class="memitem:a712d19c4728dc4e70244c8c192377032"><td class="memItemLeft" align="right" valign="top">std::vector&lt; std::vector&lt; <a class="el" href="classdrake_1_1solvers_1_1_binding.html">solvers::Binding</a>&lt; <a class="el" href="classdrake_1_1solvers_1_1_constraint.html">solvers::Constraint</a> &gt; &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdrake_1_1planning_1_1trajectory__optimization_1_1_kinematic_trajectory_optimization.html#a712d19c4728dc4e70244c8c192377032">AddAccelerationBounds</a> (const Eigen::Ref&lt; const Eigen::VectorXd &gt; &amp;lb, const Eigen::Ref&lt; const Eigen::VectorXd &gt; &amp;ub)</td></tr>
241-
<tr class="memdesc:a712d19c4728dc4e70244c8c192377032"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adds generic (nonlinear) constraints to enforce the upper and lower bounds to the acceleration trajectory, q̈(t). <a href="#a712d19c4728dc4e70244c8c192377032">More...</a><br /></td></tr>
242-
<tr class="separator:a712d19c4728dc4e70244c8c192377032"><td class="memSeparator" colspan="2">&#160;</td></tr>
243-
<tr class="memitem:ab13f393292d6592dc959f55625fe0f5d"><td class="memItemLeft" align="right" valign="top">std::vector&lt; std::vector&lt; <a class="el" href="classdrake_1_1solvers_1_1_binding.html">solvers::Binding</a>&lt; <a class="el" href="classdrake_1_1solvers_1_1_constraint.html">solvers::Constraint</a> &gt; &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdrake_1_1planning_1_1trajectory__optimization_1_1_kinematic_trajectory_optimization.html#ab13f393292d6592dc959f55625fe0f5d">AddJerkBounds</a> (const Eigen::Ref&lt; const Eigen::VectorXd &gt; &amp;lb, const Eigen::Ref&lt; const Eigen::VectorXd &gt; &amp;ub)</td></tr>
244-
<tr class="memdesc:ab13f393292d6592dc959f55625fe0f5d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adds generic (nonlinear) constraints to enforce the upper and lower bounds to the jerk trajectory, d³qdt³(t). <a href="#ab13f393292d6592dc959f55625fe0f5d">More...</a><br /></td></tr>
245-
<tr class="separator:ab13f393292d6592dc959f55625fe0f5d"><td class="memSeparator" colspan="2">&#160;</td></tr>
240+
<tr class="memitem:a850317f5fe8fa8343e0690a51556bbbe"><td class="memItemLeft" align="right" valign="top">std::vector&lt; <a class="el" href="classdrake_1_1solvers_1_1_binding.html">solvers::Binding</a>&lt; <a class="el" href="classdrake_1_1solvers_1_1_constraint.html">solvers::Constraint</a> &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdrake_1_1planning_1_1trajectory__optimization_1_1_kinematic_trajectory_optimization.html#a850317f5fe8fa8343e0690a51556bbbe">AddAccelerationBounds</a> (const Eigen::Ref&lt; const Eigen::VectorXd &gt; &amp;lb, const Eigen::Ref&lt; const Eigen::VectorXd &gt; &amp;ub)</td></tr>
241+
<tr class="memdesc:a850317f5fe8fa8343e0690a51556bbbe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adds generic (nonlinear) constraints to enforce the upper and lower bounds to the acceleration trajectory, q̈(t). <a href="#a850317f5fe8fa8343e0690a51556bbbe">More...</a><br /></td></tr>
242+
<tr class="separator:a850317f5fe8fa8343e0690a51556bbbe"><td class="memSeparator" colspan="2">&#160;</td></tr>
243+
<tr class="memitem:a8c266cf092028fbabcc0bca77054d3a3"><td class="memItemLeft" align="right" valign="top">std::vector&lt; <a class="el" href="classdrake_1_1solvers_1_1_binding.html">solvers::Binding</a>&lt; <a class="el" href="classdrake_1_1solvers_1_1_constraint.html">solvers::Constraint</a> &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdrake_1_1planning_1_1trajectory__optimization_1_1_kinematic_trajectory_optimization.html#a8c266cf092028fbabcc0bca77054d3a3">AddJerkBounds</a> (const Eigen::Ref&lt; const Eigen::VectorXd &gt; &amp;lb, const Eigen::Ref&lt; const Eigen::VectorXd &gt; &amp;ub)</td></tr>
244+
<tr class="memdesc:a8c266cf092028fbabcc0bca77054d3a3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adds generic (nonlinear) constraints to enforce the upper and lower bounds to the jerk trajectory, d³qdt³(t). <a href="#a8c266cf092028fbabcc0bca77054d3a3">More...</a><br /></td></tr>
245+
<tr class="separator:a8c266cf092028fbabcc0bca77054d3a3"><td class="memSeparator" colspan="2">&#160;</td></tr>
246246
<tr class="memitem:ae3f60fe9552c90c9a3986f023ba18a56"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classdrake_1_1solvers_1_1_binding.html">solvers::Binding</a>&lt; <a class="el" href="classdrake_1_1solvers_1_1_linear_cost.html">solvers::LinearCost</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdrake_1_1planning_1_1trajectory__optimization_1_1_kinematic_trajectory_optimization.html#ae3f60fe9552c90c9a3986f023ba18a56">AddDurationCost</a> (<a class="el" href="classdouble.html">double</a> weight=1.0)</td></tr>
247247
<tr class="memdesc:ae3f60fe9552c90c9a3986f023ba18a56"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adds a linear cost on the duration of the trajectory. <a href="#ae3f60fe9552c90c9a3986f023ba18a56">More...</a><br /></td></tr>
248248
<tr class="separator:ae3f60fe9552c90c9a3986f023ba18a56"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -396,14 +396,14 @@ <h2 class="memtitle"><span class="permalink"><a href="#a65363bc4338584a02f119b22
396396
</div>
397397
</div>
398398
<h2 class="groupheader">Member Function Documentation</h2>
399-
<a id="a712d19c4728dc4e70244c8c192377032"></a>
400-
<h2 class="memtitle"><span class="permalink"><a href="#a712d19c4728dc4e70244c8c192377032">&#9670;&nbsp;</a></span>AddAccelerationBounds()</h2>
399+
<a id="a850317f5fe8fa8343e0690a51556bbbe"></a>
400+
<h2 class="memtitle"><span class="permalink"><a href="#a850317f5fe8fa8343e0690a51556bbbe">&#9670;&nbsp;</a></span>AddAccelerationBounds()</h2>
401401

402402
<div class="memitem">
403403
<div class="memproto">
404404
<table class="memname">
405405
<tr>
406-
<td class="memname">std::vector&lt;std::vector&lt;<a class="el" href="classdrake_1_1solvers_1_1_binding.html">solvers::Binding</a>&lt;<a class="el" href="classdrake_1_1solvers_1_1_constraint.html">solvers::Constraint</a>&gt; &gt; &gt; AddAccelerationBounds </td>
406+
<td class="memname">std::vector&lt;<a class="el" href="classdrake_1_1solvers_1_1_binding.html">solvers::Binding</a>&lt;<a class="el" href="classdrake_1_1solvers_1_1_constraint.html">solvers::Constraint</a>&gt; &gt; AddAccelerationBounds </td>
407407
<td>(</td>
408408
<td class="paramtype">const Eigen::Ref&lt; const Eigen::VectorXd &gt; &amp;&#160;</td>
409409
<td class="paramname"><em>lb</em>, </td>
@@ -423,8 +423,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#a712d19c4728dc4e70244c8c1
423423
</div><div class="memdoc">
424424

425425
<p>Adds generic (nonlinear) constraints to enforce the upper and lower bounds to the acceleration trajectory, q̈(t). </p>
426-
<p>These constraints will be respected at all times. Note that this does NOT directly constrain r̈(s).</p>
427-
<dl class="section return"><dt>Returns</dt><dd>A vector of bindings with the ith element is itself a vector of constraints (one per dof) adding a constraint to the ith control point of the acceleration trajectory. </dd></dl>
426+
<p>By leveraging the convex hull property of B-splines, these bounds are applied at the (derivative) control points, but will be respected for all times, t ∈ [0,T]. Note that this does NOT directly constrain r̈(s).</p>
427+
<dl class="section return"><dt>Returns</dt><dd>A vector of bindings with interleaved lower and then upper bounds, constraining all of the control points for one element of q̈ (e.g. the acceleration of the ith joint at all times). However, this specific interpretation of these constraints may change without deprecation. </dd></dl>
428428

429429
</div>
430430
</div>
@@ -478,14 +478,14 @@ <h2 class="memtitle"><span class="permalink"><a href="#ae3f60fe9552c90c9a3986f02
478478

479479
</div>
480480
</div>
481-
<a id="ab13f393292d6592dc959f55625fe0f5d"></a>
482-
<h2 class="memtitle"><span class="permalink"><a href="#ab13f393292d6592dc959f55625fe0f5d">&#9670;&nbsp;</a></span>AddJerkBounds()</h2>
481+
<a id="a8c266cf092028fbabcc0bca77054d3a3"></a>
482+
<h2 class="memtitle"><span class="permalink"><a href="#a8c266cf092028fbabcc0bca77054d3a3">&#9670;&nbsp;</a></span>AddJerkBounds()</h2>
483483

484484
<div class="memitem">
485485
<div class="memproto">
486486
<table class="memname">
487487
<tr>
488-
<td class="memname">std::vector&lt;std::vector&lt;<a class="el" href="classdrake_1_1solvers_1_1_binding.html">solvers::Binding</a>&lt;<a class="el" href="classdrake_1_1solvers_1_1_constraint.html">solvers::Constraint</a>&gt; &gt; &gt; AddJerkBounds </td>
488+
<td class="memname">std::vector&lt;<a class="el" href="classdrake_1_1solvers_1_1_binding.html">solvers::Binding</a>&lt;<a class="el" href="classdrake_1_1solvers_1_1_constraint.html">solvers::Constraint</a>&gt; &gt; AddJerkBounds </td>
489489
<td>(</td>
490490
<td class="paramtype">const Eigen::Ref&lt; const Eigen::VectorXd &gt; &amp;&#160;</td>
491491
<td class="paramname"><em>lb</em>, </td>
@@ -505,8 +505,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ab13f393292d6592dc959f556
505505
</div><div class="memdoc">
506506

507507
<p>Adds generic (nonlinear) constraints to enforce the upper and lower bounds to the jerk trajectory, d³qdt³(t). </p>
508-
<p>These constraints will be respected at all times. Note that this does NOT directly constrain d³rds³(s).</p>
509-
<dl class="section return"><dt>Returns</dt><dd>A vector of bindings with the ith element is itself a vector of constraints (one per dof) adding a constraint to the ith control point of the jerk trajectory. </dd></dl>
508+
<p>By leveraging the convex hull property of B-splines, these bounds are applied at the (derivative) control points, but will be respected for all times, t ∈ [0,T]. Note that this does NOT directly constrain d³rds³(s).</p>
509+
<dl class="section return"><dt>Returns</dt><dd>A vector of bindings with interleaved lower and then upper bounds, constraining all of the control points for one element of d³qdt³ (e.g. the jerk of the ith joint at all times). However, this specific interpretation of these constraints may change without deprecation. </dd></dl>
510510

511511
</div>
512512
</div>
@@ -565,7 +565,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a411b4823b494999f0d51e7d0
565565

566566
<p>Adds a convex quadratic cost on an upper bound on the energy of the path, ∫₀¹ |ṙ(s)|₂² ds, by summing the squared distance between the path control points. </p>
567567
<p>In the limit of infinitely many control points, minimizers for AddPathLengthCost and AddPathEnergyCost will follow the same path, but potentially with different timing. They may have different values if additional costs and constraints are imposed. This cost yields simpler gradients than AddPathLengthCost, and biases the control points towards being evenly spaced.</p>
568-
<dl class="section return"><dt>Returns</dt><dd>A vector of bindings with the ith element adding a cost to the ith control point of the velocity trajectory. </dd></dl>
568+
<dl class="section return"><dt>Returns</dt><dd>A vector of bindings with the ith element adding a cost to the ith control point of the velocity trajectory. However, this specific interpretation of these constraints may change without deprecation. </dd></dl>
569569

570570
</div>
571571
</div>
@@ -597,7 +597,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a6da88e725b9e65eb10ffe19f
597597

598598
<p>Adds a cost on an upper bound of the length of the path, ∫₀ᵀ |q̇(t)|₂ dt, or equivalently ∫₀¹ |ṙ(s)|₂ ds, by summing the distance between the path control points. </p>
599599
<p>If <code>use_conic_constraint = false</code>, then costs are added via MathematicalProgram::AddL2NormCost; otherwise they are added via MathematicalProgram::AddL2NormCostUsingConicConstraint.</p>
600-
<dl class="section return"><dt>Returns</dt><dd>A vector of bindings with the ith element adding a cost to the ith control point of the velocity trajectory. </dd></dl>
600+
<dl class="section return"><dt>Returns</dt><dd>A vector of bindings with the ith element adding a cost to the ith control point of the velocity trajectory. However, this specific interpretation of these constraints may change without deprecation. </dd></dl>
601601

602602
</div>
603603
</div>
@@ -736,7 +736,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a81d27229471360feee82aac9
736736

737737
<p>Adds bounding box constraints to enforce upper and lower bounds on the positions trajectory, q(t). </p>
738738
<p>These bounds will be respected at all times, t∈[0,T]. This also implies the constraints are satisfied for r(s), for all s∈[0,1].</p>
739-
<dl class="section return"><dt>Returns</dt><dd>A vector of bindings with the ith element adding a constraint to the ith control point. </dd></dl>
739+
<dl class="section return"><dt>Returns</dt><dd>A vector of bindings with the ith element adding a constraint to the ith control point. However, this specific interpretation of these constraints may change without deprecation. </dd></dl>
740740

741741
</div>
742742
</div>
@@ -767,8 +767,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#a8529eb42d4e8ce382c0a53ee
767767
</div><div class="memdoc">
768768

769769
<p>Adds linear constraints to enforce upper and lower bounds on the velocity trajectory, q̇(t). </p>
770-
<p>These bounds will be respected at all times. Note this does NOT directly constrain ṙ(s).</p>
771-
<dl class="section return"><dt>Returns</dt><dd>A vector of bindings with the ith element adding a constraint to the ith control point of the derivative trajectory. </dd></dl>
770+
<p>By leveraging the convex hull property of B-splines, these bounds are applied at the (derivative) control points, but will be respected for all times, t ∈ [0,T]. Note this does NOT directly constrain ṙ(s).</p>
771+
<dl class="section return"><dt>Returns</dt><dd>A vector of bindings with interleaved lower and then upper bounds, constraining all of the control points for one element of q̇ (e.g. the velocity of the ith joint at all times). However, this specific interpretation of these constraints may change without deprecation.. </dd></dl>
772772

773773
</div>
774774
</div>

0 commit comments

Comments
 (0)