ceph/src/boost/libs/qvm/doc/deduce_mat2.html

   1 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
   2 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
   3 <html xmlns='http://www.w3.org/1999/xhtml' xml:lang='en' lang='en'>
   4 <head>
   5         <meta http-equiv='Content-Type' content='text/html; charset=utf-8'/>
   6         <title>deduce_mat2</title>
   7         <link href='reno.css' type='text/css' rel='stylesheet'/>
   8 </head>
   9 <body>
  10 <div class="body-0">
  11 <div class="body-1">
  12 <div class="body-2">
  13 <div>
  14 <h1>QVM: Quaternions, Vectors, Matrices</h1>
  15 </div>
  16 <!-- Copyright (c) 2008-2016 Emil Dotchevski and Reverge Studios, Inc. -->
  17 <!-- Distributed under the Boost Software License, Version 1.0. (See accompanying -->
  18 <!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
  19 <div class="RenoIncludeDIV"><div class="RenoAutoDIV"><h3>deduce_mat2</h3>
  20 </div>
  21 <div class="RenoIncludeDIV"><p><span class="RenoEscape">&#35;<!--<wiki>`&#35;</wiki>--></span>include &lt;<span class="RenoLink"><a href="boost_qvm_deduce_mat_hpp.html">boost/qvm/deduce_mat.hpp</a></span>&gt;</p>
  22 <pre>namespace boost
  23 {
  24     namespace <span class="RenoLink"><a href="qvm.html">qvm</a></span>
  25     {
  26 <span class="RenoIncludeSPAN">        template &lt;class A,class B,int Rows,int Cols&gt;
  27         struct <span class="RenoLink">deduce_mat2</span>
  28         {
  29             typedef /*unspecified*/ type;
  30         };</span>
  31     }
  32 }</pre>
  33 </div><h4>Assumptions:</h4>
  34 <div><ul><li>Both <i><span class="RenoLink"><a href="scalar.html">scalar</a></span>&lt;A&gt;::type</i> and <i><span class="RenoLink"><a href="scalar.html">scalar</a></span>&lt;B&gt;::type</i> are well defined</li>
  35 <li><i><span class="RenoLink"><a href="is_mat.html">is_mat</a></span>&lt;A&gt;::value || <span class="RenoLink"><a href="is_mat.html">is_mat</a></span>&lt;B&gt;::value</i> is <i>true</i></li>
  36 </ul></div>
  37 <h4>Requirements:</h4>
  38 <div><ul><li><i><span class="RenoLink"><a href="is_mat.html">is_mat</a></span>&lt;<span class="RenoLink">deduce_mat2</span>&lt;A,B&gt;::type&gt;::value</i> must be <i>true</i></li>
  39 <li><i><span class="RenoLink">deduce_mat2</span>&lt;A,B&gt;::type</i> must be copyable</li>
  40 <li><i><span class="RenoLink"><a href="mat_traits.html">mat_traits</a></span>&lt;<span class="RenoLink">deduce_mat2</span>&lt;A,B&gt;::type&gt;::<span class="RenoLink"><a href="mat_traits_Matrix_rows.html">rows</a></span>==Rows</i></li>
  41 <li><i><span class="RenoLink"><a href="mat_traits.html">mat_traits</a></span>&lt;<span class="RenoLink">deduce_mat2</span>&lt;A,B&gt;::type&gt;::<span class="RenoLink"><a href="mat_traits_Matrix_cols.html">cols</a></span>==Cols</i></li>
  42 </ul></div>
  43 <p>This template is used by Boost QVM whenever it needs to deduce a matrix type of certain dimensions from the types of two user-supplied function parameters. The returned type must have accessible copy constructor (the <i>A</i> and <i>B</i> types themselves could be non-copyable, and either one of them may be a non-matrix type.)</p>
  44 <p>The main template definition returns an unspecified matrix type of the requested dimensions with <i><span class="RenoLink"><a href="mat_traits_M_scalar_type.html">scalar_type</a></span></i> obtained by <i><span class="RenoLink"><a href="deduce_scalar.html">deduce_scalar</a></span>&lt;A,B&gt;::type</i>, except if <i>A</i> and <i>B</i> are the same matrix type <i>M</i> of dimensions <i>Rows</i> x <i>Cols</i>, in which case <i>M</i> is returned, which is only suitable for copyable types. Boost QVM also defines (partial) specializations for the non-copyable matrix types it produces. Users can define other (partial) specializations for their own types.</p>
  45 <p>A typical use of the <i><span class="RenoLink">deduce_mat2</span></i> template is for specifying the preferred matrix type to be returned by the generic function template overloads in Boost QVM depending on the type of their arguments.</p>
  46 </div><div class="RenoAutoDIV"><div class="RenoHR"><hr/></div>
  47 See also: <span class="RenoPageList"><a href="boost_qvm_deduce_mat_hpp.html">boost/qvm/deduce_mat.hpp</a>&nbsp;| <a href="boost_qvm_mat_traits_array_hpp.html">boost/qvm/mat_traits_array.hpp</a>&nbsp;| <a href="operator_times_mat_mat_.html">operator*(mat,mat)</a>&nbsp;| <a href="operator_plus_mat_mat_.html">operator+(mat,mat)</a>&nbsp;| <a href="operator_minus_mat_mat_.html">operator-(mat,mat)</a></span>
  48 </div>
  49 <!-- Copyright (c) 2008-2016 Emil Dotchevski and Reverge Studios, Inc. -->
  50 <!-- Distributed under the Boost Software License, Version 1.0. (See accompanying -->
  51 <!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
  52 <div id="footer">
  53 <p>
  54 <a class="logo" href="http://jigsaw.w3.org/css-validator/check/referer"><img class="logo_pic" src="valid-css.png" alt="Valid CSS" height="31" width="88"/></a>
  55 <a class="logo" href="http://validator.w3.org/check?uri=referer"><img class="logo_pic" src="valid-xhtml.png" alt="Valid XHTML 1.0" height="31" width="88"/></a>
  56 <small>Copyright (c) 2008-2016 by Emil Dotchevski and Reverge Studios, Inc.<br/>
  57 Distributed under the <a href="http://www.boost.org/LICENSE_1_0.txt">Boost Software License, Version 1.0</a>.</small>
  58 </p>
  59 </div>
  60 </div>
  61 </div>
  62 </div>
  63 </body>
  64 </html>