"

 COPYRIGHT (c) 1989 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' }"

"{ NameSpace: Smalltalk }"

Number subclass:#Fraction

	instanceVariableNames:'numerator denominator'

	classVariableNames:'FractionOne FractionZero PrintWholeNumbers Pi Pi_1000 E Phi'

	poolDictionaries:''

	category:'Magnitude-Numbers'

!

!Fraction class methodsFor:'documentation'!

copyright

"

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

"

    Instances of Fraction represent fractional numbers consisting of

    a numerator and denominator. Both are themselfes arbitrary precision

    integers.

    Fractions are usually created by dividing Integers using / (for exact division).

    Notice, that all operations on fractions reduce their result; this means, that

    the result of a fraction-operation may return an integer.

    Aka:

        (1 / 7) * 7   ->  1  (not 0.99999999...)

    Mixed mode arithmetic:

        fraction op fraction    -> fraction/integer

        fraction op fix         -> fix; scale is fix's scale

        fraction op integer     -> fraction/integer

        fraction op float       -> float

    [classVariables:]

        PrintWholeNumbers       Boolean        experimental:

                                                controls how fractions which are greater than 1 are printed.

                                                if true, print them as a sum of an integral and the fractional part.

                                                (Large ones are easier to read this way)

                                                     (17/3) printString  -> '(5+(2/3))'

                                                for now, the default is false, for backward compatibility

    [author:]

        Claus Gittinger

    [see also:]

        Number

        FixedPoint Float ShortFloat LongFloat Integer Complex

"

! !

!Fraction class methodsFor:'instance creation'!

new

    "create and return a new fraction with value 0"

    ^ self numerator:0 denominator:1

!

numerator:num denominator:den

    "create and return a new fraction with numerator num and denominator den.

     Notice: stc inlines this message if sent to the global named Fraction."

    |newFraction|

%{  /* NOCONTEXT */

#ifdef __SCHTEAM__

    if (self == Fraction.Class) {

        return context._RETURN(new STFraction(num, den));

    }

#else

    /* this check allows subclassing .. */

    if (self == Fraction) {

        if (__bothSmallInteger(num, den)) {

            if (den != __mkSmallInteger(0)) {

                if (__CanDoQuickNew(sizeof(struct __Fraction))) {    /* OBJECT ALLOCATION */

                    OBJ newFraction;

                    INT iDen;

                    INT iNum;

                    __qCheckedNew(newFraction, sizeof(struct __Fraction));

                    __InstPtr(newFraction)->o_class = self;

                    __qSTORE(newFraction, self);

                    iDen = __intVal(den);

                    iNum = __intVal(num);

                    if (iDen < 0) {

                        iNum = -iNum;

                        iDen = -iDen;

                    }

                    while ( (((iNum | iDen) & 1) == 0) && ( iNum != 0) && ( iDen != 0)) {

                        /* both even and non-zero */

                        iNum = iNum >> 1;

                        iDen = iDen >> 1;

                    }

                    if (iNum >= _MAX_INT) {

                        __FractionInstPtr(newFraction)->f_numerator = __MKINT(iNum);

                    } else {

                        __FractionInstPtr(newFraction)->f_numerator = __MKSMALLINT(iNum);

                    }

                    if (iDen >= _MAX_INT) {

                        __FractionInstPtr(newFraction)->f_denominator = __MKINT(iDen);

                    } else {

                        __FractionInstPtr(newFraction)->f_denominator = __MKSMALLINT(iDen);

                    }

                    if (iNum == 1) {

                        if (iDen == 1) {

                            RETURN (__mkSmallInteger(1));

                        }

                        /* no need to reduce */

                        RETURN ( newFraction );

                    }

                }

            }

        }

    }

#endif /* not __SCHTEAM__ */

%}.

    den = 0 ifTrue:[

        ^ ZeroDivide raiseRequestWith:thisContext.

    ].

    newFraction isNil ifTrue:[

        newFraction := self basicNew setNumerator:num denominator:den.

    ].

    ^ newFraction reduced

    "

     Fraction numerator:1 denominator:3    -> (1/3)

     Fraction numerator:-1 denominator:3   -> (-1/3)

     Fraction numerator:1 denominator:-3   -> (-1/3)

     Fraction numerator:-1 denominator:-3  -> (1/3)

     Fraction numerator:2 denominator:3

     Fraction numerator:2 denominator:6

     Fraction numerator:1 denominator:0  -> error

     Fraction numerator:2 denominator:0  -> error

     Fraction numerator:5 denominator:10

     Fraction numerator:50 denominator:100

     Fraction numerator:8 denominator:16

    "

    "Modified: / 27-02-2016 / 00:25:47 / cg"

!

readDecimalFractionFrom:aStringOrStream onError:exceptionBlock

    "Read an arbitrary number (>0) of digits representing a decimal fraction."

    |numDigits factor fraction s ch denom|

    s := aStringOrStream isStream ifTrue:[aStringOrStream] ifFalse:[aStringOrStream readStream].

    factor := (1 / 10).

    fraction := 0.

    numDigits := 0.

    [

        ch := s peekOrNil.

        ch notNil and:[ch isDigit].

    ] whileTrue: [

        s next.

        fraction := fraction*10 + (ch digitValue).

        numDigits := numDigits + 1.

    ].

    numDigits > 0 ifFalse:[^ exceptionBlock valueWithOptionalArgument: 'Missing digits in fraction'].

    numDigits <= 10 ifTrue:[

        denom := #(10 100 1000 10000 100000

                   1000000 10000000 100000000 1000000000 10000000000) at:numDigits.

    ] ifFalse:[

        denom := 10 raisedTo:numDigits.

    ].

    ^ fraction / denom

    "

     Fraction readDecimalFractionFrom:'1'   onError:[nil]     -> 0.1

     Fraction readDecimalFractionFrom:'123' onError:[nil]     -> 0.123

     Fraction readDecimalFractionFrom:'5'   onError:[nil]     -> 0.5

     Fraction readDecimalFractionFrom:'005' onError:[nil]     -> 0.005

     Fraction readDecimalFractionFrom:''    onError:[nil]     -> nil

     Fraction readDecimalFractionFrom:'aa'  onError:[nil]     -> nil

    "

!

readFrom:aStringOrStream onError:exceptionBlock

    |s numerator denominator hasParen result|

    "/ sigh - care for subclasses...

    self == Fraction ifFalse:[

        ^ super readFrom:aStringOrStream onError:exceptionBlock

    ].

    s := aStringOrStream readStream.

    s skipSeparators.

    hasParen := s peekFor:$(.

    numerator := super readFrom:s onError:[^ exceptionBlock value].

    numerator isInteger ifTrue:[

        s skipSeparators.

        (s peekFor:$/) ifTrue:[

            denominator := Integer readFrom:s onError:[^ exceptionBlock value].

            result := self numerator:numerator denominator:denominator

        ] ifFalse:[

            result := numerator.

        ].

    ].

    hasParen ifTrue:[

        s skipSeparators.

        (s peekFor:$)) ifFalse:exceptionBlock.

    ].

    result notNil ifTrue:[

        ^ result.

    ].

    ^ numerator asFraction.

    "

     Fraction readFromString:'1'

     Fraction readFromString:'2'

     Fraction readFromString:'1.5'

     Fraction readFromString:'1/5'

     Fraction readFromString:'(1/5)'

     Fraction readFromString:'(1/5'

    "

    "Modified: / 14-03-2018 / 19:02:44 / stefan"

! !

!Fraction class methodsFor:'class initialization'!

initialize

    FractionZero isNil ifTrue:[

	FractionZero := self numerator:0 denominator:1.

	FractionOne := self numerator:1 denominator:1

    ]

! !

!Fraction class methodsFor:'coercing & converting'!

coerce:aNumber

    "convert the argument aNumber into an instance of the receiver (class) and return it."

    ^ aNumber asFraction

! !

!Fraction class methodsFor:'constants'!

e

    "return an approximation of the constant e as Fraction.

     The approx. returned here has an error smaller than representable by float instances

     (roughly 26 valid digits)"

    E isNil ifTrue:[

        E := self

                numerator:  271828182845904523536028747 

                denominator:100000000000000000000000000

    ].

    ^ E

    "E := nil

     Fraction e

     Fraction e asFloat - Float e

     Fraction e asLongFloat - LongFloat e

     Float e

     FixedPoint e

    "

    "Created: / 03-07-2017 / 17:22:47 / cg"

    "Modified (comment): / 06-06-2019 / 17:10:56 / Claus Gittinger"

!

e_approximation

    "return an approximation of e as Fraction.

     The approx. returned is good for 6 valid digits and has an error of less than -2.67-07.

     The value might be useful to avoid floating point numbers in graphic rendering code,

     where 6 digits of precision are usually good enough."

    ^ self

        numerator:67957

        denominator:25000

    "

     Fraction e

     Fraction e asFloat               

     Fraction e_approximation asFloat 

     (Fraction e - Fraction e_approximation asFloat) abs

     (Float e - Fraction e_approximation asFloat) abs

     19/7 can be used as an approx with ~1% error:

         Float e - (19/7) asFloat

     87/32 is another candidate:

         Float e - (87/32) asFloat 

     and 106/39:

         Float e - (106/39) asFloat 

    "

    "Created: / 03-07-2017 / 17:21:38 / cg"

!

phi

    "return an approximation of the constant phi as Fraction.

     The approx. returned here has an error smaller than representable by float instances

     (roughly 26 valid digits)"

    Phi isNil ifTrue:[

        Phi := self

            numerator:  161803398874989484820458683

            denominator:100000000000000000000000000

    ].

    ^ Phi

    "

     Fraction phi

     Fraction phi asFloat - Float phi

     Fraction phi asLongFloat - LongFloat phi

     Float phi

    "

    "Modified (comment): / 03-07-2017 / 13:21:03 / cg"

!

pi

    "return an approximation of the constant pi as Fraction.

     The approx. returned here has an error smaller than representable by float instances

     (roughly 26 valid digits)"

    Pi isNil ifTrue:[

        Pi := self

            numerator:  314159265358979323846264343

            denominator:100000000000000000000000000

    ].

    ^ Pi

    "

     ^ self

        numerator:  314159265358979323846264338327950288419716939937510582097494459

        denominator:100000000000000000000000000000000000000000000000000000000000000

    "

    "

     Fraction pi

     Fraction pi asFloat - Float pi

     Fraction pi asLongFloat - LongFloat pi

     Float pi

    "

    "Modified (comment): / 03-07-2017 / 13:21:03 / cg"

!

pi1000

    "return an approximation of the constant pi as Fraction (>= 1000 valid decimal digits)."

    Pi_1000 isNil ifTrue:[

        Pi_1000 := self

                        numerator:  31415926535897932384626433832795028841971693993751058209749445923078164062862089986280348253421170679821480865132823066470938446095505822317253594081284811174502841027019385211055596446229489549303819644288109756659334461284756482337867831652712019091456485669234603486104543266482133936072602491412737245870066063155881748815209209628292540917153643678925903600113305305488204665213841469519415116094330572703657595919530921861173819326117931051185480744623799627495673518857527248912279381830119491298336733624406566430860213949463952247371907021798609437027705392171762931767523846748184676694051320005681271452635608277857713427577896091736371787214684409012249534301465495853710507922796892589235420199561121290219608640344181598136297747713099605187072113499999983729780499510597317328160963185950244594553469083026425223082533446850352619311881710100031378387528865875332083814206171776691473035982534904287554687311595628638823537875937519577818577805321712268066130019278766111959092164201989380952572010654858632788

                        denominator:10000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000.

    ].

    ^ Pi_1000

    "

     Pi_1000 := nil.

     Fraction pi1000

     Fraction pi1000 asLongFloat - LongFloat pi

     LongFloat pi

    "

    "Modified (comment): / 03-07-2017 / 13:21:15 / cg"

!

pi_approximation

    "return an approximation of the constant pi as Fraction.

     The approx. returned is good for 6 valid digits and has an error of less than -2.67-07.

     The value might be useful to avoid floating point numbers in graphic rendering code,

     where 6 digits of precision are usually good enough."

    ^ self

        numerator:355

        denominator:113

    "

     Fraction pi

     Fraction pi asFloat

     (Fraction pi - Fraction pi_approximation asFloat) abs

     (Float pi - Fraction pi_approximation asFloat) abs

     22/7 can be used as an approx with 1% error:

         Float pi - (22/7) asFloat

    "

    "Modified (comment): / 03-07-2017 / 17:31:44 / cg"

!

unity

    "return the neutral element for multiplication (1 / 1)"

    ^ FractionOne

    "Modified: 18.7.1996 / 12:26:06 / cg"

!

zero

    "return the neutral element for addition (0 / 1)"

    ^ FractionZero

    "Modified: 18.7.1996 / 12:26:12 / cg"

! !

!Fraction class methodsFor:'queries'!

isBuiltInClass

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

     Here, true is returned for myself, false for subclasses."

    ^ self == Fraction

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

! !

!Fraction methodsFor:'accessing'!

denominator

    "return the denominator"

    ^ denominator

!

numerator

    "return the numerator"

    ^ numerator

! !

!Fraction methodsFor:'arithmetic'!

* aNumber

    "return the product of the receiver and the argument."

    "/ notice:

    "/ the following code handles some common cases,

    "/ and exists as an optimization, to speed up those cases.

    "/ also notice, that checks for those cases must be inlinable without

    "/ a message send; otherwise double-dispatch is just as fast.

    "/

    "/ Conceptionally, (and for most other argument types),

    "/ mixed arithmetic is implemented by double dispatching

    "/ (see the message send at the bottom)

    (aNumber isMemberOf:SmallInteger) ifTrue:[

        ^ self class

                numerator:(numerator * aNumber)

                denominator:denominator

    ].

    aNumber isFloat ifTrue:[

        ^ (numerator * aNumber) / denominator

    ].