"

 COPYRIGHT (c) 1988 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.

"

"{ Package: 'stx:libbasic' }"

ArithmeticValue subclass:#Number

	instanceVariableNames:''

	classVariableNames:''

	poolDictionaries:''

	category:'Magnitude-Numbers'

!

!Number class methodsFor:'documentation'!

copyright

"

 COPYRIGHT (c) 1988 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

"

    abstract superclass for all kinds of numbers

    [author:]

	Claus Gittinger

    [see also:]

	Integer LargeInteger SmallInteger

	LimitedPrecisionReal Float ShortFloat

	Fraction FixedPoint

"

! !

!Number class methodsFor:'instance creation'!

fromString:aString

    "for compatibility with other smalltalks - same as #readFrom:"

    |s num|

    s := aString readStream.

    num := self readFrom:s onError:[^ self error:'invalid number'].

    s atEnd ifFalse:[^ self error:'garbage at end of number'].

    ^ num.

    "

     Number fromString:'12345'

     Number fromString:'abc'

     Number fromString:'1abc'

     '12345' asNumber

    "

    "Modified: / 3.8.1998 / 20:05:11 / cg"

!

fromString:aString onError:exceptionBlock

    "for compatibility with other smalltalks - same as #readFrom:"

    ^ self readFrom:aString onError:exceptionBlock

    "

     Number fromString:'12345' onError:0

     Number fromString:'fooBarBaz' onError:0

    "

    "Modified: / 3.8.1998 / 20:05:34 / cg"

!

readFrom:aStringOrStream onError:exceptionBlock

    "return the next Number from the (character-)stream aStream;

     skipping all whitespace first; return the value of exceptionBlock,

     if no number can be read."

    ^ [

        |value intValue mantissaAndScale scale decimalMantissa str 

         nextChar radix negative signExp denom|

        str := aStringOrStream readStream.

        nextChar := str skipSeparators.

        nextChar isNil ifTrue:[^ exceptionBlock value].

        (nextChar == $-) ifTrue:[

            negative := true.

            str next.

            nextChar := str peekOrNil

        ] ifFalse:[

            negative := false.

            (nextChar == $+) ifTrue:[

                str next.

                nextChar := str peekOrNil

            ]

        ].

        (nextChar isDigit or:[nextChar == $.]) ifFalse:[

            ^ exceptionBlock value.

"/          value := super readFrom:str.

"/          negative ifTrue:[value := value negated].

"/          ^ value

        ].

        nextChar == $. ifTrue:[

            radix := 10.

            value := 0.0.

            intValue := 0.

        ] ifFalse:[

            value := Integer readFrom:str radix:10.

            nextChar := str peekOrNil.

            ((nextChar == $r) or:[ nextChar == $R]) ifTrue:[

                str next.

                radix := value.

                value := Integer readFrom:str radix:radix.

            ] ifFalse:[

                radix := 10

            ].

            intValue := value.

        ].

        (nextChar == $.) ifTrue:[

            str next.

            nextChar := str peekOrNil.

            scale := 0.

            decimalMantissa := 0.

            (nextChar notNil and:[nextChar isDigitRadix:radix]) ifTrue:[

                mantissaAndScale := Number readMantissaAndScaleFrom:str radix:radix.

                value := value asFloat + (mantissaAndScale first).

                nextChar := str peekOrNil

            ]

        ].

        ('eEdDqQ' includes:nextChar) ifTrue:[

            str next.

            nextChar := str peekOrNil.

            signExp := 1.

            (nextChar == $+) ifTrue:[

                str next.

                nextChar := str peekOrNil.

            ] ifFalse:[

                (nextChar == $-) ifTrue:[

                    str next.

                    nextChar := str peekOrNil.

                    signExp := -1

                ]

            ].

            (nextChar notNil and:[(nextChar isDigitRadix:radix)]) ifTrue:[

                value := value asFloat 

                         * (10.0 raisedToInteger:

                                    ((Integer readFrom:str radix:radix) * signExp))

            ]

        ] ifFalse:[

            ('s' includes:nextChar) ifTrue:[

                mantissaAndScale isNil ifTrue:[

                    value := intValue asFixedPoint:0.

                ] ifFalse:[

                    denom := 10 raisedTo:mantissaAndScale last.

                    value := FixedPoint 

                                numerator:(intValue * denom) + (mantissaAndScale second)

                                denominator:denom

                                scale:mantissaAndScale last.

                ].

            ]

        ].

        negative ifTrue:[

            value := value negated

        ].

        value.

    ] on:Error do:exceptionBlock

    "

     Number readFrom:(ReadStream on:'54.32e-01')      

     Number readFrom:(ReadStream on:'12345678901234567890') 

     Number readFrom:(ReadStream on:'16rAAAAFFFFAAAAFFFF') 

     Number readFrom:'16rAAAAFFFFAAAAFFFF' 

     Number readFrom:'0.000001'  

     '+00000123.45' asNumber  

     Number readFrom:'99s'      

     Number readFrom:'99.00s'      

     Number readFrom:'99.0000000s'      

     Number readFrom:'.0000000s'      

    "

    "Modified: / 14.4.1998 / 19:22:50 / cg"

