ceph/src/boost/libs/qvm/doc/code_generator.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>code generator</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>Code Generator</h3>
  20 </div>
  21 <p>While Boost QVM defines generic functions that operate on matrix and vector types of arbitrary static dimensions, it also provides a code generator that can be used to create compatible header files that define much simpler specializations of these functions for specific dimensions. This is useful during debugging since the generated code is much easier to read than the template metaprogramming-heavy generic implementations. It is also potentially friendlier to the optimizer.</p>
  22 <p>The code generator is a command-line utility program. Its source code can be found in the <i>libs/qvm/gen</i> directory. It was used to generate the following headers:</p>
  23 <div><ul><li> 2D, 3D and 4D matrix operations:<div><ul><li> <i>boost/qvm/gen/mat_operations2.hpp</i> (matrices of size 2x2, 2x1 and 1x2, included by <i><span class="RenoLink"><a href="boost_qvm_mat_operations2_hpp.html">boost/qvm/mat_operations2.hpp</a></span></i>)</li>
  24 <li> <i>boost/qvm/gen/mat_operations3.hpp</i> (matrices of size 3x3, 3x1 and 1x3, included by <i><span class="RenoLink"><a href="boost_qvm_mat_operations3_hpp.html">boost/qvm/mat_operations3.hpp</a></span></i>)</li>
  25 <li> <i>boost/qvm/gen/mat_operations4.hpp</i> (matrices of size 4x4, 4x1 and 1x4, included by <i><span class="RenoLink"><a href="boost_qvm_mat_operations4_hpp.html">boost/qvm/mat_operations4.hpp</a></span></i>)</li>
  26 </ul></div>
  27 </li>
  28 <li> 2D, 3D and 4D vector operations:<div><ul><li> <i>boost/qvm/gen/v2.hpp</i> (included by <i><span class="RenoLink"><a href="boost_qvm_vec_operations2_hpp.html">boost/qvm/vec_operations2.hpp</a></span></i>)</li>
  29 <li> <i>boost/qvm/gen/v3.hpp</i> (included by <i><span class="RenoLink"><a href="boost_qvm_vec_operations3_hpp.html">boost/qvm/vec_operations3.hpp</a></span></i>)</li>
  30 <li> <i>boost/qvm/gen/v4.hpp</i> (included by <i><span class="RenoLink"><a href="boost_qvm_vec_operations4_hpp.html">boost/qvm/vec_operations4.hpp</a></span></i>)</li>
  31 </ul></div>
  32 </li>
  33 <li> 2D, 3D and 4D vector-matrix operations:<div><ul><li> <i>boost/qvm/gen/vm2.hpp</i> (included by <i><span class="RenoLink"><a href="boost_qvm_vec_mat_operations2_hpp.html">boost/qvm/vec_mat_operations2.hpp</a></span></i>)</li>
  34 <li> <i>boost/qvm/gen/vm3.hpp</i> (included by <i><span class="RenoLink"><a href="boost_qvm_vec_mat_operations3_hpp.html">boost/qvm/vec_mat_operations3.hpp</a></span></i>)</li>
  35 <li> <i>boost/qvm/gen/vm4.hpp</i> (included by <i><span class="RenoLink"><a href="boost_qvm_vec_mat_operations4_hpp.html">boost/qvm/vec_mat_operations4.hpp</a></span></i>)</li>
  36 </ul></div>
  37 </li>
  38 <li> 2D, 3D and 4D vector swizzling operations:<div><ul><li> <i>boost/qvm/gen/sw2.hpp</i> (included by <i><span class="RenoLink"><a href="boost_qvm_swizzle2_hpp.html">boost/qvm/swizzle2.hpp</a></span></i>)</li>
  39 <li> <i>boost/qvm/gen/sw3.hpp</i> (included by <i><span class="RenoLink"><a href="boost_qvm_swizzle3_hpp.html">boost/qvm/swizzle3.hpp</a></span></i>)</li>
  40 <li> <i>boost/qvm/gen/sw4.hpp</i> (included by <i><span class="RenoLink"><a href="boost_qvm_swizzle4_hpp.html">boost/qvm/swizzle4.hpp</a></span></i>)</li>
  41 </ul></div>
  42 </li>
  43 </ul></div>
  44 <p>Any such generated headers must be included before the corresponding generic header file is included. For example, if one creates a header <i>boost/qvm/gen/m5.hpp</i>, it must be included before <i><span class="RenoLink"><a href="boost_qvm_mat_operations_hpp.html">boost/qvm/mat_operations.hpp</a></span></i>. However, the generic headers (<i><span class="RenoLink"><a href="boost_qvm_mat_operations_hpp.html">boost/qvm/mat_operations.hpp</a></span></i>, <i><span class="RenoLink"><a href="boost_qvm_vec_operations_hpp.html">boost/qvm/vec_operations.hpp</a></span></i>, <i><span class="RenoLink"><a href="boost_qvm_vec_mat_operations_hpp.html">boost/qvm/vec_mat_operations.hpp</a></span></i> and <i><span class="RenoLink"><a href="boost_qvm_swizzle_hpp.html">boost/qvm/swizzle.hpp</a></span></i>) already include the generated headers from the list above, so the generated headers don't need to be included manually.</p>
  45 <p>Note: that headers under <i>boost/qvm/gen</i> are not part of the public interface of Boost QVM. For example, <i>boost/qvm/gen/mat_operations2.hpp</i> should not be included directly; <i>#include &lt;<span class="RenoLink"><a href="boost_qvm_mat_operations2_hpp.html">boost/qvm/mat_operations2.hpp</a></span>&gt;</i> instead.</p>
  46 </div><div class="RenoAutoDIV"><div class="RenoHR"><hr/></div>
  47 See also: <span class="RenoPageList"><a href="index.html">Boost QVM</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>