|
| 1 | +<!-- HTML header for doxygen 1.8.15--> |
| 2 | +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| 3 | +<html xmlns="http://www.w3.org/1999/xhtml"> |
| 4 | +<head> |
| 5 | +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| 6 | +<meta http-equiv="X-UA-Compatible" content="IE=9"/> |
| 7 | +<meta name="generator" content="Doxygen 1.8.15"/> |
| 8 | +<meta name="viewport" content="width=device-width, initial-scale=1"/> |
| 9 | +<title>Drake: drake/solvers/test_utilities/check_gradient_sparsity_pattern.h File Reference</title> |
| 10 | +<link href="tabs.css" rel="stylesheet" type="text/css"/> |
| 11 | +<script type="text/javascript" src="jquery.js"></script> |
| 12 | +<script type="text/javascript" src="dynsections.js"></script> |
| 13 | +<link href="navtree.css" rel="stylesheet" type="text/css"/> |
| 14 | +<script type="text/javascript" src="resize.js"></script> |
| 15 | +<script type="text/javascript" src="navtreedata.js"></script> |
| 16 | +<script type="text/javascript" src="navtree.js"></script> |
| 17 | +<script type="text/javascript"> |
| 18 | +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| 19 | + $(document).ready(initResizable); |
| 20 | +/* @license-end */</script> |
| 21 | +<link href="search/search.css" rel="stylesheet" type="text/css"/> |
| 22 | +<script type="text/javascript" src="search/searchdata.js"></script> |
| 23 | +<script type="text/javascript" src="search/search.js"></script> |
| 24 | +<script type="text/javascript"> |
| 25 | +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| 26 | + $(document).ready(function() { init_search(); }); |
| 27 | +/* @license-end */ |
| 28 | +</script> |
| 29 | +<script type="text/x-mathjax-config"> |
| 30 | + MathJax.Hub.Config({ |
| 31 | + extensions: ["tex2jax.js"], |
| 32 | + jax: ["input/TeX","output/HTML-CSS"], |
| 33 | +}); |
| 34 | +</script><script type="text/javascript" async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js"></script> |
| 35 | +<link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| 36 | +<link href="doxygen_extra.css" rel="stylesheet" type="text/css"/> |
| 37 | +</head> |
| 38 | +<body> |
| 39 | +<div id="top"><!-- do not remove this div, it is closed by doxygen! --> |
| 40 | +<header class="site-header"> |
| 41 | + <div class="site-header-inner contain"> |
| 42 | + <a class="drake-logo" href="/"><img src="/images/drake-logo-white.svg"></a> |
| 43 | + <div class="menu-mobile-toggle"> |
| 44 | + <span></span> |
| 45 | + </div> |
| 46 | + <nav class="site-menu"> |
| 47 | + <ul> |
| 48 | + <li class="site-menu-item site-menu-item-main"> |
| 49 | + <a class="site-menu-item" href="/">Home</a> |
| 50 | + </li> |
| 51 | + <li class="site-menu-item site-menu-item-main"> |
| 52 | + <a class="site-menu-item" href="/installation.html">Installation</a> |
| 53 | + </li> |
| 54 | + <li class="site-menu-item site-menu-item-main"> |
| 55 | + <a class="site-menu-item" href="/gallery.html">Gallery</a> |
| 56 | + </li> |
| 57 | + <li class="site-menu-item site-menu-item-main">API Documentation |
| 58 | + <div class="sub"> |
| 59 | + <a class="site-menu-item" href="/doxygen_cxx/index.html">C++</a> |
| 60 | + <a class="site-menu-item" href="/pydrake/index.html">Python</a> |
| 61 | + </div> |
| 62 | + </li> |
| 63 | + <li class="site-menu-item site-menu-item-main">Resources |
| 64 | + <div class="sub"> |
| 65 | + <a class="site-menu-item" href="/getting_help.html">Getting Help</a> |
| 66 | + <a class="site-menu-item" href="https://deepnote.com/workspace/Drake-0b3b2c53-a7ad-441b-80f8-bf8350752305/project/Tutorials-2b4fc509-aef2-417d-a40d-6071dfed9199/%2Findex.ipynb">Tutorials</a> |
| 67 | + <a class="site-menu-item" href="/python_bindings.html">Python Bindings</a> |
| 68 | + <a class="site-menu-item" href="/developers.html">For Developers</a> |
| 69 | + <a class="site-menu-item" href="/credits.html">Credits</a> |
| 70 | + </div> |
| 71 | + </li> |
| 72 | + <li class="github-link"> |
| 73 | + <a class="site-menu-item" href="https://github.com/RobotLocomotion/drake">GitHub <img src="/third_party/images/GitHub-Mark-Light-64px.png"></a> |
| 74 | + </li> |
| 75 | + </ul> |
| 76 | + </nav> |
| 77 | + </div> |
| 78 | +</header> |
| 79 | +<div id="titlearea"> |
| 80 | +<table cellspacing="0" cellpadding="0"> |
| 81 | + <tbody> |
| 82 | + <tr style="height: 56px;"> |
| 83 | + <td id="projectalign" style="padding-left: 0.5em;"> |
| 84 | + <div id="projectname">Drake |
| 85 | + </div> |
| 86 | + </td> |
| 87 | + </tr> |
| 88 | + </tbody> |
| 89 | +</table> |
| 90 | +<div class="title-banner"> |
| 91 | + <div class="title-banner__title"> |
| 92 | + Drake C++ Documentation |
| 93 | + </div> |
| 94 | + <div id="DDGSearch"> |
| 95 | + <form id="search_form_cpp" class="wy_form" action="https://google.com/search" method="get"> |
| 96 | + <input type="text" name="q" placeholder="Search C++ API only…"> |
| 97 | + <input type="hidden" name="q" value="site:drake.mit.edu/doxygen_cxx"> |
| 98 | + </form> |
| 99 | + <form id="search_form" class="wy_form" action="https://google.com/search" method="get"> |
| 100 | + <input type="text" name="q" placeholder="Search all of Drake…"> |
| 101 | + <input type="hidden" name="q" value="site:drake.mit.edu OR site:underactuated.csail.mit.edu OR site:manipulation.csail.mit.edu"> |
| 102 | + </form> |
| 103 | + </div> |
| 104 | + <div id="MSearchBoxContainer"> |
| 105 | + <div id="MSearchBox" class="MSearchBoxInactive"> |
| 106 | + <span class="left"> |
| 107 | + <img id="MSearchSelect" src="search/mag_sel.png" |
| 108 | + onmouseover="return searchBox.OnSearchSelectShow()" |
| 109 | + onmouseout="return searchBox.OnSearchSelectHide()" |
| 110 | + alt=""/> |
| 111 | + <input type="text" id="MSearchField" value="Search" accesskey="S" |
| 112 | + onfocus="searchBox.OnSearchFieldFocus(true)" |
| 113 | + onblur="searchBox.OnSearchFieldFocus(false)" |
| 114 | + onkeyup="searchBox.OnSearchFieldChange(event)"/> |
| 115 | + </span><span class="right"> |
| 116 | + <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> |
| 117 | + </span> |
| 118 | + </div> |
| 119 | + </div> |
| 120 | +</div> |
| 121 | +</div> |
| 122 | +<!-- end header part --> |
| 123 | +<!-- Generated by Doxygen 1.8.15 --> |
| 124 | +<script type="text/javascript"> |
| 125 | +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| 126 | +var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| 127 | +/* @license-end */ |
| 128 | +</script> |
| 129 | +</div><!-- top --> |
| 130 | +<div id="side-nav" class="ui-resizable side-nav-resizable"> |
| 131 | + <div id="nav-tree"> |
| 132 | + <div id="nav-tree-contents"> |
| 133 | + <div id="nav-sync" class="sync"></div> |
| 134 | + </div> |
| 135 | + </div> |
| 136 | + <div id="splitbar" style="-moz-user-select:none;" |
| 137 | + class="ui-resizable-handle"> |
| 138 | + </div> |
| 139 | +</div> |
| 140 | +<script type="text/javascript"> |
| 141 | +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| 142 | +$(document).ready(function(){initNavTree('check__gradient__sparsity__pattern_8h.html','');}); |
| 143 | +/* @license-end */ |
| 144 | +</script> |
| 145 | +<div id="doc-content"> |
| 146 | +<!-- window showing the filter options --> |
| 147 | +<div id="MSearchSelectWindow" |
| 148 | + onmouseover="return searchBox.OnSearchSelectShow()" |
| 149 | + onmouseout="return searchBox.OnSearchSelectHide()" |
| 150 | + onkeydown="return searchBox.OnSearchSelectKey(event)"> |
| 151 | +</div> |
| 152 | + |
| 153 | +<!-- iframe showing the search results (closed by default) --> |
| 154 | +<div id="MSearchResultsWindow"> |
| 155 | +<iframe src="javascript:void(0)" frameborder="0" |
| 156 | + name="MSearchResults" id="MSearchResults"> |
| 157 | +</iframe> |
| 158 | +</div> |
| 159 | + |
| 160 | +<div class="header"> |
| 161 | + <div class="summary"> |
| 162 | +<a href="#namespaces">Namespaces</a> | |
| 163 | +<a href="#func-members">Functions</a> </div> |
| 164 | + <div class="headertitle"> |
| 165 | +<div class="title">check_gradient_sparsity_pattern.h File Reference</div> </div> |
| 166 | +</div><!--header--> |
| 167 | +<div class="contents"> |
| 168 | +<div class="textblock"><code>#include <Eigen/Dense></code><br /> |
| 169 | +<code>#include "<a class="el" href="common_2autodiff_8h.html">drake/common/autodiff.h</a>"</code><br /> |
| 170 | +<code>#include "<a class="el" href="evaluator__base_8h.html">drake/solvers/evaluator_base.h</a>"</code><br /> |
| 171 | +</div><div class="textblock"><div class="dynheader"> |
| 172 | +Include dependency graph for check_gradient_sparsity_pattern.h:</div> |
| 173 | +<div class="dyncontent"> |
| 174 | +<div class="center"><div class="zoom"><iframe scrolling="no" frameborder="0" src="check__gradient__sparsity__pattern_8h__incl.svg" width="100%" height="600"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div> |
| 175 | +</div> |
| 176 | +</div> |
| 177 | +</div><table class="memberdecls"> |
| 178 | +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a> |
| 179 | +Namespaces</h2></td></tr> |
| 180 | +<tr class="memitem:namespacedrake"><td class="memItemLeft" align="right" valign="top">  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacedrake.html">drake</a></td></tr> |
| 181 | +<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> |
| 182 | +<tr class="memitem:namespacedrake_1_1solvers"><td class="memItemLeft" align="right" valign="top">  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacedrake_1_1solvers.html">drake::solvers</a></td></tr> |
| 183 | +<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> |
| 184 | +<tr class="memitem:namespacedrake_1_1solvers_1_1test"><td class="memItemLeft" align="right" valign="top">  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacedrake_1_1solvers_1_1test.html">drake::solvers::test</a></td></tr> |
| 185 | +<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> |
| 186 | +</table><table class="memberdecls"> |
| 187 | +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> |
| 188 | +Functions</h2></td></tr> |
| 189 | +<tr class="memitem:a9a4e46efff65f77fa1b13f39177a8396"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacedrake_1_1solvers_1_1test.html#a9a4e46efff65f77fa1b13f39177a8396">CheckGradientSparsityPattern</a> (const EvaluatorBase &evaluator, const AutoDiffVecXd &x_ad, bool strict=false)</td></tr> |
| 190 | +<tr class="memdesc:a9a4e46efff65f77fa1b13f39177a8396"><td class="mdescLeft"> </td><td class="mdescRight">Checks the gradient sparsity pattern, by evaluating <code>evaluator</code> at <code>x_ad</code>, and compare whether the gradient matches with evaluator.gradient_sparsity_pattern(). <a href="namespacedrake_1_1solvers_1_1test.html#a9a4e46efff65f77fa1b13f39177a8396">More...</a><br /></td></tr> |
| 191 | +<tr class="separator:a9a4e46efff65f77fa1b13f39177a8396"><td class="memSeparator" colspan="2"> </td></tr> |
| 192 | +</table> |
| 193 | +</div><!-- contents --> |
| 194 | +</div><!-- doc-content --> |
| 195 | +<!-- footer --> |
| 196 | +<div class="navpath"> |
| 197 | + <ul> |
| 198 | + <li class="navelem"><a class="el" href="dir_f1666844dc41ec91c14125b680b7be1b.html">drake</a></li><li class="navelem"><a class="el" href="dir_c86b501450b8b8b59405c286cb030cc3.html">solvers</a></li><li class="navelem"><a class="el" href="dir_3e1bf9ce46085c0e3ff6de174f1555d7.html">test_utilities</a></li><li class="navelem"><a class="el" href="check__gradient__sparsity__pattern_8h.html">check_gradient_sparsity_pattern.h</a></li> |
| 199 | + </ul> |
| 200 | +</div> |
| 201 | +<footer id="nav-path", class="site-footer padding"> |
| 202 | + <div class="contain"> |
| 203 | + <a href="/" class="drake-logo"> |
| 204 | + <img src="/images/drake-logo.svg"/> |
| 205 | + </a> |
| 206 | + <div class="footer-menu"> |
| 207 | + <ul> |
| 208 | + <li> |
| 209 | + <a href="/doxygen_cxx/index.html" class="site-menu-item">C++</a> |
| 210 | + </li> |
| 211 | + <li> |
| 212 | + <a href="/pydrake/index.html" class="site-menu-item">Python</a> |
| 213 | + </li> |
| 214 | + <li class="github-link"> |
| 215 | + <a href="https://github.com/RobotLocomotion/drake" class="site-menu-item">GitHub <img src="/third_party/images/GitHub-Mark-64px.png"/></a> |
| 216 | + </li> |
| 217 | + </ul> |
| 218 | + </div> |
| 219 | + </div> |
| 220 | +</footer> |
| 221 | +<script type="text/javascript"> |
| 222 | +searchBox.searchLabel = 'Go to name…'; |
| 223 | +searchBox.DOMSearchField().value = searchBox.searchLabel; |
| 224 | +</script> |
| 225 | +</body> |
| 226 | +</html> |
0 commit comments