<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>The MRPT project: SparseUtil.h Source File</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<div align="left"><a href="http://www.mrpt.org/">Main MRPT website</a> > <b>C++ reference</b> </div>
<div align="right">
<a href="index.html"><img border="0" src="mrpt_logo.png" alt="MRPT logo"></a>
</div>
<!-- Generated by Doxygen 1.7.2 -->
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "search",false,'Search');
--></script>
<div class="navigation" id="top">
<div class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li id="searchli">
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<form id="FSearchBox" action="search.php" method="get">
<img id="MSearchSelect" src="search/mag.png" alt=""/>
<input type="text" id="MSearchField" name="query" value="Search" size="20" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"/>
</form>
</span><span class="right"></span>
</div>
</li>
</ul>
</div>
<div class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul>
</div>
<div class="header">
<div class="headertitle">
<h1>SparseUtil.h</h1> </div>
</div>
<div class="contents">
<a href="_sparse_util_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">// This file is part of Eigen, a lightweight C++ template library</span>
<a name="l00002"></a>00002 <span class="comment">// for linear algebra.</span>
<a name="l00003"></a>00003 <span class="comment">//</span>
<a name="l00004"></a>00004 <span class="comment">// Copyright (C) 2008 Gael Guennebaud <gael.guennebaud@inria.fr></span>
<a name="l00005"></a>00005 <span class="comment">//</span>
<a name="l00006"></a>00006 <span class="comment">// Eigen is free software; you can redistribute it and/or</span>
<a name="l00007"></a>00007 <span class="comment">// modify it under the terms of the GNU Lesser General Public</span>
<a name="l00008"></a>00008 <span class="comment">// License as published by the Free Software Foundation; either</span>
<a name="l00009"></a>00009 <span class="comment">// version 3 of the License, or (at your option) any later version.</span>
<a name="l00010"></a>00010 <span class="comment">//</span>
<a name="l00011"></a>00011 <span class="comment">// Alternatively, you can redistribute it and/or</span>
<a name="l00012"></a>00012 <span class="comment">// modify it under the terms of the GNU General Public License as</span>
<a name="l00013"></a>00013 <span class="comment">// published by the Free Software Foundation; either version 2 of</span>
<a name="l00014"></a>00014 <span class="comment">// the License, or (at your option) any later version.</span>
<a name="l00015"></a>00015 <span class="comment">//</span>
<a name="l00016"></a>00016 <span class="comment">// Eigen is distributed in the hope that it will be useful, but WITHOUT ANY</span>
<a name="l00017"></a>00017 <span class="comment">// WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS</span>
<a name="l00018"></a>00018 <span class="comment">// FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License or the</span>
<a name="l00019"></a>00019 <span class="comment">// GNU General Public License for more details.</span>
<a name="l00020"></a>00020 <span class="comment">//</span>
<a name="l00021"></a>00021 <span class="comment">// You should have received a copy of the GNU Lesser General Public</span>
<a name="l00022"></a>00022 <span class="comment">// License and a copy of the GNU General Public License along with</span>
<a name="l00023"></a>00023 <span class="comment">// Eigen. If not, see <http://www.gnu.org/licenses/>.</span>
<a name="l00024"></a>00024
<a name="l00025"></a>00025 <span class="preprocessor">#ifndef EIGEN_SPARSEUTIL_H</span>
<a name="l00026"></a>00026 <span class="preprocessor"></span><span class="preprocessor">#define EIGEN_SPARSEUTIL_H</span>
<a name="l00027"></a>00027 <span class="preprocessor"></span>
<a name="l00028"></a>00028 <span class="preprocessor">#ifdef NDEBUG</span>
<a name="l00029"></a>00029 <span class="preprocessor"></span><span class="preprocessor">#define EIGEN_DBG_SPARSE(X)</span>
<a name="l00030"></a>00030 <span class="preprocessor"></span><span class="preprocessor">#else</span>
<a name="l00031"></a><a class="code" href="_sparse_util_8h.html#a1a0ccbbfda8877d89c7e6be74ad8f078">00031</a> <span class="preprocessor"></span><span class="preprocessor">#define EIGEN_DBG_SPARSE(X) X</span>
<a name="l00032"></a>00032 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00033"></a>00033 <span class="preprocessor"></span>
<a name="l00034"></a><a class="code" href="_sparse_util_8h.html#aa49d12e32c9621b2130abc38a317e7b8">00034</a> <span class="preprocessor">#define EIGEN_SPARSE_INHERIT_ASSIGNMENT_OPERATOR(Derived, Op) \</span>
<a name="l00035"></a>00035 <span class="preprocessor">template<typename OtherDerived> \</span>
<a name="l00036"></a>00036 <span class="preprocessor">EIGEN_STRONG_INLINE Derived& operator Op(const Eigen::SparseMatrixBase<OtherDerived>& other) \</span>
<a name="l00037"></a>00037 <span class="preprocessor">{ \</span>
<a name="l00038"></a>00038 <span class="preprocessor"> return Base::operator Op(other.derived()); \</span>
<a name="l00039"></a>00039 <span class="preprocessor">} \</span>
<a name="l00040"></a>00040 <span class="preprocessor">EIGEN_STRONG_INLINE Derived& operator Op(const Derived& other) \</span>
<a name="l00041"></a>00041 <span class="preprocessor">{ \</span>
<a name="l00042"></a>00042 <span class="preprocessor"> return Base::operator Op(other); \</span>
<a name="l00043"></a>00043 <span class="preprocessor">}</span>
<a name="l00044"></a>00044 <span class="preprocessor"></span>
<a name="l00045"></a><a class="code" href="_sparse_util_8h.html#a2b4cbb64e27850f0151b228f9f137802">00045</a> <span class="preprocessor">#define EIGEN_SPARSE_INHERIT_SCALAR_ASSIGNMENT_OPERATOR(Derived, Op) \</span>
<a name="l00046"></a>00046 <span class="preprocessor">template<typename Other> \</span>
<a name="l00047"></a>00047 <span class="preprocessor">EIGEN_STRONG_INLINE Derived& operator Op(const Other& scalar) \</span>
<a name="l00048"></a>00048 <span class="preprocessor">{ \</span>
<a name="l00049"></a>00049 <span class="preprocessor"> return Base::operator Op(scalar); \</span>
<a name="l00050"></a>00050 <span class="preprocessor">}</span>
<a name="l00051"></a>00051 <span class="preprocessor"></span>
<a name="l00052"></a><a class="code" href="_sparse_util_8h.html#aff82ec6051d119d6c343cec1ed452f63">00052</a> <span class="preprocessor">#define EIGEN_SPARSE_INHERIT_ASSIGNMENT_OPERATORS(Derived) \</span>
<a name="l00053"></a>00053 <span class="preprocessor">EIGEN_SPARSE_INHERIT_ASSIGNMENT_OPERATOR(Derived, =) \</span>
<a name="l00054"></a>00054 <span class="preprocessor">EIGEN_SPARSE_INHERIT_ASSIGNMENT_OPERATOR(Derived, +=) \</span>
<a name="l00055"></a>00055 <span class="preprocessor">EIGEN_SPARSE_INHERIT_ASSIGNMENT_OPERATOR(Derived, -=) \</span>
<a name="l00056"></a>00056 <span class="preprocessor">EIGEN_SPARSE_INHERIT_SCALAR_ASSIGNMENT_OPERATOR(Derived, *=) \</span>
<a name="l00057"></a>00057 <span class="preprocessor">EIGEN_SPARSE_INHERIT_SCALAR_ASSIGNMENT_OPERATOR(Derived, /=)</span>
<a name="l00058"></a>00058 <span class="preprocessor"></span>
<a name="l00059"></a><a class="code" href="_sparse_util_8h.html#aa7f85c58bedc55b30189bba57e66c5dd">00059</a> <span class="preprocessor">#define _EIGEN_SPARSE_PUBLIC_INTERFACE(Derived, BaseClass) \</span>
<a name="l00060"></a>00060 <span class="preprocessor"> typedef BaseClass Base; \</span>
<a name="l00061"></a>00061 <span class="preprocessor"> typedef typename Eigen::internal::traits<Derived>::Scalar Scalar; \</span>
<a name="l00062"></a>00062 <span class="preprocessor"> typedef typename Eigen::NumTraits<Scalar>::Real RealScalar; \</span>
<a name="l00063"></a>00063 <span class="preprocessor"> typedef typename Eigen::internal::nested<Derived>::type Nested; \</span>
<a name="l00064"></a>00064 <span class="preprocessor"> typedef typename Eigen::internal::traits<Derived>::StorageKind StorageKind; \</span>
<a name="l00065"></a>00065 <span class="preprocessor"> typedef typename Eigen::internal::traits<Derived>::Index Index; \</span>
<a name="l00066"></a>00066 <span class="preprocessor"> enum { RowsAtCompileTime = Eigen::internal::traits<Derived>::RowsAtCompileTime, \</span>
<a name="l00067"></a>00067 <span class="preprocessor"> ColsAtCompileTime = Eigen::internal::traits<Derived>::ColsAtCompileTime, \</span>
<a name="l00068"></a>00068 <span class="preprocessor"> Flags = Eigen::internal::traits<Derived>::Flags, \</span>
<a name="l00069"></a>00069 <span class="preprocessor"> CoeffReadCost = Eigen::internal::traits<Derived>::CoeffReadCost, \</span>
<a name="l00070"></a>00070 <span class="preprocessor"> SizeAtCompileTime = Base::SizeAtCompileTime, \</span>
<a name="l00071"></a>00071 <span class="preprocessor"> IsVectorAtCompileTime = Base::IsVectorAtCompileTime }; \</span>
<a name="l00072"></a>00072 <span class="preprocessor"> using Base::derived; \</span>
<a name="l00073"></a>00073 <span class="preprocessor"> using Base::const_cast_derived;</span>
<a name="l00074"></a>00074 <span class="preprocessor"></span>
<a name="l00075"></a><a class="code" href="_sparse_util_8h.html#a936f4ca73ea9a70e080520f8c7c4fa03">00075</a> <span class="preprocessor">#define EIGEN_SPARSE_PUBLIC_INTERFACE(Derived) \</span>
<a name="l00076"></a>00076 <span class="preprocessor"> _EIGEN_SPARSE_PUBLIC_INTERFACE(Derived, Eigen::SparseMatrixBase<Derived>)</span>
<a name="l00077"></a>00077 <span class="preprocessor"></span>
<a name="l00078"></a><a class="code" href="_sparse_util_8h.html#a2bb63df0089daa5f133e4e003d188dd3">00078</a> <span class="keyword">const</span> <span class="keywordtype">int</span> <a class="code" href="_sparse_util_8h.html#a2bb63df0089daa5f133e4e003d188dd3">CoherentAccessPattern</a> = 0x1;
<a name="l00079"></a><a class="code" href="_sparse_util_8h.html#a261fdd53c867f5f29679505ce6d1867c">00079</a> <span class="keyword">const</span> <span class="keywordtype">int</span> <a class="code" href="_sparse_util_8h.html#a261fdd53c867f5f29679505ce6d1867c">InnerRandomAccessPattern</a> = 0x2 | <a class="code" href="_sparse_util_8h.html#a2bb63df0089daa5f133e4e003d188dd3">CoherentAccessPattern</a>;
<a name="l00080"></a><a class="code" href="_sparse_util_8h.html#a7e40e29059372957eb7251f6f7241bfb">00080</a> <span class="keyword">const</span> <span class="keywordtype">int</span> <a class="code" href="_sparse_util_8h.html#a7e40e29059372957eb7251f6f7241bfb">OuterRandomAccessPattern</a> = 0x4 | <a class="code" href="_sparse_util_8h.html#a2bb63df0089daa5f133e4e003d188dd3">CoherentAccessPattern</a>;
<a name="l00081"></a><a class="code" href="_sparse_util_8h.html#addbbc98164351b70df50a839d0f76e23">00081</a> <span class="keyword">const</span> <span class="keywordtype">int</span> <a class="code" href="_sparse_util_8h.html#addbbc98164351b70df50a839d0f76e23">RandomAccessPattern</a> = 0x8 | <a class="code" href="_sparse_util_8h.html#a7e40e29059372957eb7251f6f7241bfb">OuterRandomAccessPattern</a> | <a class="code" href="_sparse_util_8h.html#a261fdd53c867f5f29679505ce6d1867c">InnerRandomAccessPattern</a>;
<a name="l00082"></a>00082
<a name="l00083"></a>00083 <span class="keyword">template</span><<span class="keyword">typename</span> Derived> <span class="keyword">class </span><a class="code" href="class_sparse_matrix_base.html" title="Base class of any sparse matrices or sparse expressions.">SparseMatrixBase</a>;
<a name="l00084"></a>00084 <span class="keyword">template</span><<span class="keyword">typename</span> _Scalar, <span class="keywordtype">int</span> _Flags = 0, <span class="keyword">typename</span> _Index = <span class="keywordtype">int</span>> <span class="keyword">class </span><a class="code" href="class_sparse_matrix.html" title="The main sparse matrix class.">SparseMatrix</a>;
<a name="l00085"></a>00085 <span class="keyword">template</span><<span class="keyword">typename</span> _Scalar, <span class="keywordtype">int</span> _Flags = 0, <span class="keyword">typename</span> _Index = <span class="keywordtype">int</span>> <span class="keyword">class </span><a class="code" href="class_dynamic_sparse_matrix.html" title="A sparse matrix class designed for matrix assembly purpose.">DynamicSparseMatrix</a>;
<a name="l00086"></a>00086 <span class="keyword">template</span><<span class="keyword">typename</span> _Scalar, <span class="keywordtype">int</span> _Flags = 0, <span class="keyword">typename</span> _Index = <span class="keywordtype">int</span>> <span class="keyword">class </span><a class="code" href="class_sparse_vector.html" title="a sparse vector class">SparseVector</a>;
<a name="l00087"></a>00087 <span class="keyword">template</span><<span class="keyword">typename</span> _Scalar, <span class="keywordtype">int</span> _Flags = 0, <span class="keyword">typename</span> _Index = <span class="keywordtype">int</span>> <span class="keyword">class </span><a class="code" href="class_mapped_sparse_matrix.html" title="Sparse matrix.">MappedSparseMatrix</a>;
<a name="l00088"></a>00088
<a name="l00089"></a>00089 <span class="keyword">template</span><<span class="keyword">typename</span> MatrixType, <span class="keywordtype">int</span> Size> <span class="keyword">class </span><a class="code" href="class_sparse_inner_vector_set.html">SparseInnerVectorSet</a>;
<a name="l00090"></a>00090 <span class="keyword">template</span><<span class="keyword">typename</span> MatrixType, <span class="keywordtype">int</span> Mode> <span class="keyword">class </span><a class="code" href="class_sparse_triangular_view.html">SparseTriangularView</a>;
<a name="l00091"></a>00091 <span class="keyword">template</span><<span class="keyword">typename</span> MatrixType, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> UpLo> <span class="keyword">class </span><a class="code" href="class_sparse_self_adjoint_view.html" title="Pseudo expression to manipulate a triangular sparse matrix as a selfadjoint matrix.">SparseSelfAdjointView</a>;
<a name="l00092"></a>00092 <span class="keyword">template</span><<span class="keyword">typename</span> Lhs, <span class="keyword">typename</span> Rhs> <span class="keyword">class </span><a class="code" href="class_sparse_diagonal_product.html">SparseDiagonalProduct</a>;
<a name="l00093"></a>00093 <span class="keyword">template</span><<span class="keyword">typename</span> MatrixType> <span class="keyword">class </span><a class="code" href="class_sparse_view.html">SparseView</a>;
<a name="l00094"></a>00094
<a name="l00095"></a>00095 <span class="keyword">template</span><<span class="keyword">typename</span> Lhs, <span class="keyword">typename</span> Rhs> <span class="keyword">class </span><a class="code" href="class_sparse_sparse_product.html">SparseSparseProduct</a>;
<a name="l00096"></a>00096 <span class="keyword">template</span><<span class="keyword">typename</span> Lhs, <span class="keyword">typename</span> Rhs> <span class="keyword">class </span><a class="code" href="class_sparse_time_dense_product.html">SparseTimeDenseProduct</a>;
<a name="l00097"></a>00097 <span class="keyword">template</span><<span class="keyword">typename</span> Lhs, <span class="keyword">typename</span> Rhs> <span class="keyword">class </span><a class="code" href="class_dense_time_sparse_product.html">DenseTimeSparseProduct</a>;
<a name="l00098"></a>00098 <span class="keyword">template</span><<span class="keyword">typename</span> Lhs, <span class="keyword">typename</span> Rhs, <span class="keywordtype">bool</span> Transpose> <span class="keyword">class </span><a class="code" href="class_sparse_dense_outer_product.html">SparseDenseOuterProduct</a>;
<a name="l00099"></a>00099
<a name="l00100"></a>00100 <span class="keyword">template</span><<span class="keyword">typename</span> Lhs, <span class="keyword">typename</span> Rhs> <span class="keyword">struct </span><a class="code" href="struct_sparse_sparse_product_return_type.html">SparseSparseProductReturnType</a>;
<a name="l00101"></a>00101 template<typename Lhs, typename Rhs, int InnerSize = internal::traits<Lhs>::ColsAtCompileTime> <span class="keyword">struct </span><a class="code" href="struct_dense_sparse_product_return_type.html">DenseSparseProductReturnType</a>;
<a name="l00102"></a>00102 template<typename Lhs, typename Rhs, int InnerSize = internal::traits<Lhs>::ColsAtCompileTime> <span class="keyword">struct </span><a class="code" href="struct_sparse_dense_product_return_type.html">SparseDenseProductReturnType</a>;
<a name="l00103"></a>00103
<a name="l00104"></a>00104 <span class="keyword">namespace </span>internal {
<a name="l00105"></a>00105
<a name="l00106"></a><a class="code" href="structinternal_1_1eval_3_01_t_00_01_sparse_01_4.html">00106</a> <span class="keyword">template</span><<span class="keyword">typename</span> T> <span class="keyword">struct </span>eval<T,Sparse>
<a name="l00107"></a>00107 {
<a name="l00108"></a><a class="code" href="structinternal_1_1eval_3_01_t_00_01_sparse_01_4.html#acd753596eb7a6c8facf96cc2ec74576a">00108</a> <span class="keyword">typedef</span> <span class="keyword">typename</span> traits<T>::Scalar <a class="code" href="structinternal_1_1eval_3_01_t_00_01_sparse_01_4.html#acd753596eb7a6c8facf96cc2ec74576a">_Scalar</a>;
<a name="l00109"></a>00109 <span class="keyword">enum</span> {
<a name="l00110"></a><a class="code" href="structinternal_1_1eval_3_01_t_00_01_sparse_01_4.html#a9b7a9c0ad4fba29e3b1a59c4a5769c38a551daf423f355d6edf0aaea024939a44">00110</a> _Flags = traits<T>::Flags
<a name="l00111"></a>00111 };
<a name="l00112"></a>00112
<a name="l00113"></a>00113 <span class="keyword">public</span>:
<a name="l00114"></a><a class="code" href="structinternal_1_1eval_3_01_t_00_01_sparse_01_4.html#ab88813c6afe3654d28259f20eac0ed76">00114</a> <span class="keyword">typedef</span> <a class="code" href="class_sparse_matrix.html" title="The main sparse matrix class.">SparseMatrix<_Scalar, _Flags></a> <a class="code" href="structinternal_1_1eval_3_01_t_00_01_sparse_01_4.html#ab88813c6afe3654d28259f20eac0ed76">type</a>;
<a name="l00115"></a>00115 };
<a name="l00116"></a>00116
<a name="l00117"></a><a class="code" href="structinternal_1_1plain__matrix__type_3_01_t_00_01_sparse_01_4.html">00117</a> <span class="keyword">template</span><<span class="keyword">typename</span> T> <span class="keyword">struct </span>plain_matrix_type<T,Sparse>
<a name="l00118"></a>00118 {
<a name="l00119"></a><a class="code" href="structinternal_1_1plain__matrix__type_3_01_t_00_01_sparse_01_4.html#a03d2ff70c955c35fd6d45ab8cbdf5c65">00119</a> <span class="keyword">typedef</span> <span class="keyword">typename</span> traits<T>::Scalar <a class="code" href="structinternal_1_1plain__matrix__type_3_01_t_00_01_sparse_01_4.html#a03d2ff70c955c35fd6d45ab8cbdf5c65">_Scalar</a>;
<a name="l00120"></a>00120 <span class="keyword">enum</span> {
<a name="l00121"></a><a class="code" href="structinternal_1_1plain__matrix__type_3_01_t_00_01_sparse_01_4.html#aa9650828f988e05874d17192782302aeab53d99a52173985ec935a8b61ceec4fc">00121</a> _Flags = traits<T>::Flags
<a name="l00122"></a>00122 };
<a name="l00123"></a>00123
<a name="l00124"></a>00124 <span class="keyword">public</span>:
<a name="l00125"></a><a class="code" href="structinternal_1_1plain__matrix__type_3_01_t_00_01_sparse_01_4.html#a9b4fa0eb641b00bf9dbba6987744e3ca">00125</a> <span class="keyword">typedef</span> <a class="code" href="class_sparse_matrix.html" title="The main sparse matrix class.">SparseMatrix<_Scalar, _Flags></a> <a class="code" href="structinternal_1_1plain__matrix__type_3_01_t_00_01_sparse_01_4.html#a9b4fa0eb641b00bf9dbba6987744e3ca">type</a>;
<a name="l00126"></a>00126 };
<a name="l00127"></a>00127
<a name="l00128"></a>00128 } <span class="comment">// end namespace internal</span>
<a name="l00129"></a>00129
<a name="l00130"></a>00130 <span class="preprocessor">#endif // EIGEN_SPARSEUTIL_H</span>
</pre></div></div>
</div>
<br><hr><br> <table border="0" width="100%"> <tr> <td> Page generated by <a href="http://www.doxygen.org" target="_blank">Doxygen 1.7.2</a> for MRPT 0.9.4 SVN: at Mon Jan 10 22:30:30 UTC 2011</td><td></td> <td width="100"> </td> <td width="150"> </td></tr> </table> </body></html>
