summaryrefslogtreecommitdiffstats
path: root/src/gui/math3d/qfixedpt.cpp
blob: 93f2150981cffaf2b3fd97cda115a3e61a96de43 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
/****************************************************************************
**
** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
** Contact: Qt Software Information (qt-info@nokia.com)
**
** This file is part of the $MODULE$ of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** No Commercial Usage
** This file contains pre-release code and may not be distributed.
** You may use this file in accordance with the terms and conditions
** contained in the either Technology Preview License Agreement or the
** Beta Release License Agreement.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Nokia gives you certain
** additional rights. These rights are described in the Nokia Qt LGPL
** Exception version 1.0, included in the file LGPL_EXCEPTION.txt in this
** package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3.0 as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU General Public License version 3.0 requirements will be
** met: http://www.gnu.org/copyleft/gpl.html.
**
** If you are unsure which license is appropriate for your use, please
** contact the sales department at qt-sales@nokia.com.
** $QT_END_LICENSE$
**
****************************************************************************/

#include "qfixedpt.h"

QT_BEGIN_NAMESPACE

/*!
    \internal
    Returns the fixed-point square root of \a value.
*/
qint64 qt_math3d_fixed_sqrt(qint64 value)
{
    qint64 result = 0;
    qint64 bit = ((qint64)1) << 62;
    while (bit > value)
        bit >>= 2;
    while (bit != 0) {
        if (value >= (result + bit)) {
            value -= result + bit;
            result += (bit << 1);
        }
        result >>= 1;
        bit >>= 2;
    }
    return result;
}

/*!
    \class QFixedPt
    \brief The QFixedPt class represents fixed-point numbers within a 32-bit integer with a configurable precision.

    The template parameter is the number of bits of precision after
    the decimal point.  For example, QFixedPt<5> indicates that there
    are 27 bits before the decimal point, and 5 bits of precision after
    the decimal point.
*/

/*!
    \fn QFixedPt::QFixedPt()

    Constructs a default fixed-point number.  The initial value
    is undefined.
*/

/*!
    \fn QFixedPt::QFixedPt(int value)

    Constructs a fixed-point number from the integer \a value.
*/

/*!
    \fn QFixedPt::QFixedPt(qreal value)

    Constructs a fixed-point number from the floating-point \a value.
*/

/*!
    \fn QFixedPt<PrecBits>& QFixedPt::operator=(int value)

    Assigns the integer \a value to this fixed-point variable.
*/

/*!
    \fn QFixedPt<PrecBits>& QFixedPt::operator=(qreal value)

    Assigns the floating-point \a value to this fixed-point variable.
*/

/*!
    \fn int QFixedPt::bits() const

    Returns the raw bits that represent the fixed-point value of this object.

    \sa setBits()
*/

/*!
    \fn void QFixedPt::setBits(int value)

    Sets the raw bits that represent the fixed-point value of
    this object to \a value.

    \sa bits()
*/

#if !defined(QT_NO_MEMBER_TEMPLATES) || defined(Q_QDOC)

/*!
    \fn QFixedPt<Prec> QFixedPt::toPrecision() const

    Returns this fixed-point number, converted to the new fixed-point
    precision Prec.

    \sa qFixedPtToPrecision()
*/

#endif

/*!
    \fn QFixedPt<Prec> qFixedPtToPrecision(const QFixedPt<PrecBits>& value)

    Returns the fixed-point number \a value, converted to the new fixed-point
    precision Prec.

    \sa QFixedPt::toPrecision()
*/

/*!
    \fn QFixedPt<PrecBits>& QFixedPt::operator+=(const QFixedPt<PrecBits>& value)

    Adds \a value to this fixed-point number.
*/

/*!
    \fn QFixedPt<PrecBits>& QFixedPt::operator+=(int value)

    Adds an integer \a value to this fixed-point number.
*/

/*!
    \fn QFixedPt<PrecBits>& QFixedPt::operator+=(qreal value)

    Adds a floating-point \a value to this fixed-point number.
*/

/*!
    \fn QFixedPt<PrecBits>& QFixedPt::operator-=(const QFixedPt<PrecBits>& value)

    Subtracts \a value from this fixed-point number.
*/

/*!
    \fn QFixedPt<PrecBits>& QFixedPt::operator-=(int value)

    Subtracts an integer \a value from this fixed-point number.
*/

/*!
    \fn QFixedPt<PrecBits>& QFixedPt::operator-=(qreal value)

    Subtracts a floating-point \a value from this fixed-point number.
*/

/*!
    \fn QFixedPt<PrecBits>& QFixedPt::operator*=(const QFixedPt<PrecBits>& value)

    Multiplies this fixed-point number by \a value.
*/

/*!
    \fn QFixedPt<PrecBits>& QFixedPt::operator*=(int value)

    Multiplies this fixed-point number by an integer \a value.
*/

