1 ------------------------------------------------------------------------------
3 -- GNAT COMPILER COMPONENTS --
9 -- Copyright (C) 1992-2021, Free Software Foundation, Inc. --
11 -- GNAT is free software; you can redistribute it and/or modify it under --
12 -- terms of the GNU General Public License as published by the Free Soft- --
13 -- ware Foundation; either version 3, or (at your option) any later ver- --
14 -- sion. GNAT is distributed in the hope that it will be useful, but WITH- --
15 -- OUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY --
16 -- or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License --
17 -- for more details. You should have received a copy of the GNU General --
18 -- Public License distributed with GNAT; see file COPYING3. If not, go to --
19 -- http://www.gnu.org/licenses for a complete copy of the license. --
21 -- GNAT was originally developed by the GNAT team at New York University. --
22 -- Extensive contributions were provided by Ada Core Technologies Inc. --
24 ------------------------------------------------------------------------------
26 with Output
; use Output
;
28 with GNAT
.HTable
; use GNAT
.HTable
;
32 ------------------------
33 -- Local Declarations --
34 ------------------------
36 Uint_Int_First
: Uint
:= Uint_0
;
37 -- Uint value containing Int'First value, set by Initialize. The initial
38 -- value of Uint_0 is used for an assertion check that ensures that this
39 -- value is not used before it is initialized. This value is used in the
40 -- UI_Is_In_Int_Range predicate, and it is right that this is a host value,
41 -- since the issue is host representation of integer values.
44 -- Uint value containing Int'Last value set by Initialize
46 UI_Power_2
: array (Int
range 0 .. 128) of Uint
;
47 -- This table is used to memoize exponentiations by powers of 2. The Nth
48 -- entry, if set, contains the Uint value 2**N. Initially UI_Power_2_Set
49 -- is zero and only the 0'th entry is set, the invariant being that all
50 -- entries in the range 0 .. UI_Power_2_Set are initialized.
53 -- Number of entries set in UI_Power_2;
55 UI_Power_10
: array (Int
range 0 .. 128) of Uint
;
56 -- This table is used to memoize exponentiations by powers of 10 in the
57 -- same manner as described above for UI_Power_2.
59 UI_Power_10_Set
: Nat
;
60 -- Number of entries set in UI_Power_10;
64 -- These values are used to make sure that the mark/release mechanism does
65 -- not destroy values saved in the U_Power tables or in the hash table used
66 -- by UI_From_Int. Whenever an entry is made in either of these tables,
67 -- Uints_Min and Udigits_Min are updated to protect the entry, and Release
68 -- never cuts back beyond these minimum values.
70 Int_0
: constant Int
:= 0;
71 Int_1
: constant Int
:= 1;
72 Int_2
: constant Int
:= 2;
73 -- These values are used in some cases where the use of numeric literals
74 -- would cause ambiguities (integer vs Uint).
76 type UI_Vector
is array (Pos
range <>) of Int
;
77 -- Vector containing the integer values of a Uint value
79 -- Note: An earlier version of this package used pointers of arrays of Ints
80 -- (dynamically allocated) for the Uint type. The change leads to a few
81 -- less natural idioms used throughout this code, but eliminates all uses
82 -- of the heap except for the table package itself. For example, Uint
83 -- parameters are often converted to UI_Vectors for internal manipulation.
84 -- This is done by creating the local UI_Vector using the function N_Digits
85 -- on the Uint to find the size needed for the vector, and then calling
86 -- Init_Operand to copy the values out of the table into the vector.
88 ----------------------------
89 -- UI_From_Int Hash Table --
90 ----------------------------
92 -- UI_From_Int uses a hash table to avoid duplicating entries and wasting
93 -- storage. This is particularly important for complex cases of back
96 subtype Hnum
is Nat
range 0 .. 1022;
98 function Hash_Num
(F
: Int
) return Hnum
;
101 package UI_Ints
is new Simple_HTable
(
104 No_Element
=> No_Uint
,
109 -----------------------
110 -- Local Subprograms --
111 -----------------------
113 function Direct
(U
: Valid_Uint
) return Boolean;
114 pragma Inline
(Direct
);
115 -- Returns True if U is represented directly
117 function Direct_Val
(U
: Valid_Uint
) return Int
;
118 -- U is a Uint that is represented directly. The returned result is the
119 -- value represented.
121 function GCD
(Jin
, Kin
: Int
) return Int
;
122 -- Compute GCD of two integers. Assumes that Jin >= Kin >= 0
128 -- Common processing for UI_Image and UI_Write, To_Buffer is set True for
129 -- UI_Image, and false for UI_Write, and Format is copied from the Format
130 -- parameter to UI_Image or UI_Write.
132 procedure Init_Operand
(UI
: Valid_Uint
; Vec
: out UI_Vector
);
133 pragma Inline
(Init_Operand
);
134 -- This procedure puts the value of UI into the vector in canonical
135 -- multiple precision format. The parameter should be of the correct size
136 -- as determined by a previous call to N_Digits (UI). The first digit of
137 -- Vec contains the sign, all other digits are always non-negative. Note
138 -- that the input may be directly represented, and in this case Vec will
139 -- contain the corresponding one or two digit value. The low bound of Vec
142 function Vector_To_Uint
144 Negative
: Boolean) return Valid_Uint
;
145 -- Functions that calculate values in UI_Vectors, call this function to
146 -- create and return the Uint value. In_Vec contains the multiple precision
147 -- (Base) representation of a non-negative value. Leading zeroes are
148 -- permitted. Negative is set if the desired result is the negative of the
149 -- given value. The result will be either the appropriate directly
150 -- represented value, or a table entry in the proper canonical format is
151 -- created and returned.
153 -- Note that Init_Operand puts a signed value in the result vector, but
154 -- Vector_To_Uint is always presented with a non-negative value. The
155 -- processing of signs is something that is done by the caller before
156 -- calling Vector_To_Uint.
158 function Least_Sig_Digit
(Arg
: Valid_Uint
) return Int
;
159 pragma Inline
(Least_Sig_Digit
);
160 -- Returns the Least Significant Digit of Arg quickly. When the given Uint
161 -- is less than 2**15, the value returned is the input value, in this case
162 -- the result may be negative. It is expected that any use will mask off
163 -- unnecessary bits. This is used for finding Arg mod B where B is a power
164 -- of two. Hence the actual base is irrelevant as long as it is a power of
167 procedure Most_Sig_2_Digits
171 Right_Hat
: out Int
);
172 -- Returns leading two significant digits from the given pair of Uint's.
173 -- Mathematically: returns Left / (Base**K) and Right / (Base**K) where
174 -- K is as small as possible S.T. Right_Hat < Base * Base. It is required
175 -- that Left >= Right for the algorithm to work.
177 function N_Digits
(Input
: Valid_Uint
) return Int
;
178 pragma Inline
(N_Digits
);
179 -- Returns number of "digits" in a Uint
182 (Left
, Right
: Valid_Uint
;
184 Remainder
: out Uint
;
185 Discard_Quotient
: Boolean := False;
186 Discard_Remainder
: Boolean := False);
187 -- Compute Euclidean division of Left by Right. If Discard_Quotient is
188 -- False then the quotient is returned in Quotient. If Discard_Remainder
189 -- is False, then the remainder is returned in Remainder.
191 -- If Discard_Quotient is True, Quotient is set to No_Uint.
192 -- If Discard_Remainder is True, Remainder is set to No_Uint.
194 function UI_Modular_Exponentiation
197 Modulo
: Valid_Uint
) return Valid_Uint
with Unreferenced
;
198 -- Efficiently compute (B**E) rem Modulo
200 function UI_Modular_Inverse
201 (N
: Valid_Uint
; Modulo
: Valid_Uint
) return Valid_Uint
with Unreferenced
;
202 -- Compute the multiplicative inverse of N in modular arithmetics with the
203 -- given Modulo (uses Euclid's algorithm). Note: the call is considered
204 -- to be erroneous (and the behavior is undefined) if n is not invertible.
210 function Direct
(U
: Valid_Uint
) return Boolean is
212 return Int
(U
) <= Int
(Uint_Direct_Last
);
219 function Direct_Val
(U
: Valid_Uint
) return Int
is
221 pragma Assert
(Direct
(U
));
222 return Int
(U
) - Int
(Uint_Direct_Bias
);
229 function GCD
(Jin
, Kin
: Int
) return Int
is
233 pragma Assert
(Jin
>= Kin
);
234 pragma Assert
(Kin
>= Int_0
);
238 while K
/= Uint_0
loop
251 function Hash_Num
(F
: Int
) return Hnum
is
253 return Types
."mod" (F
, Hnum
'Range_Length);
265 Marks
: constant Uintp
.Save_Mark
:= Uintp
.Mark
;
269 Digs_Output
: Natural := 0;
270 -- Counts digits output. In hex mode, but not in decimal mode, we
271 -- put an underline after every four hex digits that are output.
273 Exponent
: Natural := 0;
274 -- If the number is too long to fit in the buffer, we switch to an
275 -- approximate output format with an exponent. This variable records
276 -- the exponent value.
278 function Better_In_Hex
return Boolean;
279 -- Determines if it is better to generate digits in base 16 (result
280 -- is true) or base 10 (result is false). The choice is purely a
281 -- matter of convenience and aesthetics, so it does not matter which
282 -- value is returned from a correctness point of view.
284 procedure Image_Char
(C
: Character);
285 -- Output one character
287 procedure Image_String
(S
: String);
290 procedure Image_Exponent
(N
: Natural);
291 -- Output non-zero exponent. Note that we only use the exponent form in
292 -- the buffer case, so we know that To_Buffer is true.
294 procedure Image_Uint
(U
: Valid_Uint
);
295 -- Internal procedure to output characters of non-negative Uint
301 function Better_In_Hex
return Boolean is
302 T16
: constant Valid_Uint
:= Uint_2
**Int
'(16);
308 -- Small values up to 2**16 can always be in decimal
314 -- Otherwise, see if we are a power of 2 or one less than a power
315 -- of 2. For the moment these are the only cases printed in hex.
317 if A mod Uint_2 = Uint_1 then
322 if A mod T16 /= Uint_0 then
332 while A > Uint_2 loop
333 if A mod Uint_2 /= Uint_0 then
348 procedure Image_Char (C : Character) is
351 if UI_Image_Length + 6 > UI_Image_Max then
352 Exponent := Exponent + 1;
354 UI_Image_Length := UI_Image_Length + 1;
355 UI_Image_Buffer (UI_Image_Length) := C;
366 procedure Image_Exponent (N : Natural) is
369 Image_Exponent (N / 10);
372 UI_Image_Length := UI_Image_Length + 1;
373 UI_Image_Buffer (UI_Image_Length) :=
374 Character'Val (Character'Pos ('0') + N mod 10);
381 procedure Image_String (S : String) is
392 procedure Image_Uint (U : Valid_Uint) is
393 H : constant array (Int range 0 .. 15) of Character :=
398 UI_Div_Rem (U, Base, Q, R);
404 if Digs_Output = 4 and then Base = Uint_16 then
409 Image_Char (H (UI_To_Int (R)));
411 Digs_Output := Digs_Output + 1;
414 -- Start of processing for Image_Out
418 Image_String ("No_Uint");
422 UI_Image_Length := 0;
424 if Input < Uint_0 then
432 or else (Format = Auto and then Better_In_Hex)
446 if Exponent /= 0 then
447 UI_Image_Length := UI_Image_Length + 1;
448 UI_Image_Buffer (UI_Image_Length) := 'E
';
449 Image_Exponent (Exponent);
452 Uintp.Release (Marks);
459 procedure Init_Operand (UI : Valid_Uint; Vec : out UI_Vector) is
462 pragma Assert (Vec'First = Int'(1));
466 Vec
(1) := Direct_Val
(UI
);
468 if Vec
(1) >= Base
then
469 Vec
(2) := Vec
(1) rem Base
;
470 Vec
(1) := Vec
(1) / Base
;
474 Loc
:= Uints
.Table
(UI
).Loc
;
476 for J
in 1 .. Uints
.Table
(UI
).Length
loop
477 Vec
(J
) := Udigits
.Table
(Loc
+ J
- 1);
486 procedure Initialize
is
491 Uint_Int_First
:= UI_From_Int
(Int
'First);
492 Uint_Int_Last
:= UI_From_Int
(Int
'Last);
494 UI_Power_2
(0) := Uint_1
;
497 UI_Power_10
(0) := Uint_1
;
498 UI_Power_10_Set
:= 0;
500 Uints_Min
:= Uints
.Last
;
501 Udigits_Min
:= Udigits
.Last
;
506 ---------------------
507 -- Least_Sig_Digit --
508 ---------------------
510 function Least_Sig_Digit
(Arg
: Valid_Uint
) return Int
is
515 V
:= Direct_Val
(Arg
);
521 -- Note that this result may be negative
528 (Uints
.Table
(Arg
).Loc
+ Uints
.Table
(Arg
).Length
- 1);
536 function Mark
return Save_Mark
is
538 return (Save_Uint
=> Uints
.Last
, Save_Udigit
=> Udigits
.Last
);
541 -----------------------
542 -- Most_Sig_2_Digits --
543 -----------------------
545 procedure Most_Sig_2_Digits
552 pragma Assert
(Left
>= Right
);
554 if Direct
(Left
) then
555 pragma Assert
(Direct
(Right
));
556 Left_Hat
:= Direct_Val
(Left
);
557 Right_Hat
:= Direct_Val
(Right
);
563 Udigits
.Table
(Uints
.Table
(Left
).Loc
);
565 Udigits
.Table
(Uints
.Table
(Left
).Loc
+ 1);
568 -- It is not so clear what to return when Arg is negative???
570 Left_Hat
:= abs (L1
) * Base
+ L2
;
575 Length_L
: constant Int
:= Uints
.Table
(Left
).Length
;
582 if Direct
(Right
) then
583 T
:= Direct_Val
(Right
);
584 R1
:= abs (T
/ Base
);
589 R1
:= abs (Udigits
.Table
(Uints
.Table
(Right
).Loc
));
590 R2
:= Udigits
.Table
(Uints
.Table
(Right
).Loc
+ 1);
591 Length_R
:= Uints
.Table
(Right
).Length
;
594 if Length_L
= Length_R
then
595 Right_Hat
:= R1
* Base
+ R2
;
596 elsif Length_L
= Length_R
+ Int_1
then
602 end Most_Sig_2_Digits
;
608 function N_Digits
(Input
: Valid_Uint
) return Int
is
610 if Direct
(Input
) then
611 if Direct_Val
(Input
) >= Base
then
618 return Uints
.Table
(Input
).Length
;
626 function Num_Bits
(Input
: Valid_Uint
) return Nat
is
631 -- Largest negative number has to be handled specially, since it is in
632 -- Int_Range, but we cannot take the absolute value.
634 if Input
= Uint_Int_First
then
637 -- For any other number in Int_Range, get absolute value of number
639 elsif UI_Is_In_Int_Range
(Input
) then
640 Num
:= abs (UI_To_Int
(Input
));
643 -- If not in Int_Range then initialize bit count for all low order
644 -- words, and set number to high order digit.
647 Bits
:= Base_Bits
* (Uints
.Table
(Input
).Length
- 1);
648 Num
:= abs (Udigits
.Table
(Uints
.Table
(Input
).Loc
));
651 -- Increase bit count for remaining value in Num
653 while Types
.">" (Num
, 0) loop
665 procedure pid
(Input
: Uint
) is
667 UI_Write
(Input
, Decimal
);
675 procedure pih
(Input
: Uint
) is
677 UI_Write
(Input
, Hex
);
685 procedure Release
(M
: Save_Mark
) is
687 Uints
.Set_Last
(Valid_Uint
'Max (M
.Save_Uint
, Uints_Min
));
688 Udigits
.Set_Last
(Int
'Max (M
.Save_Udigit
, Udigits_Min
));
691 ----------------------
692 -- Release_And_Save --
693 ----------------------
695 procedure Release_And_Save
(M
: Save_Mark
; UI
: in out Valid_Uint
) is
702 UE_Len
: constant Pos
:= Uints
.Table
(UI
).Length
;
703 UE_Loc
: constant Int
:= Uints
.Table
(UI
).Loc
;
705 UD
: constant Udigits
.Table_Type
(1 .. UE_Len
) :=
706 Udigits
.Table
(UE_Loc
.. UE_Loc
+ UE_Len
- 1);
711 Uints
.Append
((Length
=> UE_Len
, Loc
=> Udigits
.Last
+ 1));
714 for J
in 1 .. UE_Len
loop
715 Udigits
.Append
(UD
(J
));
719 end Release_And_Save
;
721 procedure Release_And_Save
(M
: Save_Mark
; UI1
, UI2
: in out Valid_Uint
) is
724 Release_And_Save
(M
, UI2
);
726 elsif Direct
(UI2
) then
727 Release_And_Save
(M
, UI1
);
731 UE1_Len
: constant Pos
:= Uints
.Table
(UI1
).Length
;
732 UE1_Loc
: constant Int
:= Uints
.Table
(UI1
).Loc
;
734 UD1
: constant Udigits
.Table_Type
(1 .. UE1_Len
) :=
735 Udigits
.Table
(UE1_Loc
.. UE1_Loc
+ UE1_Len
- 1);
737 UE2_Len
: constant Pos
:= Uints
.Table
(UI2
).Length
;
738 UE2_Loc
: constant Int
:= Uints
.Table
(UI2
).Loc
;
740 UD2
: constant Udigits
.Table_Type
(1 .. UE2_Len
) :=
741 Udigits
.Table
(UE2_Loc
.. UE2_Loc
+ UE2_Len
- 1);
746 Uints
.Append
((Length
=> UE1_Len
, Loc
=> Udigits
.Last
+ 1));
749 for J
in 1 .. UE1_Len
loop
750 Udigits
.Append
(UD1
(J
));
753 Uints
.Append
((Length
=> UE2_Len
, Loc
=> Udigits
.Last
+ 1));
756 for J
in 1 .. UE2_Len
loop
757 Udigits
.Append
(UD2
(J
));
761 end Release_And_Save
;
767 function UI_Abs
(Right
: Valid_Uint
) return Unat
is
769 if Right
< Uint_0
then
780 function UI_Add
(Left
: Int
; Right
: Valid_Uint
) return Valid_Uint
is
782 return UI_Add
(UI_From_Int
(Left
), Right
);
785 function UI_Add
(Left
: Valid_Uint
; Right
: Int
) return Valid_Uint
is
787 return UI_Add
(Left
, UI_From_Int
(Right
));
790 function UI_Add
(Left
: Valid_Uint
; Right
: Valid_Uint
) return Valid_Uint
is
792 pragma Assert
(Present
(Left
));
793 pragma Assert
(Present
(Right
));
794 -- Assertions are here in case we're called from C++ code, which does
795 -- not check the predicates.
797 -- Simple cases of direct operands and addition of zero
799 if Direct
(Left
) then
800 if Direct
(Right
) then
801 return UI_From_Int
(Direct_Val
(Left
) + Direct_Val
(Right
));
803 elsif Int
(Left
) = Int
(Uint_0
) then
807 elsif Direct
(Right
) and then Int
(Right
) = Int
(Uint_0
) then
811 -- Otherwise full circuit is needed
814 L_Length
: constant Int
:= N_Digits
(Left
);
815 R_Length
: constant Int
:= N_Digits
(Right
);
816 L_Vec
: UI_Vector
(1 .. L_Length
);
817 R_Vec
: UI_Vector
(1 .. R_Length
);
822 X_Bigger
: Boolean := False;
823 Y_Bigger
: Boolean := False;
824 Result_Neg
: Boolean := False;
827 Init_Operand
(Left
, L_Vec
);
828 Init_Operand
(Right
, R_Vec
);
830 -- At least one of the two operands is in multi-digit form.
831 -- Calculate the number of digits sufficient to hold result.
833 if L_Length
> R_Length
then
834 Sum_Length
:= L_Length
+ 1;
837 Sum_Length
:= R_Length
+ 1;
839 if R_Length
> L_Length
then
844 -- Make copies of the absolute values of L_Vec and R_Vec into X and Y
845 -- both with lengths equal to the maximum possibly needed. This makes
846 -- looping over the digits much simpler.
849 X
: UI_Vector
(1 .. Sum_Length
);
850 Y
: UI_Vector
(1 .. Sum_Length
);
851 Tmp_UI
: UI_Vector
(1 .. Sum_Length
);
854 for J
in 1 .. Sum_Length
- L_Length
loop
858 X
(Sum_Length
- L_Length
+ 1) := abs L_Vec
(1);
860 for J
in 2 .. L_Length
loop
861 X
(J
+ (Sum_Length
- L_Length
)) := L_Vec
(J
);
864 for J
in 1 .. Sum_Length
- R_Length
loop
868 Y
(Sum_Length
- R_Length
+ 1) := abs R_Vec
(1);
870 for J
in 2 .. R_Length
loop
871 Y
(J
+ (Sum_Length
- R_Length
)) := R_Vec
(J
);
874 if (L_Vec
(1) < Int_0
) = (R_Vec
(1) < Int_0
) then
876 -- Same sign so just add
879 for J
in reverse 1 .. Sum_Length
loop
880 Tmp_Int
:= X
(J
) + Y
(J
) + Carry
;
882 if Tmp_Int
>= Base
then
883 Tmp_Int
:= Tmp_Int
- Base
;
892 return Vector_To_Uint
(X
, L_Vec
(1) < Int_0
);
895 -- Find which one has bigger magnitude
897 if not (X_Bigger
or Y_Bigger
) then
898 for J
in L_Vec
'Range loop
899 if abs L_Vec
(J
) > abs R_Vec
(J
) then
902 elsif abs R_Vec
(J
) > abs L_Vec
(J
) then
909 -- If they have identical magnitude, just return 0, else swap
910 -- if necessary so that X had the bigger magnitude. Determine
911 -- if result is negative at this time.
915 if not (X_Bigger
or Y_Bigger
) then
919 if R_Vec
(1) < Int_0
then
928 if L_Vec
(1) < Int_0
then
933 -- Subtract Y from the bigger X
937 for J
in reverse 1 .. Sum_Length
loop
938 Tmp_Int
:= X
(J
) - Y
(J
) + Borrow
;
940 if Tmp_Int
< Int_0
then
941 Tmp_Int
:= Tmp_Int
+ Base
;
950 return Vector_To_Uint
(X
, Result_Neg
);
957 --------------------------
958 -- UI_Decimal_Digits_Hi --
959 --------------------------
961 function UI_Decimal_Digits_Hi
(U
: Valid_Uint
) return Nat
is
963 -- The maximum value of a "digit" is 32767, which is 5 decimal digits,
964 -- so an N_Digit number could take up to 5 times this number of digits.
965 -- This is certainly too high for large numbers but it is not worth
968 return 5 * N_Digits
(U
);
969 end UI_Decimal_Digits_Hi
;
971 --------------------------
972 -- UI_Decimal_Digits_Lo --
973 --------------------------
975 function UI_Decimal_Digits_Lo
(U
: Valid_Uint
) return Nat
is
977 -- The maximum value of a "digit" is 32767, which is more than four
978 -- decimal digits, but not a full five digits. The easily computed
979 -- minimum number of decimal digits is thus 1 + 4 * the number of
980 -- digits. This is certainly too low for large numbers but it is not
981 -- worth worrying about.
983 return 1 + 4 * (N_Digits
(U
) - 1);
984 end UI_Decimal_Digits_Lo
;
990 function UI_Div
(Left
: Int
; Right
: Nonzero_Uint
) return Valid_Uint
is
992 return UI_Div
(UI_From_Int
(Left
), Right
);
996 (Left
: Valid_Uint
; Right
: Nonzero_Int
) return Valid_Uint
999 return UI_Div
(Left
, UI_From_Int
(Right
));
1003 (Left
: Valid_Uint
; Right
: Nonzero_Uint
) return Valid_Uint
1005 Quotient
: Valid_Uint
;
1006 Ignored_Remainder
: Uint
;
1010 Quotient
, Ignored_Remainder
,
1011 Discard_Remainder
=> True);
1019 procedure UI_Div_Rem
1020 (Left
, Right
: Valid_Uint
;
1021 Quotient
: out Uint
;
1022 Remainder
: out Uint
;
1023 Discard_Quotient
: Boolean := False;
1024 Discard_Remainder
: Boolean := False)
1027 pragma Assert
(Right
/= Uint_0
);
1029 Quotient
:= No_Uint
;
1030 Remainder
:= No_Uint
;
1032 -- Cases where both operands are represented directly
1034 if Direct
(Left
) and then Direct
(Right
) then
1036 DV_Left
: constant Int
:= Direct_Val
(Left
);
1037 DV_Right
: constant Int
:= Direct_Val
(Right
);
1040 if not Discard_Quotient
then
1041 Quotient
:= UI_From_Int
(DV_Left
/ DV_Right
);
1044 if not Discard_Remainder
then
1045 Remainder
:= UI_From_Int
(DV_Left
rem DV_Right
);
1053 L_Length
: constant Int
:= N_Digits
(Left
);
1054 R_Length
: constant Int
:= N_Digits
(Right
);
1055 Q_Length
: constant Int
:= L_Length
- R_Length
+ 1;
1056 L_Vec
: UI_Vector
(1 .. L_Length
);
1057 R_Vec
: UI_Vector
(1 .. R_Length
);
1065 procedure UI_Div_Vector
1068 Quotient
: out UI_Vector
;
1069 Remainder
: out Int
);
1070 pragma Inline
(UI_Div_Vector
);
1071 -- Specialised variant for case where the divisor is a single digit
1073 procedure UI_Div_Vector
1076 Quotient
: out UI_Vector
;
1077 Remainder
: out Int
)
1083 for J
in L_Vec
'Range loop
1084 Tmp_Int
:= Remainder
* Base
+ abs L_Vec
(J
);
1085 Quotient
(Quotient
'First + J
- L_Vec
'First) := Tmp_Int
/ R_Int
;
1086 Remainder
:= Tmp_Int
rem R_Int
;
1089 if L_Vec
(L_Vec
'First) < Int_0
then
1090 Remainder
:= -Remainder
;
1094 -- Start of processing for UI_Div_Rem
1097 -- Result is zero if left operand is shorter than right
1099 if L_Length
< R_Length
then
1100 if not Discard_Quotient
then
1104 if not Discard_Remainder
then
1111 Init_Operand
(Left
, L_Vec
);
1112 Init_Operand
(Right
, R_Vec
);
1114 -- Case of right operand is single digit. Here we can simply divide
1115 -- each digit of the left operand by the divisor, from most to least
1116 -- significant, carrying the remainder to the next digit (just like
1117 -- ordinary long division by hand).
1119 if R_Length
= Int_1
then
1120 Tmp_Divisor
:= abs R_Vec
(1);
1123 Quotient_V
: UI_Vector
(1 .. L_Length
);
1126 UI_Div_Vector
(L_Vec
, Tmp_Divisor
, Quotient_V
, Remainder_I
);
1128 if not Discard_Quotient
then
1131 (Quotient_V
, (L_Vec
(1) < Int_0
xor R_Vec
(1) < Int_0
));
1134 if not Discard_Remainder
then
1135 Remainder
:= UI_From_Int
(Remainder_I
);
1142 -- The possible simple cases have been exhausted. Now turn to the
1143 -- algorithm D from the section of Knuth mentioned at the top of
1146 Algorithm_D
: declare
1147 Dividend
: UI_Vector
(1 .. L_Length
+ 1);
1148 Divisor
: UI_Vector
(1 .. R_Length
);
1149 Quotient_V
: UI_Vector
(1 .. Q_Length
);
1156 -- [ NORMALIZE ] (step D1 in the algorithm). First calculate the
1157 -- scale d, and then multiply Left and Right (u and v in the book)
1158 -- by d to get the dividend and divisor to work with.
1160 D
:= Base
/ (abs R_Vec
(1) + 1);
1163 Dividend
(2) := abs L_Vec
(1);
1165 for J
in 3 .. L_Length
+ Int_1
loop
1166 Dividend
(J
) := L_Vec
(J
- 1);
1169 Divisor
(1) := abs R_Vec
(1);
1171 for J
in Int_2
.. R_Length
loop
1172 Divisor
(J
) := R_Vec
(J
);
1177 -- Multiply Dividend by d
1180 for J
in reverse Dividend
'Range loop
1181 Tmp_Int
:= Dividend
(J
) * D
+ Carry
;
1182 Dividend
(J
) := Tmp_Int
rem Base
;
1183 Carry
:= Tmp_Int
/ Base
;
1186 -- Multiply Divisor by d
1189 for J
in reverse Divisor
'Range loop
1190 Tmp_Int
:= Divisor
(J
) * D
+ Carry
;
1191 Divisor
(J
) := Tmp_Int
rem Base
;
1192 Carry
:= Tmp_Int
/ Base
;
1196 -- Main loop of long division algorithm
1198 Divisor_Dig1
:= Divisor
(1);
1199 Divisor_Dig2
:= Divisor
(2);
1201 for J
in Quotient_V
'Range loop
1203 -- [ CALCULATE Q (hat) ] (step D3 in the algorithm)
1205 -- Note: this version of step D3 is from the original published
1206 -- algorithm, which is known to have a bug causing overflows.
1207 -- See: http://www-cs-faculty.stanford.edu/~uno/err2-2e.ps.gz
1208 -- and http://www-cs-faculty.stanford.edu/~uno/all2-pre.ps.gz.
1209 -- The code below is the fixed version of this step.
1211 Tmp_Int
:= Dividend
(J
) * Base
+ Dividend
(J
+ 1);
1215 Q_Guess
:= Tmp_Int
/ Divisor_Dig1
;
1216 R_Guess
:= Tmp_Int
rem Divisor_Dig1
;
1220 while Q_Guess
>= Base
1221 or else Divisor_Dig2
* Q_Guess
>
1222 R_Guess
* Base
+ Dividend
(J
+ 2)
1224 Q_Guess
:= Q_Guess
- 1;
1225 R_Guess
:= R_Guess
+ Divisor_Dig1
;
1226 exit when R_Guess
>= Base
;
1229 -- [ MULTIPLY & SUBTRACT ] (step D4). Q_Guess * Divisor is
1230 -- subtracted from the remaining dividend.
1233 for K
in reverse Divisor
'Range loop
1234 Tmp_Int
:= Dividend
(J
+ K
) - Q_Guess
* Divisor
(K
) + Carry
;
1235 Tmp_Dig
:= Tmp_Int
rem Base
;
1236 Carry
:= Tmp_Int
/ Base
;
1238 if Tmp_Dig
< Int_0
then
1239 Tmp_Dig
:= Tmp_Dig
+ Base
;
1243 Dividend
(J
+ K
) := Tmp_Dig
;
1246 Dividend
(J
) := Dividend
(J
) + Carry
;
1248 -- [ TEST REMAINDER ] & [ ADD BACK ] (steps D5 and D6)
1250 -- Here there is a slight difference from the book: the last
1251 -- carry is always added in above and below (cancelling each
1252 -- other). In fact the dividend going negative is used as
1255 -- If the Dividend went negative, then Q_Guess was off by
1256 -- one, so it is decremented, and the divisor is added back
1257 -- into the relevant portion of the dividend.
1259 if Dividend
(J
) < Int_0
then
1260 Q_Guess
:= Q_Guess
- 1;
1263 for K
in reverse Divisor
'Range loop
1264 Tmp_Int
:= Dividend
(J
+ K
) + Divisor
(K
) + Carry
;
1266 if Tmp_Int
>= Base
then
1267 Tmp_Int
:= Tmp_Int
- Base
;
1273 Dividend
(J
+ K
) := Tmp_Int
;
1276 Dividend
(J
) := Dividend
(J
) + Carry
;
1279 -- Finally we can get the next quotient digit
1281 Quotient_V
(J
) := Q_Guess
;
1284 -- [ UNNORMALIZE ] (step D8)
1286 if not Discard_Quotient
then
1287 Quotient
:= Vector_To_Uint
1288 (Quotient_V
, (L_Vec
(1) < Int_0
xor R_Vec
(1) < Int_0
));
1291 if not Discard_Remainder
then
1293 Remainder_V
: UI_Vector
(1 .. R_Length
);
1296 pragma Assert
(D
/= Int
'(0));
1298 (Dividend (Dividend'Last - R_Length + 1 .. Dividend'Last),
1300 Remainder_V, Ignore);
1301 Remainder := Vector_To_Uint (Remainder_V, L_Vec (1) < Int_0);
1312 function UI_Eq (Left : Int; Right : Valid_Uint) return Boolean is
1314 return not UI_Ne (UI_From_Int (Left), Right);
1317 function UI_Eq (Left : Valid_Uint; Right : Int) return Boolean is
1319 return not UI_Ne (Left, UI_From_Int (Right));
1322 function UI_Eq (Left : Valid_Uint; Right : Valid_Uint) return Boolean is
1324 return not UI_Ne (Left, Right);
1331 function UI_Expon (Left : Int; Right : Unat) return Valid_Uint is
1333 return UI_Expon (UI_From_Int (Left), Right);
1336 function UI_Expon (Left : Valid_Uint; Right : Nat) return Valid_Uint is
1338 return UI_Expon (Left, UI_From_Int (Right));
1341 function UI_Expon (Left : Int; Right : Nat) return Valid_Uint is
1343 return UI_Expon (UI_From_Int (Left), UI_From_Int (Right));
1347 (Left : Valid_Uint; Right : Unat) return Valid_Uint
1350 pragma Assert (Right >= Uint_0);
1352 -- Any value raised to power of 0 is 1
1354 if Right = Uint_0 then
1357 -- 0 to any positive power is 0
1359 elsif Left = Uint_0 then
1362 -- 1 to any power is 1
1364 elsif Left = Uint_1 then
1367 -- Any value raised to power of 1 is that value
1369 elsif Right = Uint_1 then
1372 -- Cases which can be done by table lookup
1374 elsif Right <= Uint_128 then
1376 -- 2**N for N in 2 .. 128
1378 if Left = Uint_2 then
1380 Right_Int : constant Int := Direct_Val (Right);
1383 if Right_Int > UI_Power_2_Set then
1384 for J in UI_Power_2_Set + Int_1 .. Right_Int loop
1385 UI_Power_2 (J) := UI_Power_2 (J - Int_1) * Int_2;
1386 Uints_Min := Uints.Last;
1387 Udigits_Min := Udigits.Last;
1390 UI_Power_2_Set := Right_Int;
1393 return UI_Power_2 (Right_Int);
1396 -- 10**N for N in 2 .. 128
1398 elsif Left = Uint_10 then
1400 Right_Int : constant Int := Direct_Val (Right);
1403 if Right_Int > UI_Power_10_Set then
1404 for J in UI_Power_10_Set + Int_1 .. Right_Int loop
1405 UI_Power_10 (J) := UI_Power_10 (J - Int_1) * Int (10);
1406 Uints_Min := Uints.Last;
1407 Udigits_Min := Udigits.Last;
1410 UI_Power_10_Set := Right_Int;
1413 return UI_Power_10 (Right_Int);
1418 -- If we fall through, then we have the general case (see Knuth 4.6.3)
1421 N : Valid_Uint := Right;
1422 Squares : Valid_Uint := Left;
1423 Result : Valid_Uint := Uint_1;
1424 M : constant Uintp.Save_Mark := Uintp.Mark;
1428 if (Least_Sig_Digit (N) mod Int_2) = Int_1 then
1429 Result := Result * Squares;
1433 exit when N = Uint_0;
1434 Squares := Squares * Squares;
1437 Uintp.Release_And_Save (M, Result);
1446 function UI_From_CC (Input : Char_Code) return Valid_Uint is
1448 return UI_From_Int (Int (Input));
1455 function UI_From_Int (Input : Int) return Valid_Uint is
1459 if Min_Direct <= Input and then Input <= Max_Direct then
1460 return Valid_Uint (Int (Uint_Direct_Bias) + Input);
1463 -- If already in the hash table, return entry
1465 U := UI_Ints.Get (Input);
1471 -- For values of larger magnitude, compute digits into a vector and call
1475 Max_For_Int : constant := 3;
1476 -- Base is defined so that 3 Uint digits is sufficient to hold the
1477 -- largest possible Int value.
1479 V : UI_Vector (1 .. Max_For_Int);
1481 Temp_Integer : Int := Input;
1484 for J in reverse V'Range loop
1485 V (J) := abs (Temp_Integer rem Base);
1486 Temp_Integer := Temp_Integer / Base;
1489 U := Vector_To_Uint (V, Input < Int_0);
1490 UI_Ints.Set (Input, U);
1491 Uints_Min := Uints.Last;
1492 Udigits_Min := Udigits.Last;
1497 ----------------------
1498 -- UI_From_Integral --
1499 ----------------------
1501 function UI_From_Integral (Input : In_T) return Valid_Uint is
1503 -- If in range of our normal conversion function, use it so we can use
1504 -- direct access and our cache.
1506 if In_T'Size <= Int'Size
1507 or else Input in In_T (Int'First) .. In_T (Int'Last)
1509 return UI_From_Int (Int (Input));
1512 -- For values of larger magnitude, compute digits into a vector and
1513 -- call Vector_To_Uint.
1516 Max_For_In_T : constant Int := 3 * In_T'Size / Int'Size;
1517 Our_Base : constant In_T := In_T (Base);
1518 Temp_Integer : In_T := Input;
1519 -- Base is defined so that 3 Uint digits is sufficient to hold the
1520 -- largest possible Int value.
1523 V : UI_Vector (1 .. Max_For_In_T);
1526 for J in reverse V'Range loop
1527 V (J) := Int (abs (Temp_Integer rem Our_Base));
1528 Temp_Integer := Temp_Integer / Our_Base;
1531 U := Vector_To_Uint (V, Input < 0);
1532 Uints_Min := Uints.Last;
1533 Udigits_Min := Udigits.Last;
1538 end UI_From_Integral;
1544 -- Lehmer's algorithm for GCD
1546 -- The idea is to avoid using multiple precision arithmetic wherever
1547 -- possible, substituting Int arithmetic instead. See Knuth volume II,
1548 -- Algorithm L (page 329).
1550 -- We use the same notation as Knuth (U_Hat standing for the obvious)
1552 function UI_GCD (Uin, Vin : Valid_Uint) return Valid_Uint is
1554 -- Copies of Uin and Vin
1557 -- The most Significant digits of U,V
1559 A, B, C, D, T, Q, Den1, Den2 : Int;
1561 Tmp_UI : Valid_Uint;
1562 Marks : constant Uintp.Save_Mark := Uintp.Mark;
1563 Iterations : Integer := 0;
1566 pragma Assert (Uin >= Vin);
1567 pragma Assert (Vin >= Uint_0);
1573 Iterations := Iterations + 1;
1580 UI_From_Int (GCD (Direct_Val (V), UI_To_Int (U rem V)));
1584 Most_Sig_2_Digits (U, V, U_Hat, V_Hat);
1591 -- We might overflow and get division by zero here. This just
1592 -- means we cannot take the single precision step
1596 exit when Den1 = Int_0 or else Den2 = Int_0;
1598 -- Compute Q, the trial quotient
1600 Q := (U_Hat + A) / Den1;
1602 exit when Q /= ((U_Hat + B) / Den2);
1604 -- A single precision step Euclid step will give same answer as a
1605 -- multiprecision one.
1615 T := U_Hat - (Q * V_Hat);
1621 -- Take a multiprecision Euclid step
1625 -- No single precision steps take a regular Euclid step
1632 -- Use prior single precision steps to compute this Euclid step
1634 Tmp_UI := (UI_From_Int (A) * U) + (UI_From_Int (B) * V);
1635 V := (UI_From_Int (C) * U) + (UI_From_Int (D) * V);
1639 -- If the operands are very different in magnitude, the loop will
1640 -- generate large amounts of short-lived data, which it is worth
1641 -- removing periodically.
1643 if Iterations > 100 then
1644 Release_And_Save (Marks, U, V);
1654 function UI_Ge (Left : Int; Right : Valid_Uint) return Boolean is
1656 return not UI_Lt (UI_From_Int (Left), Right);
1659 function UI_Ge (Left : Valid_Uint; Right : Int) return Boolean is
1661 return not UI_Lt (Left, UI_From_Int (Right));
1664 function UI_Ge (Left : Valid_Uint; Right : Valid_Uint) return Boolean is
1666 return not UI_Lt (Left, Right);
1673 function UI_Gt (Left : Int; Right : Valid_Uint) return Boolean is
1675 return UI_Lt (Right, UI_From_Int (Left));
1678 function UI_Gt (Left : Valid_Uint; Right : Int) return Boolean is
1680 return UI_Lt (UI_From_Int (Right), Left);
1683 function UI_Gt (Left : Valid_Uint; Right : Valid_Uint) return Boolean is
1685 return UI_Lt (Left => Right, Right => Left);
1692 procedure UI_Image (Input : Uint; Format : UI_Format := Auto) is
1694 Image_Out (Input, True, Format);
1699 Format : UI_Format := Auto) return String
1702 Image_Out (Input, True, Format);
1703 return UI_Image_Buffer (1 .. UI_Image_Length);
1706 -------------------------
1707 -- UI_Is_In_Int_Range --
1708 -------------------------
1710 function UI_Is_In_Int_Range (Input : Valid_Uint) return Boolean is
1711 pragma Assert (Present (Input));
1712 -- Assertion is here in case we're called from C++ code, which does
1713 -- not check the predicates.
1715 -- Make sure we don't get called before Initialize
1717 pragma Assert (Uint_Int_First /= Uint_0);
1719 if Direct (Input) then
1722 return Input >= Uint_Int_First and then Input <= Uint_Int_Last;
1724 end UI_Is_In_Int_Range;
1730 function UI_Le (Left : Int; Right : Valid_Uint) return Boolean is
1732 return not UI_Lt (Right, UI_From_Int (Left));
1735 function UI_Le (Left : Valid_Uint; Right : Int) return Boolean is
1737 return not UI_Lt (UI_From_Int (Right), Left);
1740 function UI_Le (Left : Valid_Uint; Right : Valid_Uint) return Boolean is
1742 return not UI_Lt (Left => Right, Right => Left);
1749 function UI_Lt (Left : Int; Right : Valid_Uint) return Boolean is
1751 return UI_Lt (UI_From_Int (Left), Right);
1754 function UI_Lt (Left : Valid_Uint; Right : Int) return Boolean is
1756 return UI_Lt (Left, UI_From_Int (Right));
1759 function UI_Lt (Left : Valid_Uint; Right : Valid_Uint) return Boolean is
1761 pragma Assert (Present (Left));
1762 pragma Assert (Present (Right));
1763 -- Assertions are here in case we're called from C++ code, which does
1764 -- not check the predicates.
1766 -- Quick processing for identical arguments
1768 if Int (Left) = Int (Right) then
1771 -- Quick processing for both arguments directly represented
1773 elsif Direct (Left) and then Direct (Right) then
1774 return Int (Left) < Int (Right);
1776 -- At least one argument is more than one digit long
1780 L_Length : constant Int := N_Digits (Left);
1781 R_Length : constant Int := N_Digits (Right);
1783 L_Vec : UI_Vector (1 .. L_Length);
1784 R_Vec : UI_Vector (1 .. R_Length);
1787 Init_Operand (Left, L_Vec);
1788 Init_Operand (Right, R_Vec);
1790 if L_Vec (1) < Int_0 then
1792 -- First argument negative, second argument non-negative
1794 if R_Vec (1) >= Int_0 then
1797 -- Both arguments negative
1800 if L_Length /= R_Length then
1801 return L_Length > R_Length;
1803 elsif L_Vec (1) /= R_Vec (1) then
1804 return L_Vec (1) < R_Vec (1);
1807 for J in 2 .. L_Vec'Last loop
1808 if L_Vec (J) /= R_Vec (J) then
1809 return L_Vec (J) > R_Vec (J);
1818 -- First argument non-negative, second argument negative
1820 if R_Vec (1) < Int_0 then
1823 -- Both arguments non-negative
1826 if L_Length /= R_Length then
1827 return L_Length < R_Length;
1829 for J in L_Vec'Range loop
1830 if L_Vec (J) /= R_Vec (J) then
1831 return L_Vec (J) < R_Vec (J);
1847 function UI_Max (Left : Int; Right : Valid_Uint) return Valid_Uint is
1849 return UI_Max (UI_From_Int (Left), Right);
1852 function UI_Max (Left : Valid_Uint; Right : Int) return Valid_Uint is
1854 return UI_Max (Left, UI_From_Int (Right));
1857 function UI_Max (Left : Valid_Uint; Right : Valid_Uint) return Valid_Uint is
1859 if Left >= Right then
1870 function UI_Min (Left : Int; Right : Valid_Uint) return Valid_Uint is
1872 return UI_Min (UI_From_Int (Left), Right);
1875 function UI_Min (Left : Valid_Uint; Right : Int) return Valid_Uint is
1877 return UI_Min (Left, UI_From_Int (Right));
1880 function UI_Min (Left : Valid_Uint; Right : Valid_Uint) return Valid_Uint is
1882 if Left <= Right then
1893 function UI_Mod (Left : Int; Right : Nonzero_Uint) return Valid_Uint is
1895 return UI_Mod (UI_From_Int (Left), Right);
1899 (Left : Valid_Uint; Right : Nonzero_Int) return Valid_Uint
1902 return UI_Mod (Left, UI_From_Int (Right));
1906 (Left : Valid_Uint; Right : Nonzero_Uint) return Valid_Uint
1908 Urem : constant Valid_Uint := Left rem Right;
1911 if (Left < Uint_0) = (Right < Uint_0)
1912 or else Urem = Uint_0
1916 return Right + Urem;
1920 -------------------------------
1921 -- UI_Modular_Exponentiation --
1922 -------------------------------
1924 function UI_Modular_Exponentiation
1927 Modulo : Valid_Uint) return Valid_Uint
1929 M : constant Save_Mark := Mark;
1931 Result : Valid_Uint := Uint_1;
1932 Base : Valid_Uint := B;
1933 Exponent : Valid_Uint := E;
1936 while Exponent /= Uint_0 loop
1937 if Least_Sig_Digit (Exponent) rem Int'(2) = Int
'(1) then
1938 Result := (Result * Base) rem Modulo;
1941 Exponent := Exponent / Uint_2;
1942 Base := (Base * Base) rem Modulo;
1945 Release_And_Save (M, Result);
1947 end UI_Modular_Exponentiation;
1949 ------------------------
1950 -- UI_Modular_Inverse --
1951 ------------------------
1953 function UI_Modular_Inverse
1954 (N : Valid_Uint; Modulo : Valid_Uint) return Valid_Uint
1956 M : constant Save_Mark := Mark;
1974 UI_Div_Rem (U, V, Quotient => Q, Remainder => R);
1984 exit when R = Uint_1;
1987 if S = Int'(-1) then
1991 Release_And_Save
(M
, X
);
1993 end UI_Modular_Inverse
;
1999 function UI_Mul
(Left
: Int
; Right
: Valid_Uint
) return Valid_Uint
is
2001 return UI_Mul
(UI_From_Int
(Left
), Right
);
2004 function UI_Mul
(Left
: Valid_Uint
; Right
: Int
) return Valid_Uint
is
2006 return UI_Mul
(Left
, UI_From_Int
(Right
));
2009 function UI_Mul
(Left
: Valid_Uint
; Right
: Valid_Uint
) return Valid_Uint
is
2011 -- Case where product fits in the range of a 32-bit integer
2013 if Int
(Left
) <= Int
(Uint_Max_Simple_Mul
)
2015 Int
(Right
) <= Int
(Uint_Max_Simple_Mul
)
2017 return UI_From_Int
(Direct_Val
(Left
) * Direct_Val
(Right
));
2020 -- Otherwise we have the general case (Algorithm M in Knuth)
2023 L_Length
: constant Int
:= N_Digits
(Left
);
2024 R_Length
: constant Int
:= N_Digits
(Right
);
2025 L_Vec
: UI_Vector
(1 .. L_Length
);
2026 R_Vec
: UI_Vector
(1 .. R_Length
);
2030 Init_Operand
(Left
, L_Vec
);
2031 Init_Operand
(Right
, R_Vec
);
2032 Neg
:= (L_Vec
(1) < Int_0
) xor (R_Vec
(1) < Int_0
);
2033 L_Vec
(1) := abs (L_Vec
(1));
2034 R_Vec
(1) := abs (R_Vec
(1));
2036 Algorithm_M
: declare
2037 Product
: UI_Vector
(1 .. L_Length
+ R_Length
);
2042 for J
in Product
'Range loop
2046 for J
in reverse R_Vec
'Range loop
2048 for K
in reverse L_Vec
'Range loop
2050 L_Vec
(K
) * R_Vec
(J
) + Product
(J
+ K
) + Carry
;
2051 Product
(J
+ K
) := Tmp_Sum
rem Base
;
2052 Carry
:= Tmp_Sum
/ Base
;
2055 Product
(J
) := Carry
;
2058 return Vector_To_Uint
(Product
, Neg
);
2067 function UI_Ne
(Left
: Int
; Right
: Valid_Uint
) return Boolean is
2069 return UI_Ne
(UI_From_Int
(Left
), Right
);
2072 function UI_Ne
(Left
: Valid_Uint
; Right
: Int
) return Boolean is
2074 return UI_Ne
(Left
, UI_From_Int
(Right
));
2077 function UI_Ne
(Left
: Valid_Uint
; Right
: Valid_Uint
) return Boolean is
2079 pragma Assert
(Present
(Left
));
2080 pragma Assert
(Present
(Right
));
2081 -- Assertions are here in case we're called from C++ code, which does
2082 -- not check the predicates.
2084 -- Quick processing for identical arguments
2086 if Int
(Left
) = Int
(Right
) then
2090 -- See if left operand directly represented
2092 if Direct
(Left
) then
2094 -- If right operand directly represented then compare
2096 if Direct
(Right
) then
2097 return Int
(Left
) /= Int
(Right
);
2099 -- Left operand directly represented, right not, must be unequal
2105 -- Right operand directly represented, left not, must be unequal
2107 elsif Direct
(Right
) then
2111 -- Otherwise both multi-word, do comparison
2114 Size
: constant Int
:= N_Digits
(Left
);
2119 if Size
/= N_Digits
(Right
) then
2123 Left_Loc
:= Uints
.Table
(Left
).Loc
;
2124 Right_Loc
:= Uints
.Table
(Right
).Loc
;
2126 for J
in Int_0
.. Size
- Int_1
loop
2127 if Udigits
.Table
(Left_Loc
+ J
) /=
2128 Udigits
.Table
(Right_Loc
+ J
)
2142 function UI_Negate
(Right
: Valid_Uint
) return Valid_Uint
is
2144 -- Case where input is directly represented. Note that since the range
2145 -- of Direct values is non-symmetrical, the result may not be directly
2146 -- represented, this is taken care of in UI_From_Int.
2148 if Direct
(Right
) then
2149 return UI_From_Int
(-Direct_Val
(Right
));
2151 -- Full processing for multi-digit case. Note that we cannot just copy
2152 -- the value to the end of the table negating the first digit, since the
2153 -- range of Direct values is non-symmetrical, so we can have a negative
2154 -- value that is not Direct whose negation can be represented directly.
2158 R_Length
: constant Int
:= N_Digits
(Right
);
2159 R_Vec
: UI_Vector
(1 .. R_Length
);
2163 Init_Operand
(Right
, R_Vec
);
2164 Neg
:= R_Vec
(1) > Int_0
;
2165 R_Vec
(1) := abs R_Vec
(1);
2166 return Vector_To_Uint
(R_Vec
, Neg
);
2175 function UI_Rem
(Left
: Int
; Right
: Nonzero_Uint
) return Valid_Uint
is
2177 return UI_Rem
(UI_From_Int
(Left
), Right
);
2181 (Left
: Valid_Uint
; Right
: Nonzero_Int
) return Valid_Uint
2184 return UI_Rem
(Left
, UI_From_Int
(Right
));
2188 (Left
: Valid_Uint
; Right
: Nonzero_Uint
) return Valid_Uint
2190 Remainder
: Valid_Uint
;
2191 Ignored_Quotient
: Uint
;
2194 pragma Assert
(Right
/= Uint_0
);
2196 if Direct
(Right
) and then Direct
(Left
) then
2197 return UI_From_Int
(Direct_Val
(Left
) rem Direct_Val
(Right
));
2201 (Left
, Right
, Ignored_Quotient
, Remainder
,
2202 Discard_Quotient
=> True);
2211 function UI_Sub
(Left
: Int
; Right
: Valid_Uint
) return Valid_Uint
is
2213 return UI_Add
(Left
, -Right
);
2216 function UI_Sub
(Left
: Valid_Uint
; Right
: Int
) return Valid_Uint
is
2218 return UI_Add
(Left
, -Right
);
2221 function UI_Sub
(Left
: Valid_Uint
; Right
: Valid_Uint
) return Valid_Uint
is
2223 if Direct
(Left
) and then Direct
(Right
) then
2224 return UI_From_Int
(Direct_Val
(Left
) - Direct_Val
(Right
));
2226 return UI_Add
(Left
, -Right
);
2234 function UI_To_CC
(Input
: Valid_Uint
) return Char_Code
is
2236 if Direct
(Input
) then
2237 return Char_Code
(Direct_Val
(Input
));
2239 -- Case of input is more than one digit
2243 In_Length
: constant Int
:= N_Digits
(Input
);
2244 In_Vec
: UI_Vector
(1 .. In_Length
);
2248 Init_Operand
(Input
, In_Vec
);
2250 -- We assume value is positive
2253 for Idx
in In_Vec
'Range loop
2254 Ret_CC
:= Ret_CC
* Char_Code
(Base
) +
2255 Char_Code
(abs In_Vec
(Idx
));
2267 function UI_To_Int
(Input
: Valid_Uint
) return Int
is
2269 if Direct
(Input
) then
2270 return Direct_Val
(Input
);
2272 -- Case of input is more than one digit
2276 In_Length
: constant Int
:= N_Digits
(Input
);
2277 In_Vec
: UI_Vector
(1 .. In_Length
);
2281 -- Uints of more than one digit could be outside the range for
2282 -- Ints. Caller should have checked for this if not certain.
2283 -- Constraint_Error to attempt to convert from value outside
2286 if not UI_Is_In_Int_Range
(Input
) then
2287 raise Constraint_Error
;
2290 -- Otherwise, proceed ahead, we are OK
2292 Init_Operand
(Input
, In_Vec
);
2295 -- Calculate -|Input| and then negates if value is positive. This
2296 -- handles our current definition of Int (based on 2s complement).
2297 -- Is it secure enough???
2299 for Idx
in In_Vec
'Range loop
2300 Ret_Int
:= Ret_Int
* Base
- abs In_Vec
(Idx
);
2303 if In_Vec
(1) < Int_0
then
2316 function UI_To_Unsigned_64
(Input
: Valid_Uint
) return Unsigned_64
is
2318 if Input
< Uint_0
then
2319 raise Constraint_Error
;
2322 if Direct
(Input
) then
2323 return Unsigned_64
(Direct_Val
(Input
));
2325 -- Case of input is more than one digit
2328 if Input
>= Uint_2
**Int
'(64) then
2329 raise Constraint_Error;
2333 In_Length : constant Int := N_Digits (Input);
2334 In_Vec : UI_Vector (1 .. In_Length);
2335 Ret_Int : Unsigned_64 := 0;
2338 Init_Operand (Input, In_Vec);
2340 for Idx in In_Vec'Range loop
2342 Ret_Int * Unsigned_64 (Base) + Unsigned_64 (In_Vec (Idx));
2348 end UI_To_Unsigned_64;
2354 procedure UI_Write (Input : Uint; Format : UI_Format := Auto) is
2356 Image_Out (Input, False, Format);
2359 ---------------------
2360 -- Vector_To_Uint --
2361 ---------------------
2363 function Vector_To_Uint
2364 (In_Vec : UI_Vector;
2365 Negative : Boolean) return Valid_Uint
2371 -- The vector can contain leading zeros. These are not stored in the
2372 -- table, so loop through the vector looking for first non-zero digit
2374 for J in In_Vec'Range loop
2375 if In_Vec (J) /= Int_0 then
2377 -- The length of the value is the length of the rest of the vector
2379 Size := In_Vec'Last - J + 1;
2381 -- One digit value can always be represented directly
2383 if Size = Int_1 then
2385 return Valid_Uint (Int (Uint_Direct_Bias) - In_Vec (J));
2387 return Valid_Uint (Int (Uint_Direct_Bias) + In_Vec (J));
2390 -- Positive two digit values may be in direct representation range
2392 elsif Size = Int_2 and then not Negative then
2393 Val := In_Vec (J) * Base + In_Vec (J + 1);
2395 if Val <= Max_Direct then
2396 return Valid_Uint (Int (Uint_Direct_Bias) + Val);
2400 -- The value is outside the direct representation range and must
2401 -- therefore be stored in the table. Expand the table to contain
2402 -- the count and digits. The index of the new table entry will be
2403 -- returned as the result.
2405 Uints.Append ((Length => Size, Loc => Udigits.Last + 1));
2413 Udigits.Append (Val);
2415 for K in 2 .. Size loop
2416 Udigits.Append (In_Vec (J + K - 1));
2423 -- Dropped through loop only if vector contained all zeros