libs/qvm/doc/vec_traits_defaults.html

   1 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'\r
   2 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>\r
   3 <html xmlns='http://www.w3.org/1999/xhtml' xml:lang='en' lang='en'>\r
   4 <head>\r
   5         <meta http-equiv='Content-Type' content='text/html; charset=utf-8'/>\r
   6         <title>vec_traits_defaults</title>\r
   7         <link href='reno.css' type='text/css' rel='stylesheet'/>\r
   8 </head>\r
   9 <body>\r
  10 <div class="body-0">\r
  11 <div class="body-1">\r
  12 <div class="body-2">\r
  13 <div>\r
  14 <h1>QVM: Quaternions, Vectors, Matrices</h1>\r
  15 </div>\r
  16 <!-- Copyright (c) 2008-2016 Emil Dotchevski and Reverge Studios, Inc. -->\r
  17 <!-- Distributed under the Boost Software License, Version 1.0. (See accompanying -->\r
  18 <!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->\r
  19 <div class="RenoIncludeDIV"><div class="RenoAutoDIV"><h3>vec_traits_defaults</h3>\r
  20 </div>\r
  21 <div class="RenoIncludeDIV"><p><span class="RenoEscape">&#35;<!--<wiki>`&#35;</wiki>--></span>include &lt;<span class="RenoLink"><a href="boost_qvm_vec_traits_defaults_hpp.html">boost/qvm/vec_traits_defaults.hpp</a></span>&gt;</p>\r
  22 <pre>namespace boost\r
  23 {\r
  24     namespace <span class="RenoLink"><a href="qvm.html">qvm</a></span>\r
  25     {\r
  26 <span class="RenoIncludeSPAN">        template &lt;class VecType,class ScalarType,int Dim&gt;\r
  27         struct <span class="RenoLink">vec_traits_defaults</span>\r
  28         {\r
  29             typedef VecType vec_type;\r
  30             typedef ScalarType <span class="RenoLink"><a href="vec_traits_V_scalar_type.html">scalar_type</a></span>;\r
  31             static int const <span class="RenoLink"><a href="vec_traits_Vector_dim.html">dim</a></span>=Dim;\r
  32         \r
  33             template &lt;int I&gt;\r
  34             static <span class="RenoLink"><a href="BOOST_QVM_INLINE_CRITICAL.html">BOOST_QVM_INLINE_CRITICAL</a></span>\r
  35             <span class="RenoLink"><a href="vec_traits_V_scalar_type.html">scalar_type</a></span> <span class="RenoLink"><a href="vec_traits_V_write_element.html">write_element</a></span>( vec_type const &amp; x )\r
  36             {\r
  37                 return <span class="RenoLink"><a href="vec_traits.html">vec_traits</a></span>&lt;vec_type&gt;::template <span class="RenoLink"><a href="vec_traits_V_write_element.html">write_element</a></span>&lt;I&gt;(const_cast&lt;vec_type &amp;&gt;(x));\r
  38             }\r
  39         \r
  40             static <span class="RenoLink"><a href="BOOST_QVM_INLINE_CRITICAL.html">BOOST_QVM_INLINE_CRITICAL</a></span>\r
  41             <span class="RenoLink"><a href="vec_traits_V_scalar_type.html">scalar_type</a></span> <span class="RenoLink"><a href="vec_traits_V_read_element_idx.html">read_element_idx</a></span>( int i, vec_type const &amp; x )\r
  42             {\r
  43                 return <span class="RenoLink"><a href="vec_traits.html">vec_traits</a></span>&lt;vec_type&gt;::<span class="RenoLink"><a href="vec_traits_V_write_element_idx.html">write_element_idx</a></span>(i,const_cast&lt;vec_type &amp;&gt;(x));\r
  44             }\r
  45         \r
  46             protected:\r
  47         \r
  48             static <span class="RenoLink"><a href="BOOST_QVM_INLINE_TRIVIAL.html">BOOST_QVM_INLINE_TRIVIAL</a></span>\r
  49             <span class="RenoLink"><a href="vec_traits_V_scalar_type.html">scalar_type</a></span> &amp; <span class="RenoLink"><a href="vec_traits_V_write_element_idx.html">write_element_idx</a></span>( int i, vec_type &amp; m )\r
  50             {\r
  51                 /* unspecified */\r
  52             }\r
  53         };</span>\r
  54     }\r
  55 }</pre>\r
  56 </div><p>The <i><span class="RenoLink">vec_traits_defaults</span></i> template is designed to be used as a public base for user-defined specializations of the <i><span class="RenoLink"><a href="vec_traits.html">vec_traits</a></span></i> template, to easily define the required members. If it is used, the only member that must be defined by the user in a <i><span class="RenoLink"><a href="vec_traits.html">vec_traits</a></span></i> specialization is <i><span class="RenoLink"><a href="vec_traits_V_write_element.html">write_element</a></span></i>; the <i><span class="RenoLink">vec_traits_defaults</span></i> base will define <i><span class="RenoLink"><a href="vec_traits_V_read_element.html">read_element</a></span></i>, as well as <i><span class="RenoLink"><a href="vec_traits_V_scalar_type.html">scalar_type</a></span></i> and <i><span class="RenoLink"><a href="vec_traits_Vector_dim.html">dim</a></span></i> automatically.</p>\r
  57 <p>Optionally, the user may also define <i><span class="RenoLink"><a href="vec_traits_V_write_element_idx.html">write_element_idx</a></span></i>, in which case the <i><span class="RenoLink">vec_traits_defaults</span></i> base will provide a suitable <i><span class="RenoLink"><a href="vec_traits_V_read_element_idx.html">read_element_idx</a></span></i> definition automatically. In addition, <i><span class="RenoLink">vec_traits_defaults</span></i> defines a <b>protected</b> implementation of <i><span class="RenoLink"><a href="vec_traits_V_write_element_idx.html">write_element_idx</a></span></i> which may be made publicly available by the deriving <i><span class="RenoLink"><a href="vec_traits.html">vec_traits</a></span></i> specialization in case the vector type for which it is being specialized can not be indexed efficiently. This <i><span class="RenoLink"><a href="vec_traits_V_write_element_idx.html">write_element_idx</a></span></i> function is less efficient (using meta-programming), implemented in terms of the required user-defined <i><span class="RenoLink"><a href="vec_traits_V_write_element.html">write_element</a></span></i>.</p>\r
  58 </div><div class="RenoAutoDIV"><div class="RenoHR"><hr/></div>\r
  59 See also: <span class="RenoPageList"><a href="boost_qvm_vec_traits_defaults_hpp.html">boost/qvm/vec_traits_defaults.hpp</a></span>\r
  60 </div>\r
  61 <!-- Copyright (c) 2008-2016 Emil Dotchevski and Reverge Studios, Inc. -->\r
  62 <!-- Distributed under the Boost Software License, Version 1.0. (See accompanying -->\r
  63 <!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->\r
  64 <div id="footer">\r
  65 <p>\r
  66 <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>\r
  67 <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>\r
  68 <small>Copyright (c) 2008-2016 by Emil Dotchevski and Reverge Studios, Inc.<br/>\r
  69 Distributed under the <a href="http://www.boost.org/LICENSE_1_0.txt">Boost Software License, Version 1.0</a>.</small>\r
  70 </p>\r
  71 </div>\r
  72 </div>\r
  73 </div>\r
  74 </div>\r
  75 </body>\r
  76 </html>\r