Sophie

Sophie

distrib > Fedora > 15 > i386 > by-pkgid > 2f6559b7006594cad03af173263c219e > files > 2020

mrpt-doc-0.9.4-0.1.20110110svn2383.fc15.i686.rpm

<!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: MatrixCwiseBinaryOps.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> &gt; <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&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;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&#160;List</span></a></li>
      <li><a href="globals.html"><span>File&#160;Members</span></a></li>
    </ul>
  </div>
<div class="header">
  <div class="headertitle">
<h1>MatrixCwiseBinaryOps.h</h1>  </div>
</div>
<div class="contents">
<a href="_matrix_cwise_binary_ops_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-2009 Gael Guennebaud &lt;gael.guennebaud@inria.fr&gt;</span>
<a name="l00005"></a>00005 <span class="comment">// Copyright (C) 2006-2008 Benoit Jacob &lt;jacob.benoit.1@gmail.com&gt;</span>
<a name="l00006"></a>00006 <span class="comment">//</span>
<a name="l00007"></a>00007 <span class="comment">// Eigen is free software; you can redistribute it and/or</span>
<a name="l00008"></a>00008 <span class="comment">// modify it under the terms of the GNU Lesser General Public</span>
<a name="l00009"></a>00009 <span class="comment">// License as published by the Free Software Foundation; either</span>
<a name="l00010"></a>00010 <span class="comment">// version 3 of the License, or (at your option) any later version.</span>
<a name="l00011"></a>00011 <span class="comment">//</span>
<a name="l00012"></a>00012 <span class="comment">// Alternatively, you can redistribute it and/or</span>
<a name="l00013"></a>00013 <span class="comment">// modify it under the terms of the GNU General Public License as</span>
<a name="l00014"></a>00014 <span class="comment">// published by the Free Software Foundation; either version 2 of</span>
<a name="l00015"></a>00015 <span class="comment">// the License, or (at your option) any later version.</span>
<a name="l00016"></a>00016 <span class="comment">//</span>
<a name="l00017"></a>00017 <span class="comment">// Eigen is distributed in the hope that it will be useful, but WITHOUT ANY</span>
<a name="l00018"></a>00018 <span class="comment">// WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS</span>
<a name="l00019"></a>00019 <span class="comment">// FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License or the</span>
<a name="l00020"></a>00020 <span class="comment">// GNU General Public License for more details.</span>
<a name="l00021"></a>00021 <span class="comment">//</span>
<a name="l00022"></a>00022 <span class="comment">// You should have received a copy of the GNU Lesser General Public</span>
<a name="l00023"></a>00023 <span class="comment">// License and a copy of the GNU General Public License along with</span>
<a name="l00024"></a>00024 <span class="comment">// Eigen. If not, see &lt;http://www.gnu.org/licenses/&gt;.</span>
<a name="l00025"></a>00025 
<a name="l00026"></a>00026 <span class="comment">// This file is a base class plugin containing matrix specifics coefficient wise functions.</span>
<a name="l00027"></a>00027 <span class="comment"></span>
<a name="l00028"></a>00028 <span class="comment">/** \returns an expression of the Schur product (coefficient wise product) of *this and \a other</span>
<a name="l00029"></a>00029 <span class="comment">  *</span>
<a name="l00030"></a>00030 <span class="comment">  * Example: \include MatrixBase_cwiseProduct.cpp</span>
<a name="l00031"></a>00031 <span class="comment">  * Output: \verbinclude MatrixBase_cwiseProduct.out</span>
<a name="l00032"></a>00032 <span class="comment">  *</span>
<a name="l00033"></a>00033 <span class="comment">  * \sa class CwiseBinaryOp, cwiseAbs2</span>
<a name="l00034"></a>00034 <span class="comment">  */</span>
<a name="l00035"></a>00035 <span class="keyword">template</span>&lt;<span class="keyword">typename</span> OtherDerived&gt;
<a name="l00036"></a><a class="code" href="_matrix_cwise_binary_ops_8h.html#a4dfa855ee09e83d1e314fb97c780c4fc">00036</a> <a class="code" href="_macros_8h.html#af2b60117c00a6e75812de43bfe7db3b1">EIGEN_STRONG_INLINE</a> <span class="keyword">const</span> <a class="code" href="_macros_8h.html#a201ad90085b860e9283ee8820a719eca">EIGEN_CWISE_PRODUCT_RETURN_TYPE</a>(Derived,OtherDerived)
<a name="l00037"></a>00037 cwiseProduct(const <a class="code" href="_array_base_8h.html#a140b988ffa480af0799d873ce22898f2">EIGEN_CURRENT_STORAGE_BASE_CLASS</a>&lt;OtherDerived&gt; &amp;other)<span class="keyword"> const</span>
<a name="l00038"></a>00038 <span class="keyword"></span>{
<a name="l00039"></a>00039   <span class="keywordflow">return</span> <a class="code" href="_macros_8h.html#a201ad90085b860e9283ee8820a719eca">EIGEN_CWISE_PRODUCT_RETURN_TYPE</a>(Derived,OtherDerived)(derived(), other.derived());
<a name="l00040"></a>00040 }
<a name="l00041"></a>00041 <span class="comment"></span>
<a name="l00042"></a>00042 <span class="comment">/** \returns an expression of the coefficient-wise == operator of *this and \a other</span>
<a name="l00043"></a>00043 <span class="comment">  *</span>
<a name="l00044"></a>00044 <span class="comment">  * \warning this performs an exact comparison, which is generally a bad idea with floating-point types.</span>
<a name="l00045"></a>00045 <span class="comment">  * In order to check for equality between two vectors or matrices with floating-point coefficients, it is</span>
<a name="l00046"></a>00046 <span class="comment">  * generally a far better idea to use a fuzzy comparison as provided by isApprox() and</span>
<a name="l00047"></a>00047 <span class="comment">  * isMuchSmallerThan().</span>
<a name="l00048"></a>00048 <span class="comment">  *</span>
<a name="l00049"></a>00049 <span class="comment">  * Example: \include MatrixBase_cwiseEqual.cpp</span>
<a name="l00050"></a>00050 <span class="comment">  * Output: \verbinclude MatrixBase_cwiseEqual.out</span>
<a name="l00051"></a>00051 <span class="comment">  *</span>
<a name="l00052"></a>00052 <span class="comment">  * \sa cwiseNotEqual(), isApprox(), isMuchSmallerThan()</span>
<a name="l00053"></a>00053 <span class="comment">  */</span>
<a name="l00054"></a>00054 <span class="keyword">template</span>&lt;<span class="keyword">typename</span> OtherDerived&gt;
<a name="l00055"></a>00055 <span class="keyword">inline</span> <span class="keyword">const</span> <a class="code" href="class_cwise_binary_op.html" title="Generic expression where a coefficient-wise binary operator is applied to two expressions.">CwiseBinaryOp&lt;std::equal_to&lt;Scalar&gt;</a>, Derived, OtherDerived&gt;
<a name="l00056"></a><a class="code" href="_matrix_cwise_binary_ops_8h.html#a603897bb752cef831c7eda55922ea722">00056</a> <a class="code" href="_matrix_cwise_binary_ops_8h.html#a603897bb752cef831c7eda55922ea722">cwiseEqual</a>(<span class="keyword">const</span> EIGEN_CURRENT_STORAGE_BASE_CLASS&lt;OtherDerived&gt; &amp;other)<span class="keyword"> const</span>
<a name="l00057"></a>00057 <span class="keyword"></span>{
<a name="l00058"></a>00058   <span class="keywordflow">return</span> <a class="code" href="class_cwise_binary_op.html" title="Generic expression where a coefficient-wise binary operator is applied to two expressions.">CwiseBinaryOp&lt;std::equal_to&lt;Scalar&gt;</a>, Derived, OtherDerived&gt;(derived(), other.derived());
<a name="l00059"></a>00059 }
<a name="l00060"></a>00060 <span class="comment"></span>
<a name="l00061"></a>00061 <span class="comment">/** \returns an expression of the coefficient-wise != operator of *this and \a other</span>
<a name="l00062"></a>00062 <span class="comment">  *</span>
<a name="l00063"></a>00063 <span class="comment">  * \warning this performs an exact comparison, which is generally a bad idea with floating-point types.</span>
<a name="l00064"></a>00064 <span class="comment">  * In order to check for equality between two vectors or matrices with floating-point coefficients, it is</span>
<a name="l00065"></a>00065 <span class="comment">  * generally a far better idea to use a fuzzy comparison as provided by isApprox() and</span>
<a name="l00066"></a>00066 <span class="comment">  * isMuchSmallerThan().</span>
<a name="l00067"></a>00067 <span class="comment">  *</span>
<a name="l00068"></a>00068 <span class="comment">  * Example: \include MatrixBase_cwiseNotEqual.cpp</span>
<a name="l00069"></a>00069 <span class="comment">  * Output: \verbinclude MatrixBase_cwiseNotEqual.out</span>
<a name="l00070"></a>00070 <span class="comment">  *</span>
<a name="l00071"></a>00071 <span class="comment">  * \sa cwiseEqual(), isApprox(), isMuchSmallerThan()</span>
<a name="l00072"></a>00072 <span class="comment">  */</span>
<a name="l00073"></a>00073 <span class="keyword">template</span>&lt;<span class="keyword">typename</span> OtherDerived&gt;
<a name="l00074"></a>00074 <span class="keyword">inline</span> <span class="keyword">const</span> <a class="code" href="class_cwise_binary_op.html" title="Generic expression where a coefficient-wise binary operator is applied to two expressions.">CwiseBinaryOp&lt;std::not_equal_to&lt;Scalar&gt;</a>, Derived, OtherDerived&gt;
<a name="l00075"></a><a class="code" href="_matrix_cwise_binary_ops_8h.html#ab008695f07d6d26756b9c01f932e77cc">00075</a> <a class="code" href="_matrix_cwise_binary_ops_8h.html#ab008695f07d6d26756b9c01f932e77cc">cwiseNotEqual</a>(<span class="keyword">const</span> EIGEN_CURRENT_STORAGE_BASE_CLASS&lt;OtherDerived&gt; &amp;other)<span class="keyword"> const</span>
<a name="l00076"></a>00076 <span class="keyword"></span>{
<a name="l00077"></a>00077   <span class="keywordflow">return</span> <a class="code" href="class_cwise_binary_op.html" title="Generic expression where a coefficient-wise binary operator is applied to two expressions.">CwiseBinaryOp&lt;std::not_equal_to&lt;Scalar&gt;</a>, Derived, OtherDerived&gt;(derived(), other.derived());
<a name="l00078"></a>00078 }
<a name="l00079"></a>00079 <span class="comment"></span>
<a name="l00080"></a>00080 <span class="comment">/** \returns an expression of the coefficient-wise min of *this and \a other</span>
<a name="l00081"></a>00081 <span class="comment">  *</span>
<a name="l00082"></a>00082 <span class="comment">  * Example: \include MatrixBase_cwiseMin.cpp</span>
<a name="l00083"></a>00083 <span class="comment">  * Output: \verbinclude MatrixBase_cwiseMin.out</span>
<a name="l00084"></a>00084 <span class="comment">  *</span>
<a name="l00085"></a>00085 <span class="comment">  * \sa class CwiseBinaryOp, max()</span>
<a name="l00086"></a>00086 <span class="comment">  */</span>
<a name="l00087"></a>00087 <span class="keyword">template</span>&lt;<span class="keyword">typename</span> OtherDerived&gt;
<a name="l00088"></a>00088 <a class="code" href="_macros_8h.html#af2b60117c00a6e75812de43bfe7db3b1">EIGEN_STRONG_INLINE</a> <span class="keyword">const</span> <a class="code" href="class_cwise_binary_op.html" title="Generic expression where a coefficient-wise binary operator is applied to two expressions.">CwiseBinaryOp&lt;internal::scalar_min_op&lt;Scalar&gt;</a>, Derived, OtherDerived&gt;
<a name="l00089"></a><a class="code" href="_matrix_cwise_binary_ops_8h.html#a06c24880b78f03c974c32e69d110b22e">00089</a> <a class="code" href="_matrix_cwise_binary_ops_8h.html#a06c24880b78f03c974c32e69d110b22e">cwiseMin</a>(<span class="keyword">const</span> EIGEN_CURRENT_STORAGE_BASE_CLASS&lt;OtherDerived&gt; &amp;other)<span class="keyword"> const</span>
<a name="l00090"></a>00090 <span class="keyword"></span>{
<a name="l00091"></a>00091   <span class="keywordflow">return</span> <a class="code" href="class_cwise_binary_op.html" title="Generic expression where a coefficient-wise binary operator is applied to two expressions.">CwiseBinaryOp&lt;internal::scalar_min_op&lt;Scalar&gt;</a>, Derived, OtherDerived&gt;(derived(), other.derived());
<a name="l00092"></a>00092 }
<a name="l00093"></a>00093 <span class="comment"></span>
<a name="l00094"></a>00094 <span class="comment">/** \returns an expression of the coefficient-wise max of *this and \a other</span>
<a name="l00095"></a>00095 <span class="comment">  *</span>
<a name="l00096"></a>00096 <span class="comment">  * Example: \include MatrixBase_cwiseMax.cpp</span>
<a name="l00097"></a>00097 <span class="comment">  * Output: \verbinclude MatrixBase_cwiseMax.out</span>
<a name="l00098"></a>00098 <span class="comment">  *</span>
<a name="l00099"></a>00099 <span class="comment">  * \sa class CwiseBinaryOp, min()</span>
<a name="l00100"></a>00100 <span class="comment">  */</span>
<a name="l00101"></a>00101 <span class="keyword">template</span>&lt;<span class="keyword">typename</span> OtherDerived&gt;
<a name="l00102"></a>00102 <a class="code" href="_macros_8h.html#af2b60117c00a6e75812de43bfe7db3b1">EIGEN_STRONG_INLINE</a> <span class="keyword">const</span> <a class="code" href="class_cwise_binary_op.html" title="Generic expression where a coefficient-wise binary operator is applied to two expressions.">CwiseBinaryOp&lt;internal::scalar_max_op&lt;Scalar&gt;</a>, Derived, OtherDerived&gt;
<a name="l00103"></a><a class="code" href="_matrix_cwise_binary_ops_8h.html#a5d532e04c997d73f1bf51b01fb96e8c2">00103</a> <a class="code" href="_matrix_cwise_binary_ops_8h.html#a5d532e04c997d73f1bf51b01fb96e8c2">cwiseMax</a>(<span class="keyword">const</span> EIGEN_CURRENT_STORAGE_BASE_CLASS&lt;OtherDerived&gt; &amp;other)<span class="keyword"> const</span>
<a name="l00104"></a>00104 <span class="keyword"></span>{
<a name="l00105"></a>00105   <span class="keywordflow">return</span> <a class="code" href="class_cwise_binary_op.html" title="Generic expression where a coefficient-wise binary operator is applied to two expressions.">CwiseBinaryOp&lt;internal::scalar_max_op&lt;Scalar&gt;</a>, Derived, OtherDerived&gt;(derived(), other.derived());
<a name="l00106"></a>00106 }
<a name="l00107"></a>00107 <span class="comment"></span>
<a name="l00108"></a>00108 <span class="comment">/** \returns an expression of the coefficient-wise quotient of *this and \a other</span>
<a name="l00109"></a>00109 <span class="comment">  *</span>
<a name="l00110"></a>00110 <span class="comment">  * Example: \include MatrixBase_cwiseQuotient.cpp</span>
<a name="l00111"></a>00111 <span class="comment">  * Output: \verbinclude MatrixBase_cwiseQuotient.out</span>
<a name="l00112"></a>00112 <span class="comment">  *</span>
<a name="l00113"></a>00113 <span class="comment">  * \sa class CwiseBinaryOp, cwiseProduct(), cwiseInverse()</span>
<a name="l00114"></a>00114 <span class="comment">  */</span>
<a name="l00115"></a>00115 <span class="keyword">template</span>&lt;<span class="keyword">typename</span> OtherDerived&gt;
<a name="l00116"></a>00116 <a class="code" href="_macros_8h.html#af2b60117c00a6e75812de43bfe7db3b1">EIGEN_STRONG_INLINE</a> <span class="keyword">const</span> <a class="code" href="class_cwise_binary_op.html" title="Generic expression where a coefficient-wise binary operator is applied to two expressions.">CwiseBinaryOp&lt;internal::scalar_quotient_op&lt;Scalar&gt;</a>, Derived, OtherDerived&gt;
<a name="l00117"></a><a class="code" href="_matrix_cwise_binary_ops_8h.html#adee9686eab269154ee6655d01a764d8b">00117</a> <a class="code" href="_matrix_cwise_binary_ops_8h.html#adee9686eab269154ee6655d01a764d8b">cwiseQuotient</a>(<span class="keyword">const</span> EIGEN_CURRENT_STORAGE_BASE_CLASS&lt;OtherDerived&gt; &amp;other)<span class="keyword"> const</span>
<a name="l00118"></a>00118 <span class="keyword"></span>{
<a name="l00119"></a>00119   <span class="keywordflow">return</span> <a class="code" href="class_cwise_binary_op.html" title="Generic expression where a coefficient-wise binary operator is applied to two expressions.">CwiseBinaryOp&lt;internal::scalar_quotient_op&lt;Scalar&gt;</a>, Derived, OtherDerived&gt;(derived(), other.derived());
<a name="l00120"></a>00120 }
</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>