/*!
    \fn QFixedPt<PrecBits>& QFixedPt::operator*=(qreal value)

    Multiplies this fixed-point number by a floating-point \a value.
*/

/*!
    \fn QFixedPt<PrecBits>& QFixedPt::operator/=(const QFixedPt<PrecBits>& value)

    Divides this fixed-point number by \a value.  Division by zero
    will result in zero.
*/

/*!
    \fn QFixedPt<PrecBits>& QFixedPt::operator/=(int value)

    Divides this fixed-point number by an integer \a value.  Division
    by zero will result in zero.
*/

/*!
    \fn QFixedPt<PrecBits>& QFixedPt::operator/=(qreal value)

    Divides this fixed-point number by a floating-point \a value.  Division
    by zero will result in zero.
*/

/*!
    \fn QFixedPt<PrecBits>& QFixedPt::operator<<=(int value)

    Shifts this fixed-point number left by \a value bits.
*/

/*!
    \fn QFixedPt<PrecBits>& QFixedPt::operator>>=(int value)

    Shifts this fixed-point number right by \a value bits.
*/

/*!
    \fn QFixedPt<PrecBits> QFixedPt::operator<<(int value) const

    Returns the result of shifting this fixed-point number
    left by \a value bits.
*/

/*!
    \fn QFixedPt<PrecBits> QFixedPt::operator>>(int value) const

    Returns the result of shifting this fixed-point number
    right by \a value bits.
*/

/*!
    \fn bool QFixedPt::operator==(const QFixedPt<PrecBits>& value) const

    Returns true if this fixed-point number is equal to \a value;
    false otherwise.
*/

/*!
    \fn bool operator==(const QFixedPt<PrecBits>& v1, int v2)
    \relates QFixedPt

    Returns true if \a v1 is equal to \a v2; false otherwise.
*/

/*!
    \fn bool operator==(int v1, const QFixedPt<PrecBits>& v2)
    \relates QFixedPt

    Returns true if \a v1 is equal to \a v2; false otherwise.
*/

/*!
    \fn bool operator==(const QFixedPt<PrecBits>& v1, qreal v2)
    \relates QFixedPt

    Returns true if \a v1 is equal to \a v2; false otherwise.
*/

/*!
    \fn bool operator==(qreal v1, const QFixedPt<PrecBits>& v2)
    \relates QFixedPt

    Returns true if \a v1 is equal to \a v2; false otherwise.
*/

/*!
    \fn bool QFixedPt::operator!=(const QFixedPt<PrecBits>& value) const

    Returns true if this fixed-point number is not equal to \a value;
    false otherwise.
*/

/*!
    \fn bool operator!=(const QFixedPt<PrecBits>& v1, int v2)
    \relates QFixedPt

    Returns true if \a v1 is not equal to \a v2; false otherwise.
*/

/*!
    \fn bool operator!=(int v1, const QFixedPt<PrecBits>& v2)
    \relates QFixedPt

    Returns true if \a v1 is not equal to \a v2; false otherwise.
*/

/*!
    \fn bool operator!=(const QFixedPt<PrecBits>& v1, qreal v2)
    \relates QFixedPt

    Returns true if \a v1 is not equal to \a v2; false otherwise.
*/

/*!
    \fn bool operator!=(qreal v1, const QFixedPt<PrecBits>& v2)
    \relates QFixedPt

    Returns true if \a v1 is not equal to \a v2; false otherwise.
*/

/*!
    \fn bool QFixedPt::operator<=(const QFixedPt<PrecBits>& value) const

    Returns true if this fixed-point number is less than or equal to
    \a value; false otherwise.
*/

/*!
    \fn bool operator<=(const QFixedPt<PrecBits>& v1, int v2)
    \relates QFixedPt

    Returns true if \a v1 is less than or equal to \a v2; false otherwise.
*/

/*!
    \fn bool operator<=(int v1, const QFixedPt<PrecBits>& v2)
    \relates QFixedPt

    Returns true if \a v1 is less than or equal to \a v2; false otherwise.
*/

/*!
    \fn bool operator<=(const QFixedPt<PrecBits>& v1, qreal v2)
    \relates QFixedPt

    Returns true if \a v1 is less than or equal to \a v2; false otherwise.
*/

/*!
    \fn bool operator<=(qreal v1, const QFixedPt<PrecBits>& v2)
    \relates QFixedPt

    Returns true if \a v1 is less than or equal to \a v2; false otherwise.
*/

/*!
    \fn bool QFixedPt::operator<(const QFixedPt<PrecBits>& value) const

    Returns true if this fixed-point number is less than \a value;
    false otherwise.
*/

/*!
    \fn bool operator<(const QFixedPt<PrecBits>& v1, int v2)
    \relates QFixedPt

    Returns true if \a v1 is less than \a v2; false otherwise.
*/

/*!
    \fn bool operator<(int v1, const QFixedPt<PrecBits>& v2)
    \relates QFixedPt

    Returns true if \a v1 is less than \a v2; false otherwise.
*/

/*!
    \fn bool operator<(const QFixedPt<PrecBits>& v1, qreal v2)
    \relates QFixedPt

    Returns true if \a v1 is less than \a v2; false otherwise.
*/

/*!
    \fn bool operator<(qreal v1, const QFixedPt<PrecBits>& v2)
    \relates QFixedPt

    Returns true if \a v1 is less than \a v2; false otherwise.
*/

/*!
    \fn bool QFixedPt::operator>=(const QFixedPt<PrecBits>& value) const

    Returns true if this fixed-point number is greater than or equal to
    \a value; false otherwise.
*/

/*!
    \fn bool operator>=(const QFixedPt<PrecBits>& v1, int v2)
    \relates QFixedPt

    Returns true if \a v1 is greater than or equal to \a v2; false otherwise.
*/

/*!
    \fn bool operator>=(int v1, const QFixedPt<PrecBits>& v2)
    \relates QFixedPt

    Returns true if \a v1 is greater than or equal to \a v2; false otherwise.
*/

/*!
    \fn bool operator>=(const QFixedPt<PrecBits>& v1, qreal v2)
    \relates QFixedPt

    Returns true if \a v1 is greater than or equal to \a v2; false otherwise.
*/

/*!
    \fn bool operator>=(qreal v1, const QFixedPt<PrecBits>& v2)
    \relates QFixedPt

    Returns true if \a v1 is greater than or equal to \a v2; false otherwise.
*/

/*!
    \fn bool QFixedPt::operator>(const QFixedPt<PrecBits>& value) const

    Returns true if this fixed-point number is greater than \a value;
    false otherwise.
*/

/*!
    \fn bool operator>(const QFixedPt<PrecBits>& v1, int v2)
    \relates QFixedPt

    Returns true if \a v1 is greater than \a v2; false otherwise.
*/

/*!
    \fn bool operator>(int v1, const QFixedPt<PrecBits>& v2)
    \relates QFixedPt

    Returns true if \a v1 is greater than \a v2; false otherwise.
*/

/*!
    \fn bool operator>(const QFixedPt<PrecBits>& v1, qreal v2)
    \relates QFixedPt

    Returns true if \a v1 is greater than \a v2; false otherwise.
*/

/*!
    \fn bool operator>(qreal v1, const QFixedPt<PrecBits>& v2)
    \relates QFixedPt

    Returns true if \a v1 is greater than \a v2; false otherwise.
*/

/*!
    \fn QFixedPt<PrecBits> QFixedPt::operator+(const QFixedPt<PrecBits>& value) const

    Returns the result of adding this fixed-point number and \a value.
*/

/*!
    \fn QFixedPt<PrecBits> QFixedPt::operator+(int value) const

    Returns the result of adding this fixed-point number and \a value.
*/

/*!
    \fn QFixedPt<PrecBits> QFixedPt::operator+(qreal value) const

    Returns the result of adding this fixed-point number and \a value.
*/

/*!
    \fn QFixedPt<PrecBits> operator+(int v1, const QFixedPt<PrecBits>& v2)
    \relates QFixedPt

    Returns the result of adding \a v1 and \a v2.
*/

/*!
    \fn QFixedPt<PrecBits> operator+(qreal v1, const QFixedPt<PrecBits>& v2)
    \relates QFixedPt

    Returns the result of adding \a v1 and \a v2.
*/

/*!
    \fn QFixedPt<PrecBits> QFixedPt::operator-(const QFixedPt<PrecBits>& value) const

    Returns the result of subtracting \a value from this fixed-point number.
*/

/*!
    \fn QFixedPt<PrecBits> QFixedPt::operator-(int value) const

    Returns the result of subtracting \a value from this fixed-point number.
*/

/*!
    \fn QFixedPt<PrecBits> QFixedPt::operator-(qreal value) const

    Returns the result of subtracting \a value from this fixed-point number.
*/

/*!
    \fn QFixedPt<PrecBits> operator-(int v1, const QFixedPt<PrecBits>& v2)
    \relates QFixedPt

    Returns the result of subtracting \a v2 from \a v1.
*/

/*!
    \fn QFixedPt<PrecBits> operator-(qreal v1, const QFixedPt<PrecBits>& v2)
    \relates QFixedPt

    Returns the result of subtracting \a v2 from \a v1.
*/

/*!
    \fn QFixedPt<PrecBits> QFixedPt::operator*(const QFixedPt<PrecBits>& value) const

    Returns the result of multiplying this fixed-point number by \a value.
*/

/*!
    \fn QFixedPt<PrecBits> QFixedPt::operator*(int value) const

    Returns the result of multiplying this fixed-point number by \a value.
*/

/*!
    \fn QFixedPt<PrecBits> QFixedPt::operator*(qreal value) const

    Returns the result of multiplying this fixed-point number by \a value.
*/

/*!
    \fn QFixedPt<PrecBits> operator*(int v1, const QFixedPt<PrecBits>& v2)
    \relates QFixedPt

    Returns the result of multiplying \a v1 by \a v2.
*/

/*!
    \fn QFixedPt<PrecBits> operator*(qreal v1, const QFixedPt<PrecBits>& v2)
    \relates QFixedPt

    Returns the result of multiplying \a v1 by \a v2.
*/

/*!
    \fn QFixedPt<PrecBits> QFixedPt::operator/(const QFixedPt<PrecBits>& value) const

    Returns the result of dividing this fixed-point number by \a value.
    Division by zero will result in zero.
*/

/*!
    \fn QFixedPt<PrecBits> QFixedPt::operator/(int value) const

    Returns the result of dividing this fixed-point number by \a value.
    Division by zero will result in zero.
*/

/*!
    \fn QFixedPt<PrecBits> QFixedPt::operator/(qreal value) const

    Returns the result of dividing this fixed-point number by \a value.
    Division by zero will result in zero.
*/

/*!
    \fn QFixedPt<PrecBits> operator/(int v1, const QFixedPt<PrecBits>& v2)
    \relates QFixedPt

    Returns the result of dividing \a v1 by \a v2.  Division by zero will
    result in zero.
*/

/*!
    \fn QFixedPt<PrecBits> operator/(qreal v1, const QFixedPt<PrecBits>& v2)
    \relates QFixedPt

    Returns the result of dividing \a v1 by \a v2.  Division by zero will
    result in zero.
*/

/*!
    \fn QFixedPt<PrecBits> QFixedPt::operator-() const

    Returns the negation of this fixed-point number.
*/

/*!
    \fn QFixedPt<PrecBits> QFixedPt::sqrt() const

    Returns the square root of this fixed-point number.

    \sa sqrtF()
*/

/*!
    \fn qreal QFixedPt::sqrtF() const

    Return the square root of this fixed-point number as a
    floating-point value.

    \sa sqrt()
*/

/*!
    \fn QFixedPt<PrecBits> QFixedPt::round() const

    Returns this fixed-point number, rounded to the nearest integer.

    \sa floor(), ceil(), truncate()
*/

/*!
    \fn QFixedPt<PrecBits> QFixedPt::floor() const;

    Returns the largest integer that is less than or equal to
    this fixed-point number.

    \sa round(), ceil(), truncate()
*/

/*!
    \fn QFixedPt<PrecBits> QFixedPt::ceil() const

    Returns the smallest integer that is greater than or equal to
    this fixed-point number.

    \sa round(), floor(), truncate()
*/

/*!
    \fn int QFixedPt::truncate() const

    Returns this fixed-point number with the bits after the
    decimal point truncated.

    \sa round(), floor(), ceil()
*/

/*!
    \fn int QFixedPt::toInt() const

    Returns this fixed-point number, rounded to the nearest integer.

    \sa toReal()
*/

/*!
    \fn qreal QFixedPt::toReal() const

    Returns this fixed-point number as a floating-point value.

    \sa toInt()
*/

/*!
    \fn int qCeil(const QFixedPt<PrecBits>& value)
    \relates QFixedPt

    Returns the smallest integer that is greater than or equal to
    \a value.

    \sa qFloor(), qRound(), QFixedPt::ceil()
*/

/*!
    \fn int qFloor(const QFixedPt<PrecBits>& value)
    \relates QFixedPt

    Returns the largest integer that is less than or equal to
    \a value.

    \sa qCeil(), qRound(), QFixedPt::floor()
*/

/*!
    \fn int qRound(const QFixedPt<PrecBits>& value)
    \relates QFixedPt

    Returns \a value, rounded to the nearest integer.

    \sa qCeil(), qFloor(), QFixedPt::round()
*/

/*!
    \fn bool qFuzzyCompare(const QFixedPt<PrecBits>& v1, const QFixedPt<PrecBits>& v2, int compareBits)
    \relates QFixedPt

    Returns true if \a v1 is almost equal to \a v2; false otherwise.
    The \a compareBits parameter specifies the number of bits of precision
    that should be considered relevant when performing the comparison.
    By default, \a compareBits is PrecBits / 4.
*/

/*!
    \fn bool qIsNull(const QFixedPt<PrecBits>& v)
    \relates QFixedPt

    Returns true if \a v is zero; false otherwise.
*/

QT_END_NAMESPACE