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
5 <meta http-equiv='Content-Type' content='text/html; charset=utf-8'/>
\r
6 <title>boost/qvm/vec_operations.hpp</title>
\r
7 <link href='reno.css' type='text/css' rel='stylesheet'/>
\r
10 <div class="body-0">
\r
11 <div class="body-1">
\r
12 <div class="body-2">
\r
14 <h1>QVM: Quaternions, Vectors, Matrices</h1>
\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>boost/qvm/vec_operations.hpp</h3>
\r
21 <p>This header defines all available function overloads that operate on vector objects.</p>
\r
23 <div class="RenoIncludeDIV"><p><span class="RenoEscape">#<!--<wiki>`#</wiki>--></span>include <<span class="RenoLink">boost/qvm/vec_operations.hpp</span>></p>
\r
24 <pre>namespace boost
\r
26 namespace <span class="RenoLink"><a href="qvm.html">qvm</a></span>
\r
28 <span class="RenoIncludeSPAN"> <span class="RenoIncludeSPAN">//Only <span class="RenoLink"><a href="SFINAE_enable_if.html">enabled if</a></span>:
\r
29 // <span class="RenoLink"><a href="is_vec.html">is_vec</a></span><A>::value && <span class="RenoLink"><a href="is_vec.html">is_vec</a></span><B>::value &&
\r
30 // <span class="RenoLink"><a href="vec_traits.html">vec_traits</a></span><A>::<span class="RenoLink"><a href="vec_traits_Vector_dim.html">dim</a></span>==<span class="RenoLink"><a href="vec_traits.html">vec_traits</a></span><B>::<span class="RenoLink"><a href="vec_traits_Vector_dim.html">dim</a></span>
\r
31 template <class A,class B>
\r
32 A & <span class="RenoLink"><a href="assign_vec_vec_.html">assign</a></span>( A & a, B const & b );</span>
\r
34 <span class="RenoIncludeSPAN">//Only <span class="RenoLink"><a href="SFINAE_enable_if.html">enabled if</a></span>:
\r
35 // <span class="RenoLink"><a href="is_vec.html">is_vec</a></span><R>::value && <span class="RenoLink"><a href="is_vec.html">is_vec</a></span><A>::value &&
\r
36 // <span class="RenoLink"><a href="vec_traits.html">vec_traits</a></span><R>::<span class="RenoLink"><a href="vec_traits_Vector_dim.html">dim</a></span>==<span class="RenoLink"><a href="vec_traits.html">vec_traits</a></span><A>::<span class="RenoLink"><a href="vec_traits_Vector_dim.html">dim</a></span>
\r
37 template <class R,class A>
\r
38 R <span class="RenoLink"><a href="convert_to_vec_.html">convert_to</a></span>( A const & a );</span>
\r
40 <span class="RenoIncludeSPAN">//Only <span class="RenoLink"><a href="SFINAE_enable_if.html">enabled if</a></span>:
\r
41 // <span class="RenoLink"><a href="is_vec.html">is_vec</a></span><A>::value && <span class="RenoLink"><a href="is_vec.html">is_vec</a></span><B>::value &&
\r
42 // <span class="RenoLink"><a href="vec_traits.html">vec_traits</a></span><A>::<span class="RenoLink"><a href="vec_traits_Vector_dim.html">dim</a></span>==<span class="RenoLink"><a href="vec_traits.html">vec_traits</a></span><B>::<span class="RenoLink"><a href="vec_traits_Vector_dim.html">dim</a></span>
\r
43 template <class A,class B>
\r
44 A & <span class="RenoLink"><a href="operator_sub_eq_vec_vec_.html">operator-=</a></span>( A & a, B const & b );</span>
\r
46 <span class="RenoIncludeSPAN">//Only <span class="RenoLink"><a href="SFINAE_enable_if.html">enabled if</a></span>: <span class="RenoLink"><a href="is_vec.html">is_vec</a></span><A>::value
\r
47 template <class A>
\r
48 typename <span class="RenoLink"><a href="deduce_vec.html">deduce_vec</a></span><A>::type
\r
49 <span class="RenoLink"><a href="operator_minus_vec_.html">operator-</a></span>( A const & a );</span>
\r
51 <span class="RenoIncludeSPAN">//Only <span class="RenoLink"><a href="SFINAE_enable_if.html">enabled if</a></span>:
\r
52 // <span class="RenoLink"><a href="is_vec.html">is_vec</a></span><A>::value && <span class="RenoLink"><a href="is_vec.html">is_vec</a></span><B>::value &&
\r
53 // <span class="RenoLink"><a href="vec_traits.html">vec_traits</a></span><A>::<span class="RenoLink"><a href="vec_traits_Vector_dim.html">dim</a></span>==<span class="RenoLink"><a href="vec_traits.html">vec_traits</a></span><B>::<span class="RenoLink"><a href="vec_traits_Vector_dim.html">dim</a></span>
\r
54 template <class A,class B>
\r
55 typename <span class="RenoLink"><a href="deduce_vec2.html">deduce_vec2</a></span><A,B,<span class="RenoLink"><a href="vec_traits.html">vec_traits</a></span><A>::<span class="RenoLink"><a href="vec_traits_Vector_dim.html">dim</a></span>>::type
\r
56 <span class="RenoLink"><a href="operator_minus_vec_vec_.html">operator-</a></span>( A const & a, B const & b );</span>
\r
58 <span class="RenoIncludeSPAN">//Only <span class="RenoLink"><a href="SFINAE_enable_if.html">enabled if</a></span>:
\r
59 // <span class="RenoLink"><a href="is_vec.html">is_vec</a></span><A>::value && <span class="RenoLink"><a href="is_vec.html">is_vec</a></span><B>::value &&
\r
60 // <span class="RenoLink"><a href="vec_traits.html">vec_traits</a></span><A>::<span class="RenoLink"><a href="vec_traits_Vector_dim.html">dim</a></span>==<span class="RenoLink"><a href="vec_traits.html">vec_traits</a></span><B>::<span class="RenoLink"><a href="vec_traits_Vector_dim.html">dim</a></span>
\r
61 template <class A,class B>
\r
62 A & <span class="RenoLink"><a href="operator_add_vec_vec_.html">operator+=</a></span>( A & a, B const & b );</span>
\r
64 <span class="RenoIncludeSPAN">//Only <span class="RenoLink"><a href="SFINAE_enable_if.html">enabled if</a></span>:
\r
65 // <span class="RenoLink"><a href="is_vec.html">is_vec</a></span><A>::value && <span class="RenoLink"><a href="is_vec.html">is_vec</a></span><B>::value &&
\r
66 // <span class="RenoLink"><a href="vec_traits.html">vec_traits</a></span><A>::<span class="RenoLink"><a href="vec_traits_Vector_dim.html">dim</a></span>==<span class="RenoLink"><a href="vec_traits.html">vec_traits</a></span><B>::<span class="RenoLink"><a href="vec_traits_Vector_dim.html">dim</a></span>
\r
67 template <class A,class B>
\r
68 typename <span class="RenoLink"><a href="deduce_vec2.html">deduce_vec2</a></span><A,B,<span class="RenoLink"><a href="vec_traits.html">vec_traits</a></span><A>::<span class="RenoLink"><a href="vec_traits_Vector_dim.html">dim</a></span>>::type
\r
69 <span class="RenoLink"><a href="operator_plus_vec_vec_.html">operator+</a></span>( A const & a, B const & b );</span>
\r
71 <span class="RenoIncludeSPAN">//Only <span class="RenoLink"><a href="SFINAE_enable_if.html">enabled if</a></span>: <span class="RenoLink"><a href="is_vec.html">is_vec</a></span><A>::value && <span class="RenoLink"><a href="is_scalar.html">is_scalar</a></span><B>::value
\r
72 template <class A,class B>
\r
73 A & <span class="RenoLink"><a href="operator_div_eq_vec_scalar_.html">operator/=</a></span>( A & a, B b );</span>
\r
75 <span class="RenoIncludeSPAN">//Only <span class="RenoLink"><a href="SFINAE_enable_if.html">enabled if</a></span>: <span class="RenoLink"><a href="is_vec.html">is_vec</a></span><A>::value && <span class="RenoLink"><a href="is_scalar.html">is_scalar</a></span><B>::value
\r
76 template <class A,class B>
\r
77 typename <span class="RenoLink"><a href="deduce_vec.html">deduce_vec</a></span><A>::type
\r
78 <span class="RenoLink"><a href="operator_over_vec_scalar_.html">operator/</a></span>( A const & a, B b );</span>
\r
80 <span class="RenoIncludeSPAN">//Only <span class="RenoLink"><a href="SFINAE_enable_if.html">enabled if</a></span>: <span class="RenoLink"><a href="is_vec.html">is_vec</a></span><A>::value && <span class="RenoLink"><a href="is_scalar.html">is_scalar</a></span><B>::value
\r
81 template <class A,class B>
\r
82 A & <span class="RenoLink"><a href="operator_mul_eq_vec_scalar_.html">operator*=</a></span>( A & a, B b );</span>
\r
84 <span class="RenoIncludeSPAN">//Only <span class="RenoLink"><a href="SFINAE_enable_if.html">enabled if</a></span>: <span class="RenoLink"><a href="is_vec.html">is_vec</a></span><A>::value && <span class="RenoLink"><a href="is_scalar.html">is_scalar</a></span><B>::value
\r
85 template <class A>
\r
86 typename <span class="RenoLink"><a href="deduce_vec.html">deduce_vec</a></span><A>::type
\r
87 <span class="RenoLink"><a href="operator_times_vec_scalar_.html">operator*</a></span>( A const & a, B b );</span>
\r
89 <span class="RenoIncludeSPAN">//Only <span class="RenoLink"><a href="SFINAE_enable_if.html">enabled if</a></span>: <span class="RenoLink"><a href="is_scalar.html">is_scalar</a></span><A>::value && <span class="RenoLink"><a href="is_vec.html">is_vec</a></span><B>::value
\r
90 template <class A>
\r
91 typename <span class="RenoLink"><a href="deduce_vec.html">deduce_vec</a></span><B>::type
\r
92 <span class="RenoLink"><a href="operator_times_vec_scalar_.html">operator*</a></span>( A a, B const & b );</span>
\r
94 <span class="RenoIncludeSPAN">//Only <span class="RenoLink"><a href="SFINAE_enable_if.html">enabled if</a></span>:
\r
95 // <span class="RenoLink"><a href="is_vec.html">is_vec</a></span><A>::value && <span class="RenoLink"><a href="is_vec.html">is_vec</a></span><B>::value &&
\r
96 // <span class="RenoLink"><a href="vec_traits.html">vec_traits</a></span><A>::<span class="RenoLink"><a href="vec_traits_Vector_dim.html">dim</a></span>==<span class="RenoLink"><a href="vec_traits.html">vec_traits</a></span><B>::<span class="RenoLink"><a href="vec_traits_Vector_dim.html">dim</a></span>
\r
97 template <class A,class B>
\r
98 bool <span class="RenoLink"><a href="operator_eq_vec_vec_.html">operator==</a></span>( A const & a, B const & b );</span>
\r
100 <span class="RenoIncludeSPAN">//Only <span class="RenoLink"><a href="SFINAE_enable_if.html">enabled if</a></span>:
\r
101 // <span class="RenoLink"><a href="is_vec.html">is_vec</a></span><A>::value && <span class="RenoLink"><a href="is_vec.html">is_vec</a></span><B>::value &&
\r
102 // <span class="RenoLink"><a href="vec_traits.html">vec_traits</a></span><A>::<span class="RenoLink"><a href="vec_traits_Vector_dim.html">dim</a></span>==<span class="RenoLink"><a href="vec_traits.html">vec_traits</a></span><B>::<span class="RenoLink"><a href="vec_traits_Vector_dim.html">dim</a></span>
\r
103 template <class A,class B>
\r
104 bool <span class="RenoLink"><a href="operator_not_eq_vec_vec_.html">operator!=</a></span>( A const & a, B const & b );</span>
\r
106 <span class="RenoIncludeSPAN">//Only <span class="RenoLink"><a href="SFINAE_enable_if.html">enabled if</a></span>:
\r
107 // <span class="RenoLink"><a href="is_vec.html">is_vec</a></span><A>::value && <span class="RenoLink"><a href="is_vec.html">is_vec</a></span><B>::value &&
\r
108 // <span class="RenoLink"><a href="vec_traits.html">vec_traits</a></span><A>::<span class="RenoLink"><a href="vec_traits_Vector_dim.html">dim</a></span>==<span class="RenoLink"><a href="vec_traits.html">vec_traits</a></span><B>::<span class="RenoLink"><a href="vec_traits_Vector_dim.html">dim</a></span>
\r
109 template <class A,class B,class Cmp>
\r
110 bool <span class="RenoLink"><a href="cmp_mat_mat_.html">cmp</a></span>( A const & a, B const & b, Cmp pred );</span>
\r
112 <span class="RenoIncludeSPAN">//Only <span class="RenoLink"><a href="SFINAE_enable_if.html">enabled if</a></span>:
\r
113 // <span class="RenoLink"><a href="is_vec.html">is_vec</a></span><A>::value
\r
114 template <class A>
\r
115 typename <span class="RenoLink"><a href="vec_traits.html">vec_traits</a></span><A>::<span class="RenoLink"><a href="vec_traits_V_scalar_type.html">scalar_type</a></span>
\r
116 <span class="RenoLink"><a href="mag_sqr_vec_.html">mag_sqr</a></span>( A const & a );</span>
\r
118 <span class="RenoIncludeSPAN">//Only <span class="RenoLink"><a href="SFINAE_enable_if.html">enabled if</a></span>:
\r
119 // <span class="RenoLink"><a href="is_vec.html">is_vec</a></span><A>::value
\r
120 template <class A>
\r
121 typename <span class="RenoLink"><a href="vec_traits.html">vec_traits</a></span><A>::<span class="RenoLink"><a href="vec_traits_V_scalar_type.html">scalar_type</a></span>
\r
122 <span class="RenoLink"><a href="mag_vec_.html">mag</a></span>( A const & a );</span>
\r
124 <span class="RenoIncludeSPAN">//Only <span class="RenoLink"><a href="SFINAE_enable_if.html">enabled if</a></span>:
\r
125 // <span class="RenoLink"><a href="is_vec.html">is_vec</a></span><A>::value
\r
126 template <class A>
\r
127 typename <span class="RenoLink"><a href="deduce_vec.html">deduce_vec</a></span><A>::type
\r
128 <span class="RenoLink"><a href="normalized_vec_.html">normalized</a></span>( A const & a );</span>
\r
130 <span class="RenoIncludeSPAN">//Only <span class="RenoLink"><a href="SFINAE_enable_if.html">enabled if</a></span>:
\r
131 // <span class="RenoLink"><a href="is_vec.html">is_vec</a></span><A>::value
\r
132 template <class A>
\r
133 void <span class="RenoLink"><a href="normalize_vec_.html">normalize</a></span>( A & a );</span>
\r
135 <span class="RenoIncludeSPAN">//Only <span class="RenoLink"><a href="SFINAE_enable_if.html">enabled if</a></span>:
\r
136 // <span class="RenoLink"><a href="is_vec.html">is_vec</a></span><A>::value && <span class="RenoLink"><a href="is_vec.html">is_vec</a></span><B>::value &&
\r
137 // <span class="RenoLink"><a href="vec_traits.html">vec_traits</a></span><A>::<span class="RenoLink"><a href="vec_traits_Vector_dim.html">dim</a></span>==<span class="RenoLink"><a href="vec_traits.html">vec_traits</a></span><B>::<span class="RenoLink"><a href="vec_traits_Vector_dim.html">dim</a></span>
\r
138 template <class A,class B>
\r
139 typename <span class="RenoLink"><a href="deduce_scalar.html">deduce_scalar</a></span><A,B>::type
\r
140 <span class="RenoLink"><a href="dot_vec_vec_.html">dot</a></span>( A const & a, B const & b );</span>
\r
142 <span class="RenoIncludeSPAN">//Only <span class="RenoLink"><a href="SFINAE_enable_if.html">enabled if</a></span>:
\r
143 // <span class="RenoLink"><a href="is_vec.html">is_vec</a></span><A>::value && <span class="RenoLink"><a href="is_vec.html">is_vec</a></span><B>::value &&
\r
144 // <span class="RenoLink"><a href="vec_traits.html">vec_traits</a></span><A>::<span class="RenoLink"><a href="vec_traits_Vector_dim.html">dim</a></span>==3 && <span class="RenoLink"><a href="vec_traits.html">vec_traits</a></span><B>::<span class="RenoLink"><a href="vec_traits_Vector_dim.html">dim</a></span>==3
\r
145 template <class A,class B>
\r
146 typename <span class="RenoLink"><a href="deduce_vec2.html">deduce_vec2</a></span><A,B,3>::type
\r
147 <span class="RenoLink"><a href="cross.html">cross</a></span>( A const & a, B const & b );</span>
\r
149 <span class="RenoIncludeSPAN">template <class T,int S>
\r
150 -unspecified-return-type- <span class="RenoLink"><a href="zero_vec.html">zero_vec</a></span>();</span>
\r
152 <span class="RenoIncludeSPAN">//Only <span class="RenoLink"><a href="SFINAE_enable_if.html">enabled if</a></span>:
\r
153 // <span class="RenoLink"><a href="is_vec.html">is_vec</a></span><A>::value
\r
154 template <class A>
\r
155 void <span class="RenoLink"><a href="set_zero_vec_.html">set_zero</a></span>( A & a );</span>
\r
157 <span class="RenoIncludeSPAN">//Only <span class="RenoLink"><a href="SFINAE_enable_if.html">enabled if</a></span>: <span class="RenoLink"><a href="is_vec.html">is_vec</a></span><A>::value
\r
158 template <class A>
\r
159 -unspecified-return-type- <span class="RenoLink"><a href="vref.html">vref</a></span>( A & a );</span>
\r
161 <span class="RenoIncludeSPAN">//Only <span class="RenoLink"><a href="SFINAE_enable_if.html">enabled if</a></span>: <span class="RenoLink"><a href="is_vec.html">is_vec</a></span><A>::value
\r
162 template <class Scalar,class A>
\r
163 -unspecified-return_type- <span class="RenoLink"><a href="scalar_cast_vec_.html">scalar_cast</a></span>( A const & a );</span></span>
\r
166 </div></div><div class="RenoAutoDIV"><div class="RenoHR"><hr/></div>
\r
167 See also: <span class="RenoPageList"><a href="assign_vec_vec_.html">assign(vec,vec)</a> | <a href="boost_qvm_operations_hpp.html">boost/qvm/operations.hpp</a> | <a href="boost_qvm_vec_operations2_hpp.html">boost/qvm/vec_operations2.hpp</a> | <a href="boost_qvm_vec_operations3_hpp.html">boost/qvm/vec_operations3.hpp</a> | <a href="boost_qvm_vec_operations4_hpp.html">boost/qvm/vec_operations4.hpp</a> | <a href="code_generator.html">Code Generator</a> | <a href="cmp_vec_vec_.html">cmp(vec,vec)</a> | <a href="convert_to_vec_.html">convert_to(vec)</a> | <a href="cross.html">cross</a> | <a href="dot_vec_vec_.html">dot(vec,vec)</a> | <a href="mag_vec_.html">mag(vec)</a> | <a href="mag_sqr_vec_.html">mag_sqr(vec)</a> | <a href="normalize_vec_.html">normalize(vec)</a> | <a href="normalized_vec_.html">normalized(vec)</a> | <a href="operator_not_eq_vec_vec_.html">operator!=(vec,vec)</a> | <a href="operator_times_scalar_vec_.html">operator*(scalar,vec)</a> | <a href="operator_times_vec_scalar_.html">operator*(vec,scalar)</a> | <a href="operator_mul_eq_vec_scalar_.html">operator*=(vec,scalar)</a> | <a href="operator_plus_vec_vec_.html">operator+(vec,vec)</a> | <a href="operator_add_vec_vec_.html">operator+=(vec,vec)</a> | <a href="operator_minus_vec_.html">operator-(vec)</a> | <a href="operator_minus_vec_vec_.html">operator-(vec,vec)</a> | <a href="operator_sub_eq_vec_vec_.html">operator-=(vec,vec)</a> | <a href="operator_over_vec_scalar_.html">operator/(vec,scalar)</a> | <a href="operator_div_eq_vec_scalar_.html">operator/=(vec,scalar)</a> | <a href="operator_eq_vec_vec_.html">operator==(vec,vec)</a> | <a href="scalar_cast_vec_.html">scalar_cast(vec)</a> | <a href="set_zero_vec_.html">set_zero(vec)</a> | <a href="vref.html">vref</a> | <a href="zero_vec.html">zero_vec</a></span>
\r
169 <!-- Copyright (c) 2008-2016 Emil Dotchevski and Reverge Studios, Inc. -->
\r
170 <!-- Distributed under the Boost Software License, Version 1.0. (See accompanying -->
\r
171 <!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
\r
174 <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
175 <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
176 <small>Copyright (c) 2008-2016 by Emil Dotchevski and Reverge Studios, Inc.<br/>
\r
177 Distributed under the <a href="http://www.boost.org/LICENSE_1_0.txt">Boost Software License, Version 1.0</a>.</small>
\r