!

readSmalltalkSyntaxFrom:aStream

    "ST-80 compatibility (thanks to a note from alpha testers)

     read and return the next Number in smalltalk syntax from the 

     (character-)stream aStream."

    ^ Scanner scanNumberFrom:aStream

"/    ^ Compiler evaluate:aStream compile:false "/ self readFrom:aStream.

    "

     Number readSmalltalkSyntaxFrom:'99d'    

     Number readSmalltalkSyntaxFrom:'99.00d'    

     Number readSmalltalkSyntaxFrom:(ReadStream on:'54.32e-01')    

     Number readSmalltalkSyntaxFrom:(ReadStream on:'12345678901234567890')

     Number readSmalltalkSyntaxFrom:(ReadStream on:'16rAAAAFFFFAAAAFFFF')

     Number readSmalltalkSyntaxFrom:(ReadStream on:'(1/10)') 

     Number readFrom:(ReadStream on:'(1/10)') 

     Number readSmalltalkSyntaxFrom:(ReadStream on:'+00000123.45')  

     Number readFrom:(ReadStream on:'+00000123.45')  

     |s|

     s := ReadStream on:'2.'.

     Number readSmalltalkSyntaxFrom:s.

     s next    

     |s|

     s := ReadStream on:'2.0.'.

     Number readSmalltalkSyntaxFrom:s.

     s next    

    "

    "Modified: / 19.11.1999 / 18:26:47 / cg"

! !

!Number class methodsFor:'error reporting'!

raise:aSignalSymbolOrErrorClass receiver:someNumber selector:sel arg:arg errorString:text 

    "ST-80 compatible signal raising. Provided for PD numeric classes"

    <context: #return>

    ^ self

        raise:aSignalSymbolOrErrorClass 

        receiver:someNumber 

        selector:sel 

        arguments:(Array with:arg)

        errorString:text 

    "

     Number 

        raise:#domainErrorSignal

        receiver:1.0

        selector:#sin

        arg:nil

        errorString:'foo bar test'

    "

    "Modified: / 16.11.2001 / 14:12:50 / cg"

!

raise:aSignalSymbolOrErrorClass receiver:someNumber selector:sel arguments:argArray errorString:text 

    "ST-80 compatible signal raising. Provided for PD numeric classes.

     aSignalSymbolOrErrorClass is either an Error-subclass, or

     the selector which is sent to myself, to retrieve the Exception class / Signal."

    <context: #return>

    |msg signalOrException|

    msg := MessageSend

                receiver:someNumber

                selector:sel

                arguments:argArray.

    aSignalSymbolOrErrorClass isSymbol ifTrue:[

        signalOrException := self perform:aSignalSymbolOrErrorClass.

    ] ifFalse:[

        signalOrException := aSignalSymbolOrErrorClass.    "/ assume its an Error-Subclass

    ].

    ^ signalOrException

         raiseRequestWith:msg 

         errorString:text 

         in:thisContext sender

    "

     Number 

        raise:#domainErrorSignal

        receiver:1.0

        selector:#foo 

        errorString:'foo bar test'

    "

    "Modified: / 16.11.2001 / 14:12:09 / cg"

!

raise:aSignalSymbolOrErrorClass receiver:someNumber selector:sel errorString:text 

    "ST-80 compatible signal raising. Provided for PD numeric classes.

     aSignalSymbolOrErrorClass is either an Error-subclass, or

     the selector which is sent to myself, to retrieve the Exception class / Signal."

    <context: #return>

    ^ self

        raise:aSignalSymbolOrErrorClass 

        receiver:someNumber 

        selector:sel 

        arguments:#()

        errorString:text 

    "

     Number 

        raise:#domainErrorSignal

        receiver:1.0

        selector:#foo 

        errorString:'foo bar test'

    "

    "Modified: / 16.11.2001 / 14:13:16 / cg"

! !

!Number class methodsFor:'private'!

