<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.5"/> <title>Eigen-unsupported: AutoDiffScalar< _DerType > Class Template Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="navtree.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="resize.js"></script> <script type="text/javascript" src="navtree.js"></script> <script type="text/javascript"> $(document).ready(initResizable); $(window).load(resizeHeight); </script> <link href="search/search.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="search/search.js"></script> <script type="text/javascript"> $(document).ready(function() { searchBox.OnSelectItem(0); }); </script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> <link href="eigendoxy.css" rel="stylesheet" type="text/css"> <!-- --> <script type="text/javascript" src="eigen_navtree_hacks.js"></script> <!-- <script type="text/javascript"> --> <!-- </script> --> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <!-- <a name="top"></a> --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td id="projectlogo"><img alt="Logo" src="Eigen_Silly_Professor_64x64.png"/></td> <td style="padding-left: 0.5em;"> <div id="projectname"><a href="http://eigen.tuxfamily.org">Eigen-unsupported</a>  <span id="projectnumber">3.2.0</span> </div> </td> <td> <div id="MSearchBox" class="MSearchBoxInactive"> <span class="left"> <img id="MSearchSelect" src="search/mag_sel.png" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" alt=""/> <input type="text" id="MSearchField" value="Search" accesskey="S" onfocus="searchBox.OnSearchFieldFocus(true)" onblur="searchBox.OnSearchFieldFocus(false)" onkeyup="searchBox.OnSearchFieldChange(event)"/> </span><span class="right"> <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> </span> </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.5 --> <script type="text/javascript"> var searchBox = new SearchBox("searchBox", "search",false,'Search'); </script> </div><!-- top --> <div id="side-nav" class="ui-resizable side-nav-resizable"> <div id="nav-tree"> <div id="nav-tree-contents"> <div id="nav-sync" class="sync"></div> </div> </div> <div id="splitbar" style="-moz-user-select:none;" class="ui-resizable-handle"> </div> </div> <script type="text/javascript"> $(document).ready(function(){initNavTree('classEigen_1_1AutoDiffScalar.html','');}); </script> <div id="doc-content"> <!-- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Pages</a></div> <!-- iframe showing the search results (closed by default) --> <div id="MSearchResultsWindow"> <iframe src="javascript:void(0)" frameborder="0" name="MSearchResults" id="MSearchResults"> </iframe> </div> <div class="header"> <div class="summary"> <a href="classEigen_1_1AutoDiffScalar-members.html">List of all members</a> | <a href="#pub-methods">Public Member Functions</a> </div> <div class="headertitle"> <div class="title">AutoDiffScalar< _DerType > Class Template Reference</div> </div> </div><!--header--> <div class="contents"> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><h3>template<typename _DerType><br/> class Eigen::AutoDiffScalar< _DerType ></h3> <p>A scalar type replacement with automatic differentation capability. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">_DerType</td><td>the vector type used to store/represent the derivatives. The base scalar type as well as the number of derivatives to compute are determined from this type. Typical choices include, e.g., <code>Vector4f</code> for 4 derivatives, or <code>VectorXf</code> if the number of derivatives is not known at compile time, and/or, the number of derivatives is large. Note that _DerType can also be a reference (e.g., <code>VectorXf&</code>) to wrap a existing vector into an <a class="el" href="classEigen_1_1AutoDiffScalar.html" title="A scalar type replacement with automatic differentation capability. ">AutoDiffScalar</a>. Finally, _DerType can also be any <a class="el" href="namespaceEigen.html" title="iterative scaling algorithm to equilibrate rows and column norms in matrices ">Eigen</a> compatible expression.</td></tr> </table> </dd> </dl> <p>This class represents a scalar value while tracking its respective derivatives using <a class="el" href="namespaceEigen.html" title="iterative scaling algorithm to equilibrate rows and column norms in matrices ">Eigen</a>'s expression template mechanism.</p> <p>It supports the following list of global math function:</p> <ul> <li>std::abs, std::sqrt, std::pow, std::exp, std::log, std::sin, std::cos,</li> <li>internal::abs, internal::sqrt, numext::pow, internal::exp, internal::log, internal::sin, internal::cos,</li> <li>internal::conj, internal::real, internal::imag, numext::abs2.</li> </ul> <p><a class="el" href="classEigen_1_1AutoDiffScalar.html" title="A scalar type replacement with automatic differentation capability. ">AutoDiffScalar</a> can be used as the scalar type of an Eigen::Matrix object. However, in that case, the expression template mechanism only occurs at the top Matrix level, while derivatives are computed right away. </p> </div> <p>Inherits auto_diff_special_op< _DerType,!internal::is_same< internal::traits< internal::remove_all< _DerType >::type >::Scalar, NumTraits< internal::traits< internal::remove_all< _DerType >::type >::Scalar >::Real >::value >.</p> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr class="memitem:a9709325db07d9ce76afddb01aa9beddc"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classEigen_1_1AutoDiffScalar.html#a9709325db07d9ce76afddb01aa9beddc">AutoDiffScalar</a> ()</td></tr> <tr class="separator:a9709325db07d9ce76afddb01aa9beddc"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a21b42dd5bb572f0dbbb6c84fa39cefe1"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classEigen_1_1AutoDiffScalar.html#a21b42dd5bb572f0dbbb6c84fa39cefe1">AutoDiffScalar</a> (const Scalar &value, int nbDer, int derNumber)</td></tr> <tr class="separator:a21b42dd5bb572f0dbbb6c84fa39cefe1"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a2e2b93d0821398f0d0900198a94364de"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classEigen_1_1AutoDiffScalar.html#a2e2b93d0821398f0d0900198a94364de">AutoDiffScalar</a> (const Real &value)</td></tr> <tr class="separator:a2e2b93d0821398f0d0900198a94364de"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a2110c8207fcb357e6669966276dcc91b"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classEigen_1_1AutoDiffScalar.html#a2110c8207fcb357e6669966276dcc91b">AutoDiffScalar</a> (const Scalar &value, const DerType &der)</td></tr> <tr class="separator:a2110c8207fcb357e6669966276dcc91b"><td class="memSeparator" colspan="2"> </td></tr> </table> <h2 class="groupheader">Constructor & Destructor Documentation</h2> <a class="anchor" id="a9709325db07d9ce76afddb01aa9beddc"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classEigen_1_1AutoDiffScalar.html">AutoDiffScalar</a> </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Default constructor without any initialization. </p> </div> </div> <a class="anchor" id="a21b42dd5bb572f0dbbb6c84fa39cefe1"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classEigen_1_1AutoDiffScalar.html">AutoDiffScalar</a> </td> <td>(</td> <td class="paramtype">const Scalar & </td> <td class="paramname"><em>value</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>nbDer</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>derNumber</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Constructs an active scalar from its <em>value</em>, and initializes the <em>nbDer</em> derivatives such that it corresponds to the <em>derNumber</em> -th variable </p> </div> </div> <a class="anchor" id="a2e2b93d0821398f0d0900198a94364de"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classEigen_1_1AutoDiffScalar.html">AutoDiffScalar</a> </td> <td>(</td> <td class="paramtype">const Real & </td> <td class="paramname"><em>value</em></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Conversion from a scalar constant to an active scalar. The derivatives are set to zero. </p> </div> </div> <a class="anchor" id="a2110c8207fcb357e6669966276dcc91b"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classEigen_1_1AutoDiffScalar.html">AutoDiffScalar</a> </td> <td>(</td> <td class="paramtype">const Scalar & </td> <td class="paramname"><em>value</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const DerType & </td> <td class="paramname"><em>der</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Constructs an active scalar from its <em>value</em> and derivatives <em>der</em> </p> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="AutoDiffScalar_8h_source.html">AutoDiffScalar.h</a></li> </ul> </div><!-- contents --> </div><!-- doc-content --> <!-- start footer part --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> <li class="navelem"><a class="el" href="namespaceEigen.html">Eigen</a></li><li class="navelem"><a class="el" href="classEigen_1_1AutoDiffScalar.html">AutoDiffScalar</a></li> <li class="footer">Generated on Mon Oct 28 2013 11:05:27 for Eigen-unsupported by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.5 </li> </ul> </div> <!-- Piwik --> <!-- <script type="text/javascript"> var pkBaseURL = (("https:" == document.location.protocol) ? "https://stats.sylphide-consulting.com/piwik/" : "http://stats.sylphide-consulting.com/piwik/"); document.write(unescape("%3Cscript src='" + pkBaseURL + "piwik.js' type='text/javascript'%3E%3C/script%3E")); </script><script type="text/javascript"> try { var piwikTracker = Piwik.getTracker(pkBaseURL + "piwik.php", 20); piwikTracker.trackPageView(); piwikTracker.enableLinkTracking(); } catch( err ) {} </script><noscript><p><img src="http://stats.sylphide-consulting.com/piwik/piwik.php?idsite=20" style="border:0" alt="" /></p></noscript> --> <!-- End Piwik Tracking Code --> </body> </html>