"

 COPYRIGHT (c) 1994 by Claus Gittinger

	      All Rights Reserved

 This software is furnished under a license and may be used

 only in accordance with the terms of that license and with the

 inclusion of the above copyright notice.   This software may not

 be provided or otherwise made available to, or used by, any

 other person.  No title to or ownership of the software is

 hereby transferred.

"

Integer subclass:#LargeInteger

	instanceVariableNames:'sign digitByteArray'

	classVariableNames:''

	poolDictionaries:''

	category:'Magnitude-Numbers'

!

copyright

"

 COPYRIGHT (c) 1994 by Claus Gittinger

	      All Rights Reserved

 This software is furnished under a license and may be used

 only in accordance with the terms of that license and with the

 inclusion of the above copyright notice.   This software may not

 be provided or otherwise made available to, or used by, any

 other person.  No title to or ownership of the software is

 hereby transferred.

"

!

documentation

"

    This class provides arbitrary precision integers. These are represented as:

      sign (-1/0/+1) and, if sign ~~ 0

      a ByteArray of digits with 8 bits per element; 

      least significant 8 bits at index 1 ...

    The implementation is definitely not tuned for high performance

    (some key-methods should be rewritten as primitives),

    but ok for now, since LargeIntegers are not used very often.

    It will be reimplemented when everything else runs fine and a need arises

    (or someone rewrites it and sends me the code :-).

    For real speed, its implementation should be mapped onto a tuned arbitrary

    precision math package (maybe even special-cased for 32 and 64 bit 

    large-ints, since those are the most common).

    LargeIntegers are usually not created explicitely, but result from 

    SmallInteger arithmetic overflowing the SmallInteger range.

    Also, results of LargeInteger operations are converted to back to 

    SmallIntegers, when possible (see normalize).

    In contrast to ST-80, there is only one class for LargeIntegers, keeping

    the sign as an instance variable (ST-80 has LargePositiveInteger and

    LargeNegativeInteger). This may change.

    [author:]

        Claus Gittinger

"

! !

new

    "catch creation message"

    self error:'LargeIntegers cannot be created with new'

!

new:numberOfDigits

    "catch creation message"

    self error:'LargeIntegers cannot be created with new'

!

sign:s value16:ll value16:ml value16:mh value16:hh

    "create and return a new LargeInteger, with value taken from the

     four 16-bit unsigned value-args.

     This is sent internally, when a 64bit result has been created in

     SmallInteger multiplication or bitShift:.

     May change without notice."

    |newLarge digitBytes 

     hhI "{ Class: SmallInteger }"

     mhI "{ Class: SmallInteger }"

     mlI "{ Class: SmallInteger }"

     llI "{ Class: SmallInteger }"

     b1 "{ Class: SmallInteger }"

     b2 "{ Class: SmallInteger }"

     b3 "{ Class: SmallInteger }"

     b4 "{ Class: SmallInteger }"

     b5 "{ Class: SmallInteger }"

     b6 "{ Class: SmallInteger }"

     b7 "{ Class: SmallInteger }"

     b8 "{ Class: SmallInteger }"

     n "{ Class: SmallInteger }"|

    "

     this will change, once arguments can have a type-constraint

    "

    hhI := hh.

    mhI := mh.

    mlI := ml.

    llI := ll.

    "

     the following code is somewhat ugly, but includes an unrolled

     normalization, and is thus relatively fast ....

    "

    b8 := (hh bitShift:-8) bitAnd:16rFF.

    b7 := hh bitAnd:16rFF.

    b6 := (mh bitShift:-8) bitAnd:16rFF.

    b5 := mh bitAnd:16rFF.

    b4 := (ml bitShift:-8) bitAnd:16rFF.

    b3 := ml bitAnd:16rFF.

    b2 := (ll bitShift:-8) bitAnd:16rFF.

    b1 := ll bitAnd:16rFF.

    b8 ~~ 0 ifTrue:[

	n := 8

    ] ifFalse:[

	b7 ~~ 0 ifTrue:[

	    n := 7.

	] ifFalse:[

	    b6 ~~ 0 ifTrue:[

		n := 6.

	    ] ifFalse:[

		b5 ~~ 0 ifTrue:[

		    n := 5

		] ifFalse:[

		    b4 ~~ 0 ifTrue:[

			n := 4

		    ] ifFalse:[

			b3 ~~ 0 ifTrue:[

			    n := 3

			] ifFalse:[

			    b2 ~~ 0 ifTrue:[

				n := 2

			    ] ifFalse:[

				n := 1

			    ]

			]

		    ]

		]

	    ]

	]

    ].

    digitBytes := ByteArray uninitializedNew:n.

    digitBytes at:1 put:b1.

    n > 1 ifTrue:[

	digitBytes at:2 put:b2.

	n > 2 ifTrue:[

	    digitBytes at:3 put:b3.

	    n > 3 ifTrue:[

		digitBytes at:4 put:b4.

		n > 4 ifTrue:[

		    digitBytes at:5 put:b5.

		    n > 5 ifTrue:[

			digitBytes at:6 put:b6.

			n > 6 ifTrue:[

			    digitBytes at:7 put:b7.

			    n > 7 ifTrue:[

				digitBytes at:8 put:b8.

			    ]

			]

		    ]

		]

	    ]

	]

    ].

    newLarge := self basicNew setDigits:digitBytes.

    s < 0 ifTrue:[newLarge sign:s].

    ^ newLarge

!

unsignedValueLow:lowBits hi:hiBits

    "create and return a new LargeInteger with value taken from

     the two 16-bit unsigned args. 

     The largeinteger is normalized (but not to a smallInteger).

     This method is called from the runtime system (+, -),

     when an integer result has to be converted to a Large.

     May change without notice."

    |bytes b1 b2 b3 b4|

    b4 := (hiBits bitShift:-8) bitAnd:16rFF.

    b3 := hiBits bitAnd:16rFF.

    b2 := (lowBits bitShift:-8) bitAnd:16rFF.

    b1 := lowBits bitAnd:16rFF.

    b4 ~~ 0 ifTrue:[

	bytes := ByteArray with:b1 with:b2 with:b3 with:b4

    ] ifFalse:[

	b3 ~~ 0 ifTrue:[

	    bytes := ByteArray with:b1 with:b2 with:b3

	] ifFalse:[

	    b2 ~~ 0 ifTrue:[

		bytes := ByteArray with:b1 with:b2

	    ] ifFalse:[

		bytes := ByteArray with:b1

	    ]

	]

    ].

    ^ (self basicNew) setDigits:bytes

!

value:aSmallInteger

    "create and return a new LargeInteger with value taken from

     the argument, aSmallInteger.

     Notice: this should be only used internally, since such small

     largeIntegers do not normally occur in the system.

     May change without notice."

    ^ self basicNew value:aSmallInteger

    "LargeInteger value:3689"

!

valueLow:lowBits hi:hiBits

    "create and return a new LargeInteger with value taken from

     the two 16-bit args, where the sign of the high bits determines

     the sign of the result. 

     The largeinteger is normalized (but not to a smallInteger).

     This method is called from the runtime system (+, -),

     when an integer result has to be converted to a Large.

     May change without notice."

    |newLarge|

    hiBits < 0 ifTrue:[

	newLarge := self unsignedValueLow:lowBits hi:(hiBits negated).

	newLarge sign:-1.

	^ newLarge

    ].

    ^ self unsignedValueLow:lowBits hi:hiBits

! !

isBuiltInClass

    "return true if this class is known by the run-time-system.

     Here, true is returned."

    ^ true

    "Modified: 23.4.1996 / 15:59:21 / cg"

! !

!LargeInteger methodsFor:'arithmetic'!

* aNumber

    "return the product of the receiver and the argument, aNumber"

    |otherSign|

    (sign == 0) ifTrue:[^ 0].  "cannot happen if correctly normalized"

    "

     this is the common case, multiplying with SmallInteger.

     Use a special method for this case ...

    "

    (aNumber class == SmallInteger) ifTrue:[

	^ self productFromInteger:aNumber

    ].

    "

     if the argument is not a largeInteger, coerce

    "

    (aNumber class == self class) ifFalse:[

	^ self retry:#* coercing:aNumber

    ].

    otherSign := aNumber sign.

    (sign == otherSign) ifTrue:[^ self absMul:aNumber].

    (otherSign == 0) ifTrue:[^ 0].

    ^ (self absMul:aNumber) sign:-1

!

+ aNumber

    "return the sum of the receiver and the argument, aNumber"

    |otherSign|

    (sign == 0) ifTrue:[^ aNumber].  "cannot happen if correctly normalized"

    "

     this is the common case, adding a SmallInteger.

     Use a special method for this case ...

    "

    (aNumber class == SmallInteger) ifTrue:[

	^ self sumFromInteger:aNumber

    ].

    "

     if the argument is not a largeInteger, coerce

    "

    (aNumber class == self class) ifFalse:[

	^ self retry:#+ coercing:aNumber

    ].

    otherSign := aNumber sign.

    (sign > 0) ifTrue:[

	"I am positive"

	(otherSign > 0) ifTrue:[^ self absPlus:aNumber].

	(otherSign < 0) ifTrue:[^ self absMinus:aNumber].

	^ self

    ].

    "I am negative"

    (otherSign > 0) ifTrue:[^ aNumber absMinus:self].

    (otherSign < 0) ifTrue:[^ (self absPlus:aNumber) sign:-1].

    ^ self

    "

     SmallInteger maxVal 

     SmallInteger maxVal + 1  

     SmallInteger maxVal + 2 

     SmallInteger minVal    

     SmallInteger minVal - 1

    "

!

- aNumber

    "return the difference of the receiver and the argument, aNumber"

    |otherSign result|

    (sign == 0) ifTrue:[^ aNumber negated].     "cannot happen if correctly normalized"

    "

     this is the common case, subtracting a SmallInteger.

     Use a special method for this case ...

    "

    (aNumber class == SmallInteger) ifTrue:[

	sign < 0 ifTrue:[

	    aNumber > 0 ifTrue:[

		result := (self absFastPlus:aNumber) sign:-1

	    ] ifFalse:[

		result := (self absFastMinus:aNumber) sign:-1

	    ].

	] ifFalse:[

	    aNumber > 0 ifTrue:[

		result := self absFastMinus:aNumber

	    ] ifFalse:[

		result := self absFastPlus:aNumber

	    ]

	].

	^ result normalize.

    ].

    "

     if the argument is not a largeInteger, coerce

    "

    (aNumber class == self class) ifFalse:[

	^ self retry:#- coercing:aNumber

    ].

    otherSign := aNumber sign.

    (sign > 0) ifTrue:[

	"I am positive"

	(otherSign > 0) ifTrue:[^ self absMinus:aNumber].

	(otherSign < 0) ifTrue:[^ self absPlus:aNumber].

	^ self

    ].

    "I am negative"

    (otherSign > 0) ifTrue:[^ (self absPlus:aNumber) negated].

    (otherSign < 0) ifTrue:[^ (self absMinus:aNumber) negated].

    ^ self

    "

     12345678901234567890 - 0     

     12345678901234567890 - 1      

     12345678901234567890 - -1    

     -12345678901234567890 - 1     

     -12345678901234567890 - -1    

     12345678901234567890 - 12345678901234567880     

     12345678901234567890 - 12345000000000000000     

     12345678901234567890 - -87654321098765432110    

     -12345678901234567890 - 87654321098765432110    

     -12345678901234567890 - -12345678901234567880   

     -12345678901234567890 - -12345678901234567980   

    "

!

/ aNumber

    "return the quotient of the receiver and the argument, aNumber"

    aNumber isInteger ifTrue:[

	^ (Fraction numerator:self

		  denominator:aNumber) reduced

    ].

    "this is a q&d hack - we loose lots of precision here ..."

    ^ (self asFloat / aNumber asFloat)

!

// aNumber

    "return the quotient of the receiver and the argument, aNumber"

    |otherSign divMod d|

    otherSign := aNumber sign.

    "

     this is the common case, dividing by a SmallInteger.

     Use a special method for this case ...

    "

    (aNumber class == SmallInteger) ifTrue:[

	(aNumber abs between:1 and:16r003fffff) ifTrue:[

	    sign < 0 ifTrue:[

		(sign == otherSign) ifTrue:[^ (self absFastDiv:aNumber negated) at:1].

		d := aNumber.

	    ] ifFalse:[

		(sign == otherSign) ifTrue:[^ (self absFastDiv:aNumber) at:1].

		d := aNumber negated

	    ].

	    divMod := self absFastDiv:d.

	    "/ stupid adjust ...

	    (divMod at:2) == 0 ifFalse:[

		^ ((divMod at:1) sign:-1) - 1

	    ].

	    ^ (divMod at:1) sign:-1

	]

    ].

    "

     if the argument is not a largeInteger, coerce

    "

    (aNumber class == self class) ifFalse:[

	^ self retry:#// coercing:aNumber

    ].

    sign < 0 ifTrue:[

	(sign == otherSign) ifTrue:[^ (self absDiv:aNumber negated) at:1].

    ] ifFalse:[

	(sign == otherSign) ifTrue:[^ (self absDiv:aNumber) at:1].

    ].

    divMod := self absDiv:aNumber.

    "/ stupid adjust ...

    (divMod at:2) == 0 ifFalse:[

	^ ((divMod at:1) sign:-1) - 1

    ].

    ^ (divMod at:1) sign:-1

    "

     9000000000 // 4000000000   => 2

     -9000000000 // 4000000000  => -3

     9000000000 // -4000000000  => -3

     -9000000000 // -4000000000 => 2

     9000000000 quo: 4000000000   => 2

     -9000000000 quo: 4000000000  => -2

     9000000000 quo: -4000000000  => -2

     -9000000000 quo: -4000000000 => 2

    "

!

\\ aNumber

    "return the remainder of division of the receiver by the argument, aNumber"

    |otherSign|

    otherSign := aNumber sign.

    "

     this is the common case, dividing by a SmallInteger.

     Use a special method for this case ...

    "

    (aNumber class == SmallInteger) ifTrue:[

	(aNumber abs between:1 and:16r003fffff) ifTrue:[

	    ^ ((self absFastDiv:aNumber) at:2)

	]

    ].

    "

     if the argument is not a largeInteger, coerce

    "

    (aNumber class == self class) ifFalse:[

	^ self retry:#\\ coercing:aNumber

    ].

    ^ ((self absDiv:aNumber) at:2)