readMantissaAndScaleFrom:aStream radix:radix

    "helper for readFrom: -

     return the mantissa (post-decimal-point digits) from the (character-)stream aStream;

     In addition, the scale (number of postDecimalPoint digits) is returned (to support

     reading fixedPoint numbers).

     No whitespace is skipped.

     Errs if no number available."

    |nextChar value factor intMantissa scale|

    value := 0.0.

    factor := 1.0 / radix.

    scale := 0.

    intMantissa := 0.

    nextChar := aStream peekOrNil.

    [nextChar notNil and:[nextChar isDigitRadix:radix]] whileTrue:[

        value := value + (nextChar digitValue * factor).

        intMantissa := (intMantissa * radix) + nextChar digitValue.

        factor := factor / radix.

        scale := scale + 1.

        aStream next.

        nextChar := aStream peekOrNil

    ].

    ^ (Array with:value with:intMantissa with:scale).

    "

     Number readMantissaAndScaleFrom:'234'    readStream radix:10. 

     Number readMantissaAndScaleFrom:'2'      readStream radix:10. 

     Number readMantissaAndScaleFrom:'234567' readStream radix:10. 

     Number readMantissaAndScaleFrom:'234000' readStream radix:10. 

     Number readMantissaAndScaleFrom:'234'    readStream radix:10. 

    "

    "Modified: / 14.4.1998 / 18:47:47 / cg"

!

readMantissaFrom:aStream radix:radix

    "helper for readFrom: -

     return the mantissa (post-decimal-point digits)

     from the (character-)stream aStream;

     No whitespace is skipped.

     Errs if no number available."

    ^ (self readMantissaAndScaleFrom:aStream radix:radix) first

    "

     Number readMantissaFrom:'234'    readStream radix:10.

     Number readMantissaFrom:'2'      readStream radix:10.

     Number readMantissaFrom:'234567' readStream radix:10.

    "

    "Modified: / 14.4.1998 / 18:47:47 / cg"

! !

!Number methodsFor:'Compatibility - Squeak'!

asSmallAngleDegrees

	"Return the receiver normalized to lie within the range (-180, 180)"

	| pos |

	pos _ self \\ 360.

	pos > 180 ifTrue: [pos _ pos - 360].

	^ pos

"#(-500 -300 -150 -5 0 5 150 300 500 1200) collect: [:n | n asSmallAngleDegrees]"

!

closeFrom:aNumber

    "are these two numbers close?"

    | fuzz |

    self isNaN == aNumber isNaN ifFalse: [^ false]. 

    self isInfinite == aNumber isInfinite ifFalse: [^ false].

    fuzz := (self abs max:aNumber abs) * 0.0001. 

    ^ (self - aNumber) abs <= fuzz

    "

     9.0 closeTo: 8.9999     

     9.9 closeTo: 9          

     (9/3) closeTo: 2.9999      

     1 closeTo: 0.9999      

     1 closeTo: 1.0001      

     1 closeTo: 1.001       

     1 closeTo: 0.999       

     0.9999 closeTo: 1      

     1.0001 closeTo: 1      

     1.001 closeTo: 1     

     0.999 closeTo: 1

     Float NaN closeTo:Float NaN

     Float infinity closeTo:Float infinity

    "

!

closeTo:num

    "are these two numbers close?"

    num isNumber ifFalse:[^false].

    ^ num closeFrom:self

    "

     1 closeTo:1.0000000001

     1 closeTo:1.001

    "

    "Created: / 5.11.2001 / 18:07:26 / cg"

!

newTileMorphRepresentative

	^ TileMorph new addArrows; setLiteral: self; addSuffixIfCan

!

stringForReadout

    ^ self rounded printString

! !

!Number methodsFor:'Compatibility - VW'!

** aNumber

    ^ self raisedTo:aNumber

! !

!Number methodsFor:'coercing'!

retry: aSymbol coercing: aNumber

    "Arithmetic represented by the symbol, aSymbol,

    could not be performed with the receiver and the argument,

    aNumber, because of the differences in representation.  Coerce either

    the receiver or the argument, depending on which has higher generality, and

    try again.  If the symbol is the equals sign, answer false if the argument

    is not a Number.  If the generalities are the same, create an error message."

    |myGenerality otherGenerality|

    (aSymbol == #=) ifTrue:[

        (aNumber respondsTo:#generality) ifFalse:[^ false]

    ] ifFalse:[

        (aNumber respondsTo:#generality) ifFalse:[

            self error:'retry:coercing: argument is not a number'.

            ^ self

        ]

    ].

    myGenerality := self generality.

    otherGenerality := aNumber generality.

    (myGenerality > otherGenerality) ifTrue:[

        ^ self perform:aSymbol with:(self coerce:aNumber)

    ].

    (myGenerality < otherGenerality) ifTrue:[

        (aNumber isNumber and:[aNumber isInfinite]) ifTrue: [

            ^ aNumber retryReverseOf:aSymbol with:self

        ].

        ^ (aNumber coerce:self) perform:aSymbol with:aNumber

    ].

    self error:'retry:coercing: oops - same generality'

! !

!Number methodsFor:'coercing & converting'!

coerce:aNumber

    "return aNumber converted into receivers type"

    ^ self subclassResponsibility

!

generality