ceph/src/boost/libs/qvm/doc/deduce_vec.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_vec</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_vec</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_vec_hpp.html">boost/qvm/deduce_vec.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;
  27             class V,
  28             int Dim=<span class="RenoLink"><a href="vec_traits_Vector_dim.html">vec_traits&lt;Vector&gt;::dim</a></span>&gt;
  29         struct <span class="RenoLink">deduce_vec</span>
  30         {
  31             typedef /*unspecified*/ type;
  32         };</span>
  33     }
  34 }</pre>
  35 </div><h4>Assumption:</h4>
  36 <p><i><span class="RenoLink"><a href="is_vec.html">is_vec</a></span>&lt;V&gt;::value</i> is <i>true</i>.</p>
  37 <h4>Requirements:</h4>
  38 <div><ul><li><i><span class="RenoLink"><a href="is_vec.html">is_vec</a></span>&lt;<span class="RenoLink">deduce_vec</span>&lt;V&gt;::type&gt;::value</i> must be <i>true</i></li>
  39 <li><i><span class="RenoLink">deduce_vec</span>&lt;V&gt;::type</i> must be copyable</li>
  40 <li><i><span class="RenoLink"><a href="vec_traits.html">vec_traits</a></span>&lt;<span class="RenoLink">deduce_vec</span>&lt;V&gt;::type&gt;::<span class="RenoLink"><a href="vec_traits_Vector_dim.html">dim</a></span>==Dim</i></li>
  41 </ul></div>
  42 <p>This template is used by Boost QVM whenever it needs to deduce a copyable vector type of certain dimension from a single user-supplied function parameter of vector type. The returned type must have accessible copy constructor. Note that <i>V</i> may be non-copyable.</p>
  43 <p>The main template definition returns an unspecified copyable vector type of size <i>Dim</i>, except if <i><span class="RenoLink"><a href="vec_traits.html">vec_traits</a></span>&lt;V&gt;::<span class="RenoLink"><a href="vec_traits_Vector_dim.html">dim</a></span>==Dim</i>, in which case it returns <i>V</i>, which is suitable only if <i>V</i> is a copyable type. Boost QVM also defines (partial) specializations for the non-copyable vector types it produces. Users can define other (partial) specializations for their own types.</p>
  44 <p>A typical use of the <i><span class="RenoLink">deduce_vec</span></i> template is for specifying the preferred vector type to be returned by the generic function template overloads in Boost QVM depending on the type of their arguments.</p>
  45 </div><div class="RenoAutoDIV"><div class="RenoHR"><hr/></div>
  46 See also: <span class="RenoPageList"><a href="boost_qvm_deduce_vec_hpp.html">boost/qvm/deduce_vec.hpp</a>&nbsp;| <a href="boost_qvm_vec_traits_array_hpp.html">boost/qvm/vec_traits_array.hpp</a>&nbsp;| <a href="normalized_vec_.html">normalized(vec)</a>&nbsp;| <a href="operator_times_vec_scalar_.html">operator*(vec,scalar)</a>&nbsp;| <a href="operator_minus_vec_.html">operator-(vec)</a>&nbsp;| <a href="operator_over_vec_scalar_.html">operator/(vec,scalar)</a></span>
  47 </div>
  48 <!-- Copyright (c) 2008-2016 Emil Dotchevski and Reverge Studios, Inc. -->
  49 <!-- Distributed under the Boost Software License, Version 1.0. (See accompanying -->
  50 <!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
  51 <div id="footer">
  52 <p>
  53 <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>
  54 <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>
  55 <small>Copyright (c) 2008-2016 by Emil Dotchevski and Reverge Studios, Inc.<br/>
  56 Distributed under the <a href="http://www.boost.org/LICENSE_1_0.txt">Boost Software License, Version 1.0</a>.</small>
  57 </p>
  58 </div>
  59 </div>
  60 </div>
  61 </div>
  62 </body>
  63 </html>