"

 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'

	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       Booolean        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 (__CanDoQuickAlignedNew(sizeof(struct __Fraction))) {    /* OBJECT ALLOCATION */

		    OBJ newFraction;

		    int spc;

		    INT iDen;

		    __qCheckedAlignedNew(newFraction, sizeof(struct __Fraction));

		    __InstPtr(newFraction)->o_class = self;

		    __qSTORE(newFraction, self);

		    iDen = __intVal(den);

		    if (iDen != 0) {

			if (iDen < 0) {

			    __FractionInstPtr(newFraction)->f_numerator = __mkSmallInteger(- __intVal(num));

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

			} else {

			    __FractionInstPtr(newFraction)->f_numerator = num;

			    __FractionInstPtr(newFraction)->f_denominator = den;

			}

			if (num == __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

     Fraction numerator:2 denominator:6

     Fraction numerator:1 denominator:0

     Fraction numerator:2 denominator:0

    "

!

readDecimalFractionFrom:aStringOrStream onError:exceptionBlock

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

    |anyDigit factor fraction s ch|

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

    factor := (1 / 10).

    fraction := 0.

    anyDigit := false.

    [

	ch := s peekOrNil.

	ch notNil and:[ch isDigit].

    ] whileTrue: [

	s next.

	anyDigit := true.

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

	factor := (factor / 10).

    ].

    anyDigit ifFalse: [^ exceptionBlock valueWithOptionalArgument: 'Missing digits in fraction'].

    ^ fraction

    "

     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|

    "/ sigh - care for subclasses...

    self == Fraction ifFalse:[

        ^ super readFrom:aStringOrStream onError:exceptionBlock

    ].

    s := aStringOrStream readStream.

    s skipSeparators.

        s next.

    ].

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

    numerator isInteger ifTrue:[

        s skipSeparators.

            s next.

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

            ^ self numerator:numerator denominator:denominator

        ].

        ^ numerator

    ].

    ^ numerator asFraction

    "

     Fraction readFrom:'1'

     Fraction readFrom:'2'

     Fraction readFrom:'1.5'

     Fraction readFrom:'1/5'

    "

! !

!Fraction class methodsFor:'class initialization'!

initialize

    FractionZero isNil ifTrue:[

	FractionZero := self numerator:0 denominator:1.

	FractionOne := self numerator:1 denominator:1

    ]

! !

!Fraction class methodsFor:'constants'!

pi

    "return an approximation of the constant pi as Fraction.

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

    ^ self

	numerator:314159265358979323846264343

	denominator:100000000000000000000000000

"/    ^ self

"/        numerator:  314159265358979323846264338327950288419716939937510582097494459

"/        denominator:100000000000000000000000000000000000000000000000000000000000000

    "

     Fraction pi

     Fraction pi asFloat - Float pi

     Float pi

    "

    "Modified: / 03-05-2011 / 11:08:46 / 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

     Float pi - Fraction pi_approximation asFloat

    "

!

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 isMemberOf:Float) ifTrue:[

	^ (numerator * aNumber) / denominator

    ].

    ^ aNumber productFromFraction:self

    "Modified: 28.7.1997 / 19:09:23 / cg"

!

+ aNumber

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

    "/ 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 + (denominator * aNumber))

	    denominator:denominator

    ].

    (aNumber isMemberOf:Float) ifTrue:[

	^ (numerator asFloat / denominator asFloat) + aNumber

    ].

    ^ aNumber sumFromFraction:self

    "Modified: 28.7.1997 / 19:09:16 / cg"

!

- aNumber

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

    "/ 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 - (denominator * aNumber))

		denominator:denominator

    ].

    (aNumber isMemberOf:Float) ifTrue:[

	^ (numerator asFloat / denominator asFloat) - aNumber

    ].

    ^ aNumber differenceFromFraction:self

    "

     (1/3) - (1/9)

     (1/9) - (1/3)

     (999/1000) - (1/1000)

     (999/1000) - (1/1000000)

     (999000/1000000) - (1/1000000)

    "

    "Modified: 28.7.1997 / 19:09:11 / cg"

!

/ aNumber

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

    "/ 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

		denominator:(denominator * aNumber)

    ].

    (aNumber isMemberOf:Float) ifTrue:[

	^ numerator / (denominator * aNumber)

    ].

    ^ aNumber quotientFromFraction:self

    "Modified: 28.7.1997 / 19:09:06 / cg"

!

// aNumber

    "return the integer quotient of dividing the receiver by aNumber with

     truncation towards negative infinity."

    ^ (numerator * aNumber denominator) // (denominator * aNumber numerator)

    "

     0.5 // 1

     -0.5 // 1

     (1/2) // 1  = 0 ifFalse:[self halt].

     (-1/2) // 1 = -1 ifFalse:[self halt].

    "

    "Modified: / 5.11.1996 / 11:47:14 / cg"

    "Modified: / 13.2.1998 / 09:15:35 / stefan"

!

negated

    "optional - could use inherited method ..."

    "/ no need to reduce - I am already

    ^ self class basicNew

        setNumerator:(numerator negated)

        denominator:denominator

    "Modified: 5.11.1996 / 10:29:11 / cg"

!

reciprocal

    "optional - could use inherited method ..."

    numerator == 1 ifTrue:[^ denominator].

    "/ no need to reduce - I am already

    ^ self class basicNew

        setNumerator:denominator

        denominator:numerator

    "Modified: 5.11.1996 / 10:29:22 / cg"

! !

!Fraction methodsFor:'coercing & converting'!

asFixedPoint

    "return the receiver as fixedPoint number.

     Q: what should the scale be here ?"

    ^ FixedPoint numerator:numerator denominator:denominator scale:2

    "

     (1/2) asFixedPoint

    "

    "Created: 5.11.1996 / 15:15:54 / cg"

!

asFixedPoint:scale

    "return the receiver as fixedPoint number, with the given number

     of post-decimal-point digits."

    ^ FixedPoint numerator:numerator denominator:denominator scale:scale

    "

     (1/2) asFixedPoint:2

     (1/3) asFixedPoint:2

     (1/3) asFixedPoint:5

     (2/3) asFixedPoint:2

     (2/3) asFixedPoint:5

    "