long.ts
34.6 KB
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
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
import type { EJSONOptions } from './extended_json';
import { isObjectLike } from './parser/utils';
import type { Timestamp } from './timestamp';
interface LongWASMHelpers {
/** Gets the high bits of the last operation performed */
get_high(): number;
div_u(lowBits: number, highBits: number, lowBitsDivisor: number, highBitsDivisor: number): number;
div_s(lowBits: number, highBits: number, lowBitsDivisor: number, highBitsDivisor: number): number;
rem_u(lowBits: number, highBits: number, lowBitsDivisor: number, highBitsDivisor: number): number;
rem_s(lowBits: number, highBits: number, lowBitsDivisor: number, highBitsDivisor: number): number;
mul(
lowBits: number,
highBits: number,
lowBitsMultiplier: number,
highBitsMultiplier: number
): number;
}
/**
* wasm optimizations, to do native i64 multiplication and divide
*/
let wasm: LongWASMHelpers | undefined = undefined;
/* We do not want to have to include DOM types just for this check */
// eslint-disable-next-line @typescript-eslint/no-explicit-any
declare const WebAssembly: any;
try {
wasm = new WebAssembly.Instance(
new WebAssembly.Module(
// prettier-ignore
new Uint8Array([0, 97, 115, 109, 1, 0, 0, 0, 1, 13, 2, 96, 0, 1, 127, 96, 4, 127, 127, 127, 127, 1, 127, 3, 7, 6, 0, 1, 1, 1, 1, 1, 6, 6, 1, 127, 1, 65, 0, 11, 7, 50, 6, 3, 109, 117, 108, 0, 1, 5, 100, 105, 118, 95, 115, 0, 2, 5, 100, 105, 118, 95, 117, 0, 3, 5, 114, 101, 109, 95, 115, 0, 4, 5, 114, 101, 109, 95, 117, 0, 5, 8, 103, 101, 116, 95, 104, 105, 103, 104, 0, 0, 10, 191, 1, 6, 4, 0, 35, 0, 11, 36, 1, 1, 126, 32, 0, 173, 32, 1, 173, 66, 32, 134, 132, 32, 2, 173, 32, 3, 173, 66, 32, 134, 132, 126, 34, 4, 66, 32, 135, 167, 36, 0, 32, 4, 167, 11, 36, 1, 1, 126, 32, 0, 173, 32, 1, 173, 66, 32, 134, 132, 32, 2, 173, 32, 3, 173, 66, 32, 134, 132, 127, 34, 4, 66, 32, 135, 167, 36, 0, 32, 4, 167, 11, 36, 1, 1, 126, 32, 0, 173, 32, 1, 173, 66, 32, 134, 132, 32, 2, 173, 32, 3, 173, 66, 32, 134, 132, 128, 34, 4, 66, 32, 135, 167, 36, 0, 32, 4, 167, 11, 36, 1, 1, 126, 32, 0, 173, 32, 1, 173, 66, 32, 134, 132, 32, 2, 173, 32, 3, 173, 66, 32, 134, 132, 129, 34, 4, 66, 32, 135, 167, 36, 0, 32, 4, 167, 11, 36, 1, 1, 126, 32, 0, 173, 32, 1, 173, 66, 32, 134, 132, 32, 2, 173, 32, 3, 173, 66, 32, 134, 132, 130, 34, 4, 66, 32, 135, 167, 36, 0, 32, 4, 167, 11])
),
{}
).exports as unknown as LongWASMHelpers;
} catch {
// no wasm support
}
const TWO_PWR_16_DBL = 1 << 16;
const TWO_PWR_24_DBL = 1 << 24;
const TWO_PWR_32_DBL = TWO_PWR_16_DBL * TWO_PWR_16_DBL;
const TWO_PWR_64_DBL = TWO_PWR_32_DBL * TWO_PWR_32_DBL;
const TWO_PWR_63_DBL = TWO_PWR_64_DBL / 2;
/** A cache of the Long representations of small integer values. */
const INT_CACHE: { [key: number]: Long } = {};
/** A cache of the Long representations of small unsigned integer values. */
const UINT_CACHE: { [key: number]: Long } = {};
/** @public */
export interface LongExtended {
$numberLong: string;
}
/**
* A class representing a 64-bit integer
* @public
* @category BSONType
* @remarks
* The internal representation of a long is the two given signed, 32-bit values.
* We use 32-bit pieces because these are the size of integers on which
* Javascript performs bit-operations. For operations like addition and
* multiplication, we split each number into 16 bit pieces, which can easily be
* multiplied within Javascript's floating-point representation without overflow
* or change in sign.
* In the algorithms below, we frequently reduce the negative case to the
* positive case by negating the input(s) and then post-processing the result.
* Note that we must ALWAYS check specially whether those values are MIN_VALUE
* (-2^63) because -MIN_VALUE == MIN_VALUE (since 2^63 cannot be represented as
* a positive number, it overflows back into a negative). Not handling this
* case would often result in infinite recursion.
* Common constant values ZERO, ONE, NEG_ONE, etc. are found as static properties on this class.
*/
export class Long {
_bsontype!: 'Long';
/** An indicator used to reliably determine if an object is a Long or not. */
__isLong__!: true;
/**
* The high 32 bits as a signed value.
*/
high!: number;
/**
* The low 32 bits as a signed value.
*/
low!: number;
/**
* Whether unsigned or not.
*/
unsigned!: boolean;
/**
* Constructs a 64 bit two's-complement integer, given its low and high 32 bit values as *signed* integers.
* See the from* functions below for more convenient ways of constructing Longs.
*
* Acceptable signatures are:
* - Long(low, high, unsigned?)
* - Long(bigint, unsigned?)
* - Long(string, unsigned?)
*
* @param low - The low (signed) 32 bits of the long
* @param high - The high (signed) 32 bits of the long
* @param unsigned - Whether unsigned or not, defaults to signed
*/
constructor(low: number | bigint | string = 0, high?: number | boolean, unsigned?: boolean) {
if (!(this instanceof Long)) return new Long(low, high, unsigned);
if (typeof low === 'bigint') {
Object.assign(this, Long.fromBigInt(low, !!high));
} else if (typeof low === 'string') {
Object.assign(this, Long.fromString(low, !!high));
} else {
this.low = low | 0;
this.high = (high as number) | 0;
this.unsigned = !!unsigned;
}
Object.defineProperty(this, '__isLong__', {
value: true,
configurable: false,
writable: false,
enumerable: false
});
}
static TWO_PWR_24 = Long.fromInt(TWO_PWR_24_DBL);
/** Maximum unsigned value. */
static MAX_UNSIGNED_VALUE = Long.fromBits(0xffffffff | 0, 0xffffffff | 0, true);
/** Signed zero */
static ZERO = Long.fromInt(0);
/** Unsigned zero. */
static UZERO = Long.fromInt(0, true);
/** Signed one. */
static ONE = Long.fromInt(1);
/** Unsigned one. */
static UONE = Long.fromInt(1, true);
/** Signed negative one. */
static NEG_ONE = Long.fromInt(-1);
/** Maximum signed value. */
static MAX_VALUE = Long.fromBits(0xffffffff | 0, 0x7fffffff | 0, false);
/** Minimum signed value. */
static MIN_VALUE = Long.fromBits(0, 0x80000000 | 0, false);
/**
* Returns a Long representing the 64 bit integer that comes by concatenating the given low and high bits.
* Each is assumed to use 32 bits.
* @param lowBits - The low 32 bits
* @param highBits - The high 32 bits
* @param unsigned - Whether unsigned or not, defaults to signed
* @returns The corresponding Long value
*/
static fromBits(lowBits: number, highBits: number, unsigned?: boolean): Long {
return new Long(lowBits, highBits, unsigned);
}
/**
* Returns a Long representing the given 32 bit integer value.
* @param value - The 32 bit integer in question
* @param unsigned - Whether unsigned or not, defaults to signed
* @returns The corresponding Long value
*/
static fromInt(value: number, unsigned?: boolean): Long {
let obj, cachedObj, cache;
if (unsigned) {
value >>>= 0;
if ((cache = 0 <= value && value < 256)) {
cachedObj = UINT_CACHE[value];
if (cachedObj) return cachedObj;
}
obj = Long.fromBits(value, (value | 0) < 0 ? -1 : 0, true);
if (cache) UINT_CACHE[value] = obj;
return obj;
} else {
value |= 0;
if ((cache = -128 <= value && value < 128)) {
cachedObj = INT_CACHE[value];
if (cachedObj) return cachedObj;
}
obj = Long.fromBits(value, value < 0 ? -1 : 0, false);
if (cache) INT_CACHE[value] = obj;
return obj;
}
}
/**
* Returns a Long representing the given value, provided that it is a finite number. Otherwise, zero is returned.
* @param value - The number in question
* @param unsigned - Whether unsigned or not, defaults to signed
* @returns The corresponding Long value
*/
static fromNumber(value: number, unsigned?: boolean): Long {
if (isNaN(value)) return unsigned ? Long.UZERO : Long.ZERO;
if (unsigned) {
if (value < 0) return Long.UZERO;
if (value >= TWO_PWR_64_DBL) return Long.MAX_UNSIGNED_VALUE;
} else {
if (value <= -TWO_PWR_63_DBL) return Long.MIN_VALUE;
if (value + 1 >= TWO_PWR_63_DBL) return Long.MAX_VALUE;
}
if (value < 0) return Long.fromNumber(-value, unsigned).neg();
return Long.fromBits(value % TWO_PWR_32_DBL | 0, (value / TWO_PWR_32_DBL) | 0, unsigned);
}
/**
* Returns a Long representing the given value, provided that it is a finite number. Otherwise, zero is returned.
* @param value - The number in question
* @param unsigned - Whether unsigned or not, defaults to signed
* @returns The corresponding Long value
*/
static fromBigInt(value: bigint, unsigned?: boolean): Long {
return Long.fromString(value.toString(), unsigned);
}
/**
* Returns a Long representation of the given string, written using the specified radix.
* @param str - The textual representation of the Long
* @param unsigned - Whether unsigned or not, defaults to signed
* @param radix - The radix in which the text is written (2-36), defaults to 10
* @returns The corresponding Long value
*/
static fromString(str: string, unsigned?: boolean, radix?: number): Long {
if (str.length === 0) throw Error('empty string');
if (str === 'NaN' || str === 'Infinity' || str === '+Infinity' || str === '-Infinity')
return Long.ZERO;
if (typeof unsigned === 'number') {
// For goog.math.long compatibility
(radix = unsigned), (unsigned = false);
} else {
unsigned = !!unsigned;
}
radix = radix || 10;
if (radix < 2 || 36 < radix) throw RangeError('radix');
let p;
if ((p = str.indexOf('-')) > 0) throw Error('interior hyphen');
else if (p === 0) {
return Long.fromString(str.substring(1), unsigned, radix).neg();
}
// Do several (8) digits each time through the loop, so as to
// minimize the calls to the very expensive emulated div.
const radixToPower = Long.fromNumber(Math.pow(radix, 8));
let result = Long.ZERO;
for (let i = 0; i < str.length; i += 8) {
const size = Math.min(8, str.length - i),
value = parseInt(str.substring(i, i + size), radix);
if (size < 8) {
const power = Long.fromNumber(Math.pow(radix, size));
result = result.mul(power).add(Long.fromNumber(value));
} else {
result = result.mul(radixToPower);
result = result.add(Long.fromNumber(value));
}
}
result.unsigned = unsigned;
return result;
}
/**
* Creates a Long from its byte representation.
* @param bytes - Byte representation
* @param unsigned - Whether unsigned or not, defaults to signed
* @param le - Whether little or big endian, defaults to big endian
* @returns The corresponding Long value
*/
static fromBytes(bytes: number[], unsigned?: boolean, le?: boolean): Long {
return le ? Long.fromBytesLE(bytes, unsigned) : Long.fromBytesBE(bytes, unsigned);
}
/**
* Creates a Long from its little endian byte representation.
* @param bytes - Little endian byte representation
* @param unsigned - Whether unsigned or not, defaults to signed
* @returns The corresponding Long value
*/
static fromBytesLE(bytes: number[], unsigned?: boolean): Long {
return new Long(
bytes[0] | (bytes[1] << 8) | (bytes[2] << 16) | (bytes[3] << 24),
bytes[4] | (bytes[5] << 8) | (bytes[6] << 16) | (bytes[7] << 24),
unsigned
);
}
/**
* Creates a Long from its big endian byte representation.
* @param bytes - Big endian byte representation
* @param unsigned - Whether unsigned or not, defaults to signed
* @returns The corresponding Long value
*/
static fromBytesBE(bytes: number[], unsigned?: boolean): Long {
return new Long(
(bytes[4] << 24) | (bytes[5] << 16) | (bytes[6] << 8) | bytes[7],
(bytes[0] << 24) | (bytes[1] << 16) | (bytes[2] << 8) | bytes[3],
unsigned
);
}
/**
* Tests if the specified object is a Long.
*/
// eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/explicit-module-boundary-types
static isLong(value: any): value is Long {
return isObjectLike(value) && value['__isLong__'] === true;
}
/**
* Converts the specified value to a Long.
* @param unsigned - Whether unsigned or not, defaults to signed
*/
static fromValue(
val: number | string | { low: number; high: number; unsigned?: boolean },
unsigned?: boolean
): Long {
if (typeof val === 'number') return Long.fromNumber(val, unsigned);
if (typeof val === 'string') return Long.fromString(val, unsigned);
// Throws for non-objects, converts non-instanceof Long:
return Long.fromBits(
val.low,
val.high,
typeof unsigned === 'boolean' ? unsigned : val.unsigned
);
}
/** Returns the sum of this and the specified Long. */
add(addend: string | number | Long | Timestamp): Long {
if (!Long.isLong(addend)) addend = Long.fromValue(addend);
// Divide each number into 4 chunks of 16 bits, and then sum the chunks.
const a48 = this.high >>> 16;
const a32 = this.high & 0xffff;
const a16 = this.low >>> 16;
const a00 = this.low & 0xffff;
const b48 = addend.high >>> 16;
const b32 = addend.high & 0xffff;
const b16 = addend.low >>> 16;
const b00 = addend.low & 0xffff;
let c48 = 0,
c32 = 0,
c16 = 0,
c00 = 0;
c00 += a00 + b00;
c16 += c00 >>> 16;
c00 &= 0xffff;
c16 += a16 + b16;
c32 += c16 >>> 16;
c16 &= 0xffff;
c32 += a32 + b32;
c48 += c32 >>> 16;
c32 &= 0xffff;
c48 += a48 + b48;
c48 &= 0xffff;
return Long.fromBits((c16 << 16) | c00, (c48 << 16) | c32, this.unsigned);
}
/**
* Returns the sum of this and the specified Long.
* @returns Sum
*/
and(other: string | number | Long | Timestamp): Long {
if (!Long.isLong(other)) other = Long.fromValue(other);
return Long.fromBits(this.low & other.low, this.high & other.high, this.unsigned);
}
/**
* Compares this Long's value with the specified's.
* @returns 0 if they are the same, 1 if the this is greater and -1 if the given one is greater
*/
compare(other: string | number | Long | Timestamp): 0 | 1 | -1 {
if (!Long.isLong(other)) other = Long.fromValue(other);
if (this.eq(other)) return 0;
const thisNeg = this.isNegative(),
otherNeg = other.isNegative();
if (thisNeg && !otherNeg) return -1;
if (!thisNeg && otherNeg) return 1;
// At this point the sign bits are the same
if (!this.unsigned) return this.sub(other).isNegative() ? -1 : 1;
// Both are positive if at least one is unsigned
return other.high >>> 0 > this.high >>> 0 ||
(other.high === this.high && other.low >>> 0 > this.low >>> 0)
? -1
: 1;
}
/** This is an alias of {@link Long.compare} */
comp(other: string | number | Long | Timestamp): 0 | 1 | -1 {
return this.compare(other);
}
/**
* Returns this Long divided by the specified. The result is signed if this Long is signed or unsigned if this Long is unsigned.
* @returns Quotient
*/
divide(divisor: string | number | Long | Timestamp): Long {
if (!Long.isLong(divisor)) divisor = Long.fromValue(divisor);
if (divisor.isZero()) throw Error('division by zero');
// use wasm support if present
if (wasm) {
// guard against signed division overflow: the largest
// negative number / -1 would be 1 larger than the largest
// positive number, due to two's complement.
if (
!this.unsigned &&
this.high === -0x80000000 &&
divisor.low === -1 &&
divisor.high === -1
) {
// be consistent with non-wasm code path
return this;
}
const low = (this.unsigned ? wasm.div_u : wasm.div_s)(
this.low,
this.high,
divisor.low,
divisor.high
);
return Long.fromBits(low, wasm.get_high(), this.unsigned);
}
if (this.isZero()) return this.unsigned ? Long.UZERO : Long.ZERO;
let approx, rem, res;
if (!this.unsigned) {
// This section is only relevant for signed longs and is derived from the
// closure library as a whole.
if (this.eq(Long.MIN_VALUE)) {
if (divisor.eq(Long.ONE) || divisor.eq(Long.NEG_ONE)) return Long.MIN_VALUE;
// recall that -MIN_VALUE == MIN_VALUE
else if (divisor.eq(Long.MIN_VALUE)) return Long.ONE;
else {
// At this point, we have |other| >= 2, so |this/other| < |MIN_VALUE|.
const halfThis = this.shr(1);
approx = halfThis.div(divisor).shl(1);
if (approx.eq(Long.ZERO)) {
return divisor.isNegative() ? Long.ONE : Long.NEG_ONE;
} else {
rem = this.sub(divisor.mul(approx));
res = approx.add(rem.div(divisor));
return res;
}
}
} else if (divisor.eq(Long.MIN_VALUE)) return this.unsigned ? Long.UZERO : Long.ZERO;
if (this.isNegative()) {
if (divisor.isNegative()) return this.neg().div(divisor.neg());
return this.neg().div(divisor).neg();
} else if (divisor.isNegative()) return this.div(divisor.neg()).neg();
res = Long.ZERO;
} else {
// The algorithm below has not been made for unsigned longs. It's therefore
// required to take special care of the MSB prior to running it.
if (!divisor.unsigned) divisor = divisor.toUnsigned();
if (divisor.gt(this)) return Long.UZERO;
if (divisor.gt(this.shru(1)))
// 15 >>> 1 = 7 ; with divisor = 8 ; true
return Long.UONE;
res = Long.UZERO;
}
// Repeat the following until the remainder is less than other: find a
// floating-point that approximates remainder / other *from below*, add this
// into the result, and subtract it from the remainder. It is critical that
// the approximate value is less than or equal to the real value so that the
// remainder never becomes negative.
rem = this;
while (rem.gte(divisor)) {
// Approximate the result of division. This may be a little greater or
// smaller than the actual value.
approx = Math.max(1, Math.floor(rem.toNumber() / divisor.toNumber()));
// We will tweak the approximate result by changing it in the 48-th digit or
// the smallest non-fractional digit, whichever is larger.
const log2 = Math.ceil(Math.log(approx) / Math.LN2);
const delta = log2 <= 48 ? 1 : Math.pow(2, log2 - 48);
// Decrease the approximation until it is smaller than the remainder. Note
// that if it is too large, the product overflows and is negative.
let approxRes = Long.fromNumber(approx);
let approxRem = approxRes.mul(divisor);
while (approxRem.isNegative() || approxRem.gt(rem)) {
approx -= delta;
approxRes = Long.fromNumber(approx, this.unsigned);
approxRem = approxRes.mul(divisor);
}
// We know the answer can't be zero... and actually, zero would cause
// infinite recursion since we would make no progress.
if (approxRes.isZero()) approxRes = Long.ONE;
res = res.add(approxRes);
rem = rem.sub(approxRem);
}
return res;
}
/**This is an alias of {@link Long.divide} */
div(divisor: string | number | Long | Timestamp): Long {
return this.divide(divisor);
}
/**
* Tests if this Long's value equals the specified's.
* @param other - Other value
*/
equals(other: string | number | Long | Timestamp): boolean {
if (!Long.isLong(other)) other = Long.fromValue(other);
if (this.unsigned !== other.unsigned && this.high >>> 31 === 1 && other.high >>> 31 === 1)
return false;
return this.high === other.high && this.low === other.low;
}
/** This is an alias of {@link Long.equals} */
eq(other: string | number | Long | Timestamp): boolean {
return this.equals(other);
}
/** Gets the high 32 bits as a signed integer. */
getHighBits(): number {
return this.high;
}
/** Gets the high 32 bits as an unsigned integer. */
getHighBitsUnsigned(): number {
return this.high >>> 0;
}
/** Gets the low 32 bits as a signed integer. */
getLowBits(): number {
return this.low;
}
/** Gets the low 32 bits as an unsigned integer. */
getLowBitsUnsigned(): number {
return this.low >>> 0;
}
/** Gets the number of bits needed to represent the absolute value of this Long. */
getNumBitsAbs(): number {
if (this.isNegative()) {
// Unsigned Longs are never negative
return this.eq(Long.MIN_VALUE) ? 64 : this.neg().getNumBitsAbs();
}
const val = this.high !== 0 ? this.high : this.low;
let bit: number;
for (bit = 31; bit > 0; bit--) if ((val & (1 << bit)) !== 0) break;
return this.high !== 0 ? bit + 33 : bit + 1;
}
/** Tests if this Long's value is greater than the specified's. */
greaterThan(other: string | number | Long | Timestamp): boolean {
return this.comp(other) > 0;
}
/** This is an alias of {@link Long.greaterThan} */
gt(other: string | number | Long | Timestamp): boolean {
return this.greaterThan(other);
}
/** Tests if this Long's value is greater than or equal the specified's. */
greaterThanOrEqual(other: string | number | Long | Timestamp): boolean {
return this.comp(other) >= 0;
}
/** This is an alias of {@link Long.greaterThanOrEqual} */
gte(other: string | number | Long | Timestamp): boolean {
return this.greaterThanOrEqual(other);
}
/** This is an alias of {@link Long.greaterThanOrEqual} */
ge(other: string | number | Long | Timestamp): boolean {
return this.greaterThanOrEqual(other);
}
/** Tests if this Long's value is even. */
isEven(): boolean {
return (this.low & 1) === 0;
}
/** Tests if this Long's value is negative. */
isNegative(): boolean {
return !this.unsigned && this.high < 0;
}
/** Tests if this Long's value is odd. */
isOdd(): boolean {
return (this.low & 1) === 1;
}
/** Tests if this Long's value is positive. */
isPositive(): boolean {
return this.unsigned || this.high >= 0;
}
/** Tests if this Long's value equals zero. */
isZero(): boolean {
return this.high === 0 && this.low === 0;
}
/** Tests if this Long's value is less than the specified's. */
lessThan(other: string | number | Long | Timestamp): boolean {
return this.comp(other) < 0;
}
/** This is an alias of {@link Long#lessThan}. */
lt(other: string | number | Long | Timestamp): boolean {
return this.lessThan(other);
}
/** Tests if this Long's value is less than or equal the specified's. */
lessThanOrEqual(other: string | number | Long | Timestamp): boolean {
return this.comp(other) <= 0;
}
/** This is an alias of {@link Long.lessThanOrEqual} */
lte(other: string | number | Long | Timestamp): boolean {
return this.lessThanOrEqual(other);
}
/** Returns this Long modulo the specified. */
modulo(divisor: string | number | Long | Timestamp): Long {
if (!Long.isLong(divisor)) divisor = Long.fromValue(divisor);
// use wasm support if present
if (wasm) {
const low = (this.unsigned ? wasm.rem_u : wasm.rem_s)(
this.low,
this.high,
divisor.low,
divisor.high
);
return Long.fromBits(low, wasm.get_high(), this.unsigned);
}
return this.sub(this.div(divisor).mul(divisor));
}
/** This is an alias of {@link Long.modulo} */
mod(divisor: string | number | Long | Timestamp): Long {
return this.modulo(divisor);
}
/** This is an alias of {@link Long.modulo} */
rem(divisor: string | number | Long | Timestamp): Long {
return this.modulo(divisor);
}
/**
* Returns the product of this and the specified Long.
* @param multiplier - Multiplier
* @returns Product
*/
multiply(multiplier: string | number | Long | Timestamp): Long {
if (this.isZero()) return Long.ZERO;
if (!Long.isLong(multiplier)) multiplier = Long.fromValue(multiplier);
// use wasm support if present
if (wasm) {
const low = wasm.mul(this.low, this.high, multiplier.low, multiplier.high);
return Long.fromBits(low, wasm.get_high(), this.unsigned);
}
if (multiplier.isZero()) return Long.ZERO;
if (this.eq(Long.MIN_VALUE)) return multiplier.isOdd() ? Long.MIN_VALUE : Long.ZERO;
if (multiplier.eq(Long.MIN_VALUE)) return this.isOdd() ? Long.MIN_VALUE : Long.ZERO;
if (this.isNegative()) {
if (multiplier.isNegative()) return this.neg().mul(multiplier.neg());
else return this.neg().mul(multiplier).neg();
} else if (multiplier.isNegative()) return this.mul(multiplier.neg()).neg();
// If both longs are small, use float multiplication
if (this.lt(Long.TWO_PWR_24) && multiplier.lt(Long.TWO_PWR_24))
return Long.fromNumber(this.toNumber() * multiplier.toNumber(), this.unsigned);
// Divide each long into 4 chunks of 16 bits, and then add up 4x4 products.
// We can skip products that would overflow.
const a48 = this.high >>> 16;
const a32 = this.high & 0xffff;
const a16 = this.low >>> 16;
const a00 = this.low & 0xffff;
const b48 = multiplier.high >>> 16;
const b32 = multiplier.high & 0xffff;
const b16 = multiplier.low >>> 16;
const b00 = multiplier.low & 0xffff;
let c48 = 0,
c32 = 0,
c16 = 0,
c00 = 0;
c00 += a00 * b00;
c16 += c00 >>> 16;
c00 &= 0xffff;
c16 += a16 * b00;
c32 += c16 >>> 16;
c16 &= 0xffff;
c16 += a00 * b16;
c32 += c16 >>> 16;
c16 &= 0xffff;
c32 += a32 * b00;
c48 += c32 >>> 16;
c32 &= 0xffff;
c32 += a16 * b16;
c48 += c32 >>> 16;
c32 &= 0xffff;
c32 += a00 * b32;
c48 += c32 >>> 16;
c32 &= 0xffff;
c48 += a48 * b00 + a32 * b16 + a16 * b32 + a00 * b48;
c48 &= 0xffff;
return Long.fromBits((c16 << 16) | c00, (c48 << 16) | c32, this.unsigned);
}
/** This is an alias of {@link Long.multiply} */
mul(multiplier: string | number | Long | Timestamp): Long {
return this.multiply(multiplier);
}
/** Returns the Negation of this Long's value. */
negate(): Long {
if (!this.unsigned && this.eq(Long.MIN_VALUE)) return Long.MIN_VALUE;
return this.not().add(Long.ONE);
}
/** This is an alias of {@link Long.negate} */
neg(): Long {
return this.negate();
}
/** Returns the bitwise NOT of this Long. */
not(): Long {
return Long.fromBits(~this.low, ~this.high, this.unsigned);
}
/** Tests if this Long's value differs from the specified's. */
notEquals(other: string | number | Long | Timestamp): boolean {
return !this.equals(other);
}
/** This is an alias of {@link Long.notEquals} */
neq(other: string | number | Long | Timestamp): boolean {
return this.notEquals(other);
}
/** This is an alias of {@link Long.notEquals} */
ne(other: string | number | Long | Timestamp): boolean {
return this.notEquals(other);
}
/**
* Returns the bitwise OR of this Long and the specified.
*/
or(other: number | string | Long): Long {
if (!Long.isLong(other)) other = Long.fromValue(other);
return Long.fromBits(this.low | other.low, this.high | other.high, this.unsigned);
}
/**
* Returns this Long with bits shifted to the left by the given amount.
* @param numBits - Number of bits
* @returns Shifted Long
*/
shiftLeft(numBits: number | Long): Long {
if (Long.isLong(numBits)) numBits = numBits.toInt();
if ((numBits &= 63) === 0) return this;
else if (numBits < 32)
return Long.fromBits(
this.low << numBits,
(this.high << numBits) | (this.low >>> (32 - numBits)),
this.unsigned
);
else return Long.fromBits(0, this.low << (numBits - 32), this.unsigned);
}
/** This is an alias of {@link Long.shiftLeft} */
shl(numBits: number | Long): Long {
return this.shiftLeft(numBits);
}
/**
* Returns this Long with bits arithmetically shifted to the right by the given amount.
* @param numBits - Number of bits
* @returns Shifted Long
*/
shiftRight(numBits: number | Long): Long {
if (Long.isLong(numBits)) numBits = numBits.toInt();
if ((numBits &= 63) === 0) return this;
else if (numBits < 32)
return Long.fromBits(
(this.low >>> numBits) | (this.high << (32 - numBits)),
this.high >> numBits,
this.unsigned
);
else return Long.fromBits(this.high >> (numBits - 32), this.high >= 0 ? 0 : -1, this.unsigned);
}
/** This is an alias of {@link Long.shiftRight} */
shr(numBits: number | Long): Long {
return this.shiftRight(numBits);
}
/**
* Returns this Long with bits logically shifted to the right by the given amount.
* @param numBits - Number of bits
* @returns Shifted Long
*/
shiftRightUnsigned(numBits: Long | number): Long {
if (Long.isLong(numBits)) numBits = numBits.toInt();
numBits &= 63;
if (numBits === 0) return this;
else {
const high = this.high;
if (numBits < 32) {
const low = this.low;
return Long.fromBits(
(low >>> numBits) | (high << (32 - numBits)),
high >>> numBits,
this.unsigned
);
} else if (numBits === 32) return Long.fromBits(high, 0, this.unsigned);
else return Long.fromBits(high >>> (numBits - 32), 0, this.unsigned);
}
}
/** This is an alias of {@link Long.shiftRightUnsigned} */
shr_u(numBits: number | Long): Long {
return this.shiftRightUnsigned(numBits);
}
/** This is an alias of {@link Long.shiftRightUnsigned} */
shru(numBits: number | Long): Long {
return this.shiftRightUnsigned(numBits);
}
/**
* Returns the difference of this and the specified Long.
* @param subtrahend - Subtrahend
* @returns Difference
*/
subtract(subtrahend: string | number | Long | Timestamp): Long {
if (!Long.isLong(subtrahend)) subtrahend = Long.fromValue(subtrahend);
return this.add(subtrahend.neg());
}
/** This is an alias of {@link Long.subtract} */
sub(subtrahend: string | number | Long | Timestamp): Long {
return this.subtract(subtrahend);
}
/** Converts the Long to a 32 bit integer, assuming it is a 32 bit integer. */
toInt(): number {
return this.unsigned ? this.low >>> 0 : this.low;
}
/** Converts the Long to a the nearest floating-point representation of this value (double, 53 bit mantissa). */
toNumber(): number {
if (this.unsigned) return (this.high >>> 0) * TWO_PWR_32_DBL + (this.low >>> 0);
return this.high * TWO_PWR_32_DBL + (this.low >>> 0);
}
/** Converts the Long to a BigInt (arbitrary precision). */
toBigInt(): bigint {
return BigInt(this.toString());
}
/**
* Converts this Long to its byte representation.
* @param le - Whether little or big endian, defaults to big endian
* @returns Byte representation
*/
toBytes(le?: boolean): number[] {
return le ? this.toBytesLE() : this.toBytesBE();
}
/**
* Converts this Long to its little endian byte representation.
* @returns Little endian byte representation
*/
toBytesLE(): number[] {
const hi = this.high,
lo = this.low;
return [
lo & 0xff,
(lo >>> 8) & 0xff,
(lo >>> 16) & 0xff,
lo >>> 24,
hi & 0xff,
(hi >>> 8) & 0xff,
(hi >>> 16) & 0xff,
hi >>> 24
];
}
/**
* Converts this Long to its big endian byte representation.
* @returns Big endian byte representation
*/
toBytesBE(): number[] {
const hi = this.high,
lo = this.low;
return [
hi >>> 24,
(hi >>> 16) & 0xff,
(hi >>> 8) & 0xff,
hi & 0xff,
lo >>> 24,
(lo >>> 16) & 0xff,
(lo >>> 8) & 0xff,
lo & 0xff
];
}
/**
* Converts this Long to signed.
*/
toSigned(): Long {
if (!this.unsigned) return this;
return Long.fromBits(this.low, this.high, false);
}
/**
* Converts the Long to a string written in the specified radix.
* @param radix - Radix (2-36), defaults to 10
* @throws RangeError If `radix` is out of range
*/
toString(radix?: number): string {
radix = radix || 10;
if (radix < 2 || 36 < radix) throw RangeError('radix');
if (this.isZero()) return '0';
if (this.isNegative()) {
// Unsigned Longs are never negative
if (this.eq(Long.MIN_VALUE)) {
// We need to change the Long value before it can be negated, so we remove
// the bottom-most digit in this base and then recurse to do the rest.
const radixLong = Long.fromNumber(radix),
div = this.div(radixLong),
rem1 = div.mul(radixLong).sub(this);
return div.toString(radix) + rem1.toInt().toString(radix);
} else return '-' + this.neg().toString(radix);
}
// Do several (6) digits each time through the loop, so as to
// minimize the calls to the very expensive emulated div.
const radixToPower = Long.fromNumber(Math.pow(radix, 6), this.unsigned);
// eslint-disable-next-line @typescript-eslint/no-this-alias
let rem: Long = this;
let result = '';
// eslint-disable-next-line no-constant-condition
while (true) {
const remDiv = rem.div(radixToPower);
const intval = rem.sub(remDiv.mul(radixToPower)).toInt() >>> 0;
let digits = intval.toString(radix);
rem = remDiv;
if (rem.isZero()) {
return digits + result;
} else {
while (digits.length < 6) digits = '0' + digits;
result = '' + digits + result;
}
}
}
/** Converts this Long to unsigned. */
toUnsigned(): Long {
if (this.unsigned) return this;
return Long.fromBits(this.low, this.high, true);
}
/** Returns the bitwise XOR of this Long and the given one. */
xor(other: Long | number | string): Long {
if (!Long.isLong(other)) other = Long.fromValue(other);
return Long.fromBits(this.low ^ other.low, this.high ^ other.high, this.unsigned);
}
/** This is an alias of {@link Long.isZero} */
eqz(): boolean {
return this.isZero();
}
/** This is an alias of {@link Long.lessThanOrEqual} */
le(other: string | number | Long | Timestamp): boolean {
return this.lessThanOrEqual(other);
}
/*
****************************************************************
* BSON SPECIFIC ADDITIONS *
****************************************************************
*/
toExtendedJSON(options?: EJSONOptions): number | LongExtended {
if (options && options.relaxed) return this.toNumber();
return { $numberLong: this.toString() };
}
static fromExtendedJSON(doc: { $numberLong: string }, options?: EJSONOptions): number | Long {
const result = Long.fromString(doc.$numberLong);
return options && options.relaxed ? result.toNumber() : result;
}
/** @internal */
[Symbol.for('nodejs.util.inspect.custom')](): string {
return this.inspect();
}
inspect(): string {
return `new Long("${this.toString()}"${this.unsigned ? ', true' : ''})`;
}
}
Object.defineProperty(Long.prototype, '__isLong__', { value: true });
Object.defineProperty(Long.prototype, '_bsontype', { value: 'Long' });