<!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: MatrixFunction< MatrixType, AtomicType, IsComplex > 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_1MatrixFunction.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_1MatrixFunction-members.html">List of all members</a> |
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">MatrixFunction< MatrixType, AtomicType, IsComplex > Class Template Reference<div class="ingroups"><a class="el" href="group__MatrixFunctions__Module.html">Matrix functions module</a></div></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 MatrixType, typename AtomicType, int IsComplex = NumTraits<typename internal::traits<MatrixType>::Scalar>::IsComplex><br/>
class Eigen::MatrixFunction< MatrixType, AtomicType, IsComplex ></h3>
<p>Class for computing matrix functions. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">MatrixType</td><td>type of the argument of the matrix function, expected to be an instantiation of the Matrix class template. </td></tr>
<tr><td class="paramname">AtomicType</td><td>type for computing matrix function of atomic blocks. </td></tr>
<tr><td class="paramname">IsComplex</td><td>used internally to select correct specialization.</td></tr>
</table>
</dd>
</dl>
<p>This class implements the Schur-Parlett algorithm for computing matrix functions. The spectrum of the matrix is divided in clustered of eigenvalues that lies close together. This class delegates the computation of the matrix function on every block corresponding to these clusters to an object of type <code>AtomicType</code> and uses these results to compute the matrix function of the whole matrix. The class <code>AtomicType</code> should have a <code><a class="el" href="classEigen_1_1MatrixFunction.html#a37407499d669c7dd9af708e7dd6f9217" title="Compute the matrix function. ">compute()</a></code> member function for computing the matrix function of a block.</p>
<dl class="section see"><dt>See Also</dt><dd>class <a class="el" href="classEigen_1_1MatrixFunctionAtomic.html" title="Helper class for computing matrix functions of atomic matrices. ">MatrixFunctionAtomic</a>, class <a class="el" href="classEigen_1_1MatrixLogarithmAtomic.html" title="Helper class for computing matrix logarithm of atomic matrices. ">MatrixLogarithmAtomic</a> </dd></dl>
</div><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:a37407499d669c7dd9af708e7dd6f9217"><td class="memTemplParams" colspan="2">template<typename ResultType > </td></tr>
<tr class="memitem:a37407499d669c7dd9af708e7dd6f9217"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classEigen_1_1MatrixFunction.html#a37407499d669c7dd9af708e7dd6f9217">compute</a> (ResultType &result)</td></tr>
<tr class="memdesc:a37407499d669c7dd9af708e7dd6f9217"><td class="mdescLeft"> </td><td class="mdescRight">Compute the matrix function. <a href="#a37407499d669c7dd9af708e7dd6f9217">More...</a><br/></td></tr>
<tr class="separator:a37407499d669c7dd9af708e7dd6f9217"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abf20da56863c164e96044d60b9b8d407"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classEigen_1_1MatrixFunction.html#abf20da56863c164e96044d60b9b8d407">MatrixFunction</a> (const MatrixType &A, AtomicType &atomic)</td></tr>
<tr class="memdesc:abf20da56863c164e96044d60b9b8d407"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#abf20da56863c164e96044d60b9b8d407">More...</a><br/></td></tr>
<tr class="separator:abf20da56863c164e96044d60b9b8d407"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="abf20da56863c164e96044d60b9b8d407"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classEigen_1_1MatrixFunction.html">MatrixFunction</a> </td>
<td>(</td>
<td class="paramtype">const MatrixType & </td>
<td class="paramname"><em>A</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">AtomicType & </td>
<td class="paramname"><em>atomic</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">A</td><td>argument of matrix function, should be a square matrix. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">atomic</td><td>class for computing matrix function of atomic blocks.</td></tr>
</table>
</dd>
</dl>
<p>The class stores references to <code>A</code> and <code>atomic</code>, so they should not be changed (or destroyed) before <a class="el" href="classEigen_1_1MatrixFunction.html#a37407499d669c7dd9af708e7dd6f9217" title="Compute the matrix function. ">compute()</a> is called. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a37407499d669c7dd9af708e7dd6f9217"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void compute </td>
<td>(</td>
<td class="paramtype">ResultType & </td>
<td class="paramname"><em>result</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Compute the matrix function. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">result</td><td>the function <code>f</code> applied to <code>A</code>, as specified in the constructor.</td></tr>
</table>
</dd>
</dl>
<p>See MatrixBase::matrixFunction() for details on how this computation is implemented. </p>
<p>Referenced by <a class="el" href="classEigen_1_1MatrixLogarithmReturnValue.html#a4f4ce27ebcf7fe1e0078d20d0393c766">MatrixLogarithmReturnValue< Derived >::evalTo()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="MatrixFunction_8h_source.html">MatrixFunction.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_1MatrixFunction.html">MatrixFunction</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>
