"

 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:'DecimalPointCharacter DecimalPointCharacterForPrinting

		DecimalPointCharacters DecimalPointCharactersForReading'

	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

    [class variables:]

        DecimalPointCharacterForPrinting          <Character>                     used when printing

        DecimalPointCharactersForReading          <Collection of Character>       accepted as decimalPointChars when reading

    [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:"

    ^ self

        fromString:aString

        decimalPointCharacters:(self decimalPointCharactersForReading) 

    "

     Number fromString:'12345'

     Number fromString:'abc'

     Number fromString:'1abc'

     '12345' asNumber

    "

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

!

fromString:aString decimalPointCharacters:decimalPointCharacters

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

    |s num|

    s := aString readStream.

    num := self readFrom:s decimalPointCharacters:decimalPointCharacters 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 decimalPointCharacters:decimalPointCharacters onError:exceptionBlock

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

    ^ self readFrom:aString decimalPointCharacters:decimalPointCharacters onError:exceptionBlock

    "

     Number fromString:'12345' onError:0

     Number fromString:'fooBarBaz' onError:0

    "

    "Modified: / 3.8.1998 / 20:05:34 / 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 decimalPointCharacters:decimalPointCharacters 

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

     skipping all whitespace first; return the value of exceptionBlock,

     if no number can be read.

     This method is less strict than the smalltalk number reader; it

     allows for prefixed + and also allows missing fractional part after eE"

    ^ self

        readFrom:aStringOrStream 

        decimalPointCharacters:decimalPointCharacters 

        onError:[self error:'conversion error for: ' , self name]

    "

     Number readFrom:'123.456' decimalPointCharacters:'.'      

     Number readFrom:'123,456' decimalPointCharacters:'.,'     

     Number readFrom:'123,456' decimalPointCharacters:'.'     

    "

!

readFrom:aStringOrStream decimalPointCharacters:decimalPointCharacters 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.

     This method is less strict than the smalltalk number reader; it

     allows for prefixed + and also allows missing fractional part after eE"

    ^ [

        |value intValue mantissaAndScale scale decimalMantissa str 

         nextChar radix negative signExp exp 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:[(decimalPointCharacters includes:nextChar)]) ifFalse:[

            ^ exceptionBlock value.

"/          value := super readFrom:str.

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

"/          ^ value

        ].

        (decimalPointCharacters includes: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.

        ].

        (decimalPointCharacters includes:nextChar) ifTrue:[

            str next.

            nextChar := str peekOrNil.

            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

                ]

            ].

            ('qQ' includes:nextChar) ifTrue:[

                value := value asLongFloat.

            ] ifFalse:[

                value := value asFloat.

"/ future: (for now, always create Doubles for Dolphin,Squeak etc. compatibility

"/                ('eE' includes:nextChar) ifTrue:[

"/                    value := value asShortFloat

"/                ]

            ].

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

                exp := (Integer readFrom:str radix:radix) * signExp.

                value := value * ((value class unity * 10.0) raisedToInteger:exp)

            ]

        ] ifFalse:[

            ('s' includes:nextChar) ifTrue:[

                str next.

                nextChar := str peekOrNil.

                (nextChar notNil and:[ nextChar isDigit]) ifTrue:[

                    scale := (Integer readFrom:str).

                ].

                mantissaAndScale isNil ifTrue:[

                    value := intValue asFixedPoint:(scale ? 0).

                ] ifFalse:[

                    denom := 10 raisedTo:mantissaAndScale last.

                    value := FixedPoint 

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

                                denominator:denom

                                scale:(scale ? mantissaAndScale last).

                ].

            ] ifFalse:[

                value isLimitedPrecisionReal ifTrue:[

                    value := value asFloat.

                ]

            ].

        ].

        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:'12345678901234567890.0') 

     Number readFrom:(ReadStream on:'12345678901234567890.012345678901234567890') 

     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'      

     Number readFrom:'.0000000q'      

     Number readFrom:'.0000000f'      

     Number readFrom:'.0000000e'      

     Number readFrom:'.0000000s1'      

     Number readFrom:'.0000000q1'      

     Number readFrom:'.0000000f1'      

     Number readFrom:'.0000000e1'      

     DecimalPointCharactersForReading := #( $. $, ).   

     Number readFrom:'99,00'      

     DecimalPointCharactersForReading := #( $. ).   

     Number readFrom:'99,00'      

    "

    "Modified: / 14.4.1998 / 19:22:50 / 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.

     This method is less strict than the smalltalk number reader; it

     allows for prefixed + and also allows missing fractional part after eE"

    ^ self 

        readFrom:aStringOrStream 

        decimalPointCharacters:(self decimalPointCharactersForReading) 

        onError:exceptionBlock

    "

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

     Number readFrom:(ReadStream on:'12345678901234567890') 

     Number readFrom:(ReadStream on:'12345678901234567890.0') 

     Number readFrom:(ReadStream on:'12345678901234567890.012345678901234567890') 

     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'      

     Number readFrom:'.0000000q'      

     Number readFrom:'.0000000f'      

     Number readFrom:'.0000000e'      

     Number readFrom:'.0000000s1'      

     Number readFrom:'.0000000q1'      

     Number readFrom:'.0000000f1'      

     Number readFrom:'.0000000e1'      

     DecimalPointCharactersForReading := #( $. $, ).   

     Number readFrom:'99,00'      

     DecimalPointCharactersForReading := #( $. ).   

     Number readFrom:'99,00'      

    "

!

readSmalltalkSyntaxFrom:aStream

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

     read and return the next Number in smalltalk syntax from the 

     (character-) aStream.

     Returns nil if aStream contains no valid number."

    ^ 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:'constants'!

decimalPointCharacter 

    "printed"

    <resource: #obsolete>

    ^ self decimalPointCharacterForPrinting

!

decimalPointCharacter:aCharacter 

    "printed"

    <resource: #obsolete>

    self decimalPointCharacterForPrinting:aCharacter

    "

     1.5 printString

     Number decimalPointCharacter:$,.

     1.5 printString       

     Number decimalPointCharacter:$..

    "

!

decimalPointCharacterForPrinting 

    "printed"

    DecimalPointCharacterForPrinting isNil ifTrue:[

        ^ $.

    ].

    ^ DecimalPointCharacterForPrinting

!

decimalPointCharacterForPrinting:aCharacter 

    "printed"

    DecimalPointCharacterForPrinting := aCharacter

    "

     1.5 printString

     Number decimalPointCharacterForPrinting:$,.

     1.5 printString       

     Number decimalPointCharacterForPrinting:$..

    "

!

decimalPointCharacters 

    "accepted when converting from a string"

    <resource: #obsolete>

    ^ self decimalPointCharactersForReading

    "

     1.5 printString

     Number decimalPointCharacters:#( $. $,) .

     Number fromString:'1.5'.     

     Number fromString:'1,5'.     

     Number decimalPointCharacters:#( $. ).

    "

!

decimalPointCharacters:aCollectionOfCharacters 

    "accepted when converting from a string"

    <resource: #obsolete>

    self decimalPointCharactersForReading:aCollectionOfCharacters 

    "

     Number decimalPointCharacters:#( $. $,) .

     Number fromString:'1.5'.     

     Number fromString:'1,5'.     

     Number decimalPointCharacters:#( $. ).

    "

!

decimalPointCharactersForReading 

    "default when converting from a string"

    "/ cg: changing the default leads to trouble in some

    "/ language processors (PrologScanner...)

    "/ PLEASE DO ONLY CHANGE THE DEFAULT BELOW FOR END-USER APPLICATIONS (if at all).

    "/ BETTER: pass the DecimalPointCharacterSet explicitly

    DecimalPointCharactersForReading isNil ifTrue:[

        ^ #( $. )

    ].

    ^ DecimalPointCharactersForReading

    "

     1.5 printString

     Number decimalPointCharactersForReading:#( $. $,) .

     Number fromString:'1.5'.     

     Number fromString:'1,5'.     

     Number decimalPointCharactersForReading:#( $. ).

    "

!

decimalPointCharactersForReading:aCollectionOfCharacters 

    "accepted when converting from a string"

    DecimalPointCharactersForReading := aCollectionOfCharacters

    "

     Number decimalPointCharactersForReading:#( $. $,) .

     Number fromString:'1.5'.     

     Number fromString:'1,5'.     

     Number decimalPointCharactersForReading:#( $. ).

    "

!

epsilon

    "return the maximum relative spacing of instances of mySelf 

     (i.e. the value-delta of the least significant bit)"

     ^ self subclassResponsibility

!

epsilonForCloseTo

    "return the epsilon used in the closeTo: comparison.