7c56f0fbb124fcc10eb435766998044fe07842d7
[blender.git] / intern / cycles / util / util_math.h
1 /*
2  * Copyright 2011, Blender Foundation.
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  */
18
19 #ifndef __UTIL_MATH_H__
20 #define __UTIL_MATH_H__
21
22 /* Math
23  *
24  * Basic math functions on scalar and vector types. This header is used by
25  * both the kernel code when compiled as C++, and other C++ non-kernel code. */
26
27 #ifndef __KERNEL_OPENCL__
28
29 #define _USE_MATH_DEFINES
30
31 #include <float.h>
32 #include <math.h>
33 #include <stdio.h>
34
35 #endif
36
37 #include "util_types.h"
38
39 CCL_NAMESPACE_BEGIN
40
41 #ifndef M_PI_F
42 #define M_PI_F          ((float)3.14159265358979323846264338327950288)
43 #endif
44 #ifndef M_PI_2_F
45 #define M_PI_2_F        ((float)1.57079632679489661923132169163975144)
46 #endif
47 #ifndef M_PI_4_F
48 #define M_PI_4_F        ((float)0.785398163397448309615660845819875721)
49 #endif
50 #ifndef M_1_PI_F
51 #define M_1_PI_F        ((float)0.318309886183790671537767526745028724)
52 #endif
53 #ifndef M_2_PI_F
54 #define M_2_PI_F        ((float)0.636619772367581343075535053490057448)
55 #endif
56
57 /* Scalar */
58
59 #ifdef _WIN32
60
61 #ifndef __KERNEL_GPU__
62
63 #if(!defined(FREE_WINDOWS))
64 #define copysignf(x, y) ((float)_copysign(x, y))
65 #define hypotf(x, y) _hypotf(x, y)
66 #define isnan(x) _isnan(x)
67 #endif
68
69 #endif
70
71 __device_inline float fmaxf(float a, float b)
72 {
73         return (a > b)? a: b;
74 }
75
76 __device_inline float fminf(float a, float b)
77 {
78         return (a < b)? a: b;
79 }
80
81 #endif
82
83 #ifndef __KERNEL_GPU__
84
85 __device_inline int max(int a, int b)
86 {
87         return (a > b)? a: b;
88 }
89
90 __device_inline int min(int a, int b)
91 {
92         return (a < b)? a: b;
93 }
94
95 __device_inline float max(float a, float b)
96 {
97         return (a > b)? a: b;
98 }
99
100 __device_inline float min(float a, float b)
101 {
102         return (a < b)? a: b;
103 }
104
105 __device_inline double max(double a, double b)
106 {
107         return (a > b)? a: b;
108 }
109
110 __device_inline double min(double a, double b)
111 {
112         return (a < b)? a: b;
113 }
114
115 #endif
116
117 __device_inline float min4(float a, float b, float c, float d)
118 {
119         return min(min(a, b), min(c, d));
120 }
121
122 __device_inline float max4(float a, float b, float c, float d)
123 {
124         return max(max(a, b), max(c, d));
125 }
126
127 #ifndef __KERNEL_OPENCL__
128
129 __device_inline int clamp(int a, int mn, int mx)
130 {
131         return min(max(a, mn), mx);
132 }
133
134 __device_inline float clamp(float a, float mn, float mx)
135 {
136         return min(max(a, mn), mx);
137 }
138
139 #endif
140
141 __device_inline float signf(float f)
142 {
143         return (f < 0.0f)? -1.0f: 1.0f;
144 }
145
146 __device_inline float nonzerof(float f, float eps)
147 {
148         if(fabsf(f) < eps)
149                 return signf(f)*eps;
150         else
151                 return f;
152 }
153
154 /* Float2 Vector */
155
156 #ifndef __KERNEL_OPENCL__
157
158 __device_inline bool is_zero(const float2 a)
159 {
160         return (a.x == 0.0f && a.y == 0.0f);
161 }
162
163 #endif
164
165 #ifndef __KERNEL_OPENCL__
166
167 __device_inline float average(const float2 a)
168 {
169         return (a.x + a.y)*(1.0f/2.0f);
170 }
171
172 #endif
173
174 #ifndef __KERNEL_OPENCL__
175
176 __device_inline float2 operator-(const float2 a)
177 {
178         float2 r = {-a.x, -a.y};
179         return r;
180 }
181
182 __device_inline float2 operator*(const float2 a, const float2 b)
183 {
184         float2 r = {a.x*b.x, a.y*b.y};
185         return r;
186 }
187
188 __device_inline float2 operator*(const float2 a, float f)
189 {
190         float2 r = {a.x*f, a.y*f};
191         return r;
192 }
193
194 __device_inline float2 operator*(float f, const float2 a)
195 {
196         float2 r = {a.x*f, a.y*f};
197         return r;
198 }
199
200 __device_inline float2 operator/(float f, const float2 a)
201 {
202         float2 r = {f/a.x, f/a.y};
203         return r;
204 }
205
206 __device_inline float2 operator/(const float2 a, float f)
207 {
208         float invf = 1.0f/f;
209         float2 r = {a.x*invf, a.y*invf};
210         return r;
211 }
212
213 __device_inline float2 operator/(const float2 a, const float2 b)
214 {
215         float2 r = {a.x/b.x, a.y/b.y};
216         return r;
217 }
218
219 __device_inline float2 operator+(const float2 a, const float2 b)
220 {
221         float2 r = {a.x+b.x, a.y+b.y};
222         return r;
223 }
224
225 __device_inline float2 operator-(const float2 a, const float2 b)
226 {
227         float2 r = {a.x-b.x, a.y-b.y};
228         return r;
229 }
230
231 __device_inline float2 operator+=(float2& a, const float2 b)
232 {
233         a.x += b.x;
234         a.y += b.y;
235         return a;
236 }
237
238 __device_inline float2 operator*=(float2& a, const float2 b)
239 {
240         a.x *= b.x;
241         a.y *= b.y;
242         return a;
243 }
244
245 __device_inline float2 operator*=(float2& a, float f)
246 {
247         a.x *= f;
248         a.y *= f;
249         return a;
250 }
251
252 __device_inline float2 operator/=(float2& a, const float2 b)
253 {
254         a.x /= b.x;
255         a.y /= b.y;
256         return a;
257 }
258
259 __device_inline float2 operator/=(float2& a, float f)
260 {
261         float invf = 1.0f/f;
262         a.x *= invf;
263         a.y *= invf;
264         return a;
265 }
266
267
268 __device_inline float dot(const float2 a, const float2 b)
269 {
270         return a.x*b.x + a.y*b.y;
271 }
272
273 __device_inline float cross(const float2 a, const float2 b)
274 {
275         return (a.x*b.y - a.y*b.x);
276 }
277
278 #endif
279
280 #ifndef __KERNEL_OPENCL__
281
282 __device_inline float len(const float2 a)
283 {
284         return sqrtf(dot(a, a));
285 }
286
287 __device_inline float2 normalize(const float2 a)
288 {
289         return a/len(a);
290 }
291
292 __device_inline float2 normalize_len(const float2 a, float *t)
293 {
294         *t = len(a);
295         return a/(*t);
296 }
297
298 __device_inline bool operator==(const float2 a, const float2 b)
299 {
300         return (a.x == b.x && a.y == b.y);
301 }
302
303 __device_inline bool operator!=(const float2 a, const float2 b)
304 {
305         return !(a == b);
306 }
307
308 __device_inline float2 min(float2 a, float2 b)
309 {
310         float2 r = {min(a.x, b.x), min(a.y, b.y)};
311         return r;
312 }
313
314 __device_inline float2 max(float2 a, float2 b)
315 {
316         float2 r = {max(a.x, b.x), max(a.y, b.y)};
317         return r;
318 }
319
320 __device_inline float2 clamp(float2 a, float2 mn, float2 mx)
321 {
322         return min(max(a, mn), mx);
323 }
324
325 __device_inline float2 fabs(float2 a)
326 {
327         return make_float2(fabsf(a.x), fabsf(a.y));
328 }
329
330 __device_inline float2 as_float2(const float4 a)
331 {
332         return make_float2(a.x, a.y);
333 }
334
335 #endif
336
337 #ifndef __KERNEL_GPU__
338
339 __device_inline void print_float2(const char *label, const float2& a)
340 {
341         printf("%s: %.8f %.8f\n", label, a.x, a.y);
342 }
343
344 #endif
345
346 #ifndef __KERNEL_OPENCL__
347
348 __device_inline float2 interp(float2 a, float2 b, float t)
349 {
350         return a + t*(b - a);
351 }
352
353 #endif
354
355 /* Float3 Vector */
356
357 __device_inline bool is_zero(const float3 a)
358 {
359         return (a.x == 0.0f && a.y == 0.0f && a.z == 0.0f);
360 }
361
362 __device_inline float average(const float3 a)
363 {
364         return (a.x + a.y + a.z)*(1.0f/3.0f);
365 }
366
367 #ifndef __KERNEL_OPENCL__
368
369 __device_inline float3 operator-(const float3 a)
370 {
371         float3 r = make_float3(-a.x, -a.y, -a.z);
372         return r;
373 }
374
375 __device_inline float3 operator*(const float3 a, const float3 b)
376 {
377         float3 r = make_float3(a.x*b.x, a.y*b.y, a.z*b.z);
378         return r;
379 }
380
381 __device_inline float3 operator*(const float3 a, float f)
382 {
383         float3 r = make_float3(a.x*f, a.y*f, a.z*f);
384         return r;
385 }
386
387 __device_inline float3 operator*(float f, const float3 a)
388 {
389         float3 r = make_float3(a.x*f, a.y*f, a.z*f);
390         return r;
391 }
392
393 __device_inline float3 operator/(float f, const float3 a)
394 {
395         float3 r = make_float3(f/a.x, f/a.y, f/a.z);
396         return r;
397 }
398
399 __device_inline float3 operator/(const float3 a, float f)
400 {
401         float invf = 1.0f/f;
402         float3 r = make_float3(a.x*invf, a.y*invf, a.z*invf);
403         return r;
404 }
405
406 __device_inline float3 operator/(const float3 a, const float3 b)
407 {
408         float3 r = make_float3(a.x/b.x, a.y/b.y, a.z/b.z);
409         return r;
410 }
411
412 __device_inline float3 operator+(const float3 a, const float3 b)
413 {
414         float3 r = make_float3(a.x+b.x, a.y+b.y, a.z+b.z);
415         return r;
416 }
417
418 __device_inline float3 operator-(const float3 a, const float3 b)
419 {
420         float3 r = make_float3(a.x-b.x, a.y-b.y, a.z-b.z);
421         return r;
422 }
423
424 __device_inline float3 operator+=(float3& a, const float3 b)
425 {
426         a.x += b.x;
427         a.y += b.y;
428         a.z += b.z;
429         return a;
430 }
431
432 __device_inline float3 operator*=(float3& a, const float3 b)
433 {
434         a.x *= b.x;
435         a.y *= b.y;
436         a.z *= b.z;
437         return a;
438 }
439
440 __device_inline float3 operator*=(float3& a, float f)
441 {
442         a.x *= f;
443         a.y *= f;
444         a.z *= f;
445         return a;
446 }
447
448 __device_inline float3 operator/=(float3& a, const float3 b)
449 {
450         a.x /= b.x;
451         a.y /= b.y;
452         a.z /= b.z;
453         return a;
454 }
455
456 __device_inline float3 operator/=(float3& a, float f)
457 {
458         float invf = 1.0f/f;
459         a.x *= invf;
460         a.y *= invf;
461         a.z *= invf;
462         return a;
463 }
464
465 __device_inline float dot(const float3 a, const float3 b)
466 {
467         return a.x*b.x + a.y*b.y + a.z*b.z;
468 }
469
470 __device_inline float3 cross(const float3 a, const float3 b)
471 {
472         float3 r = make_float3(a.y*b.z - a.z*b.y, a.z*b.x - a.x*b.z, a.x*b.y - a.y*b.x);
473         return r;
474 }
475
476 #endif
477
478 __device_inline float len(const float3 a)
479 {
480         return sqrtf(dot(a, a));
481 }
482
483 #ifndef __KERNEL_OPENCL__
484
485 __device_inline float3 normalize(const float3 a)
486 {
487         return a/len(a);
488 }
489
490 #endif
491
492 __device_inline float3 normalize_len(const float3 a, float *t)
493 {
494         *t = len(a);
495         return a/(*t);
496 }
497
498 #ifndef __KERNEL_OPENCL__
499
500 __device_inline bool operator==(const float3 a, const float3 b)
501 {
502         return (a.x == b.x && a.y == b.y && a.z == b.z);
503 }
504
505 __device_inline bool operator!=(const float3 a, const float3 b)
506 {
507         return !(a == b);
508 }
509
510 __device_inline float3 min(float3 a, float3 b)
511 {
512         float3 r = make_float3(min(a.x, b.x), min(a.y, b.y), min(a.z, b.z));
513         return r;
514 }
515
516 __device_inline float3 max(float3 a, float3 b)
517 {
518         float3 r = make_float3(max(a.x, b.x), max(a.y, b.y), max(a.z, b.z));
519         return r;
520 }
521
522 __device_inline float3 clamp(float3 a, float3 mn, float3 mx)
523 {
524         return min(max(a, mn), mx);
525 }
526
527 __device_inline float3 fabs(float3 a)
528 {
529         return make_float3(fabsf(a.x), fabsf(a.y), fabsf(a.z));
530 }
531
532 #endif
533
534 __device_inline float3 float4_to_float3(const float4 a)
535 {
536         return make_float3(a.x, a.y, a.z);
537 }
538
539 #ifndef __KERNEL_GPU__
540
541 __device_inline void print_float3(const char *label, const float3& a)
542 {
543         printf("%s: %.8f %.8f %.8f\n", label, a.x, a.y, a.z);
544 }
545
546 #endif
547
548 __device_inline float3 interp(float3 a, float3 b, float t)
549 {
550         return a + t*(b - a);
551 }
552
553 /* Float4 Vector */
554
555 #ifndef __KERNEL_OPENCL__
556
557 __device_inline bool is_zero(const float4& a)
558 {
559         return (a.x == 0.0f && a.y == 0.0f && a.z == 0.0f && a.w == 0.0f);
560 }
561
562 __device_inline float average(const float4& a)
563 {
564         return (a.x + a.y + a.z + a.w)*(1.0f/4.0f);
565 }
566
567 __device_inline float4 operator-(const float4& a)
568 {
569         float4 r = {-a.x, -a.y, -a.z, -a.w};
570         return r;
571 }
572
573 __device_inline float4 operator*(const float4& a, const float4& b)
574 {
575         float4 r = {a.x*b.x, a.y*b.y, a.z*b.z, a.w*b.w};
576         return r;
577 }
578
579 __device_inline float4 operator*(const float4& a, float f)
580 {
581         float4 r = {a.x*f, a.y*f, a.z*f, a.w*f};
582         return r;
583 }
584
585 __device_inline float4 operator*(float f, const float4& a)
586 {
587         float4 r = {a.x*f, a.y*f, a.z*f, a.w*f};
588         return r;
589 }
590
591 __device_inline float4 operator/(const float4& a, float f)
592 {
593         float invf = 1.0f/f;
594         float4 r = {a.x*invf, a.y*invf, a.z*invf, a.w*invf};
595         return r;
596 }
597
598 __device_inline float4 operator/(const float4& a, const float4& b)
599 {
600         float4 r = {a.x/b.x, a.y/b.y, a.z/b.z, a.w/b.w};
601         return r;
602 }
603
604 __device_inline float4 operator+(const float4& a, const float4& b)
605 {
606         float4 r = {a.x+b.x, a.y+b.y, a.z+b.z, a.w+b.w};
607         return r;
608 }
609
610 __device_inline float4 operator-(const float4& a, const float4& b)
611 {
612         float4 r = {a.x-b.x, a.y-b.y, a.z-b.z, a.w-b.w};
613         return r;
614 }
615
616 __device_inline float4 operator+=(float4& a, const float4& b)
617 {
618         a.x += b.x;
619         a.y += b.y;
620         a.z += b.z;
621         a.w += b.w;
622         return a;
623 }
624
625 __device_inline float4 operator*=(float4& a, const float4& b)
626 {
627         a.x *= b.x;
628         a.y *= b.y;
629         a.z *= b.z;
630         a.w *= b.w;
631         return a;
632 }
633
634 __device_inline float4 operator/=(float4& a, float f)
635 {
636         float invf = 1.0f/f;
637         a.x *= invf;
638         a.y *= invf;
639         a.z *= invf;
640         a.w *= invf;
641         return a;
642 }
643
644 __device_inline float dot(const float4& a, const float4& b)
645 {
646         return a.x*b.x + a.y*b.y + a.z*b.z + a.w*b.w;
647 }
648
649 __device_inline float4 cross(const float4& a, const float4& b)
650 {
651         float4 r = {a.y*b.z - a.z*b.y, a.z*b.x - a.x*b.z, a.x*b.y - a.y*b.x, 0.0f};
652         return r;
653 }
654
655 __device_inline float4 min(float4 a, float4 b)
656 {
657         return make_float4(min(a.x, b.x), min(a.y, b.y), min(a.z, b.z), min(a.w, b.w));
658 }
659
660 __device_inline float4 max(float4 a, float4 b)
661 {
662         return make_float4(max(a.x, b.x), max(a.y, b.y), max(a.z, b.z), max(a.w, b.w));
663 }
664
665 #endif
666
667 #ifndef __KERNEL_GPU__
668
669 __device_inline void print_float4(const char *label, const float4& a)
670 {
671         printf("%s: %.8f %.8f %.8f %.8f\n", label, a.x, a.y, a.z, a.w);
672 }
673
674 #endif
675
676 /* Int3 */
677
678 #ifndef __KERNEL_OPENCL__
679
680 __device_inline int3 max(int3 a, int3 b)
681 {
682         int3 r = {max(a.x, b.x), max(a.y, b.y), max(a.z, b.z)};
683         return r;
684 }
685
686 __device_inline int3 clamp(const int3& a, int mn, int mx)
687 {
688         int3 r = {clamp(a.x, mn, mx), clamp(a.y, mn, mx), clamp(a.z, mn, mx)};
689         return r;
690 }
691
692 __device_inline int3 clamp(const int3& a, int3& mn, int mx)
693 {
694         int3 r = {clamp(a.x, mn.x, mx), clamp(a.y, mn.y, mx), clamp(a.z, mn.z, mx)};
695         return r;
696 }
697
698 #endif
699
700 #ifndef __KERNEL_GPU__
701
702 __device_inline void print_int3(const char *label, const int3& a)
703 {
704         printf("%s: %d %d %d\n", label, a.x, a.y, a.z);
705 }
706
707 #endif
708
709 /* Int4 */
710
711 #ifndef __KERNEL_OPENCL__
712
713 __device_inline int4 operator>=(float4 a, float4 b)
714 {
715         return make_int4(a.x >= b.x, a.y >= b.y, a.z >= b.z, a.w >= b.w);
716 }
717
718 #endif
719
720 #ifndef __KERNEL_GPU__
721
722 __device_inline void print_int4(const char *label, const int4& a)
723 {
724         printf("%s: %d %d %d %d\n", label, a.x, a.y, a.z, a.w);
725 }
726
727 #endif
728
729 /* Int/Float conversion */
730
731 #ifndef __KERNEL_OPENCL__
732
733 __device_inline unsigned int as_uint(float f)
734 {
735         union { unsigned int i; float f; } u;
736         u.f = f;
737         return u.i;
738 }
739
740 __device_inline int __float_as_int(float f)
741 {
742         union { int i; float f; } u;
743         u.f = f;
744         return u.i;
745 }
746
747 __device_inline float __int_as_float(int i)
748 {
749         union { int i; float f; } u;
750         u.i = i;
751         return u.f;
752 }
753
754 __device_inline uint __float_as_uint(float f)
755 {
756         union { uint i; float f; } u;
757         u.f = f;
758         return u.i;
759 }
760
761 __device_inline float __uint_as_float(uint i)
762 {
763         union { uint i; float f; } u;
764         u.i = i;
765         return u.f;
766 }
767
768 /* Interpolation */
769
770 template<class A, class B> A lerp(const A& a, const A& b, const B& t)
771 {
772         return (A)(a * ((B)1 - t) + b * t);
773 }
774
775 /* Triangle */
776
777 __device_inline float triangle_area(const float3 v1, const float3 v2, const float3 v3)
778 {
779         return len(cross(v3 - v2, v1 - v2))*0.5f;
780 }
781
782 #endif
783
784 /* Orthonormal vectors */
785
786 __device_inline void make_orthonormals(const float3 N, float3 *a, float3 *b)
787 {
788         if(N.x != N.y || N.x != N.z)
789                 *a = make_float3(N.z-N.y, N.x-N.z, N.y-N.x);  //(1,1,1)x N
790         else
791                 *a = make_float3(N.z-N.y, N.x+N.z, -N.y-N.x);  //(-1,1,1)x N
792
793         *a = normalize(*a);
794         *b = cross(N, *a);
795 }
796
797 CCL_NAMESPACE_END
798
799 #endif /* __UTIL_MATH_H__ */
800