"

 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.

"

LimitedPrecisionReal variableByteSubclass:#Float

       instanceVariableNames:''

       classVariableNames:'LastErrorNumber'

       poolDictionaries:''

       category:'Magnitude-Numbers'

!

Float comment:'

COPYRIGHT (c) 1988 by Claus Gittinger

              All Rights Reserved

'!

!Float 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.

"

!

version

"

"

!

documentation

"

    Floats represent rational numbers with limited precision. In ST/X, Float uses

    the underlying C-compilers double implementation, therefore instances of Float

    are usually represented by the 8-byte IEE double precision float format.

    (but there is no guaranty).

    Notice, that Floats are defined as Byte-array to prevent the garbage collector

    from going into the value ... otherwise I needed a special case in many places.

    Also notice, that ST/X Floats are what Doubles are in ST-80 - this may change 

    in one of the next versions (at least on machines, which provide different float

    and double types in their C-compiler.

    WARNING:

    The layout of float instances is known by the runtime system and the compiler;

    you may not add instance variables here. 

    Also, subclassing is complicated by the fact, that the VM creates floats, and does 

    its float-checks by an identity compare with the Float-class. (i.e. your subclasses 

    instances will not be recognized as float-like objects, thus mixed mode arithmetic 

    will always coerce them, effectively slowing things down.

    This may be changed, to use a flag bit in the class.

    Class Variables:

        LastErrorNumber <Integer>       value of errno (after a trig- or other math err)

"

! !

!Float class methodsFor:'instance creation'!

basicNew

    "return a new float - here we return 0.0

     - floats are usually NOT created this way ...

     Its implemented here to allow things like binary store & load

     of floats. (but even this support will go away eventually, its not

     a good idea to store the bits of a float - the reader might have a

     totally different representation - so floats will eventually be 

     binary stored in a device independent format."

%{  /* NOCONTEXT */

    RETURN ( _MKFLOAT((0.0) COMMA_SND) );

%}

! !

!Float class methodsFor:'constants'!

zero

    "return the neutral element for addition"

    ^ 0.0

!

unity

    "return the neutral element for multiplication"

    ^ 1.0

!

pi

    "return the constant pi"

    ^ 3.1415926535897932384626434

! !

!Float class methodsFor:'queries'!

isBuiltInClass

    "this class is known by the run-time-system"

    ^ self == Float

!

lastErrorNumber

    "return the value of errno after an error"

    ^ LastErrorNumber

    "

     2 arcSin.

     OperatingSystem errorTextForNumber:(Float lastErrorNumber)

    "

! !

!Float methodsFor:'arithmetic'!

+ aNumber

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

%{  /* NOCONTEXT */

    OBJ newFloat;

    double result;

    if (_isSmallInteger(aNumber)) {

        result = _floatVal(self) + (double)(_intVal(aNumber));

retResult:

        _qMKFLOAT(newFloat, result, SENDER);

        RETURN ( newFloat );

    }

    if ((aNumber != nil) && (_qClass(aNumber) == Float)) {

        result = _floatVal(self) + _floatVal(aNumber);

        goto retResult;

    }

%}

.

    ^ aNumber sumFromFloat:self

!

- aNumber

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

%{  /* NOCONTEXT */

    OBJ newFloat;

    double result;

    if (_isSmallInteger(aNumber)) {

        result = _floatVal(self) - (double)(_intVal(aNumber));

retResult:

        _qMKFLOAT(newFloat, result, SENDER);

        RETURN ( newFloat );

    }

    if ((aNumber != nil) && (_qClass(aNumber) == Float)) {

        result = _floatVal(self) - _floatVal(aNumber);

        goto retResult;

    }

%}

.

    ^ aNumber differenceFromFloat:self

!

* aNumber

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

%{  /* NOCONTEXT */

    OBJ newFloat;

    double result;

    if (_isSmallInteger(aNumber)) {

        result = _floatVal(self) * (double)(_intVal(aNumber));

retResult:

        _qMKFLOAT(newFloat, result, SENDER);

        RETURN ( newFloat );

    }

    if ((aNumber != nil) && (_qClass(aNumber) == Float)) {

        result = _floatVal(self) * _floatVal(aNumber);

        goto retResult;

    }

%}

.

    ^ aNumber productFromFloat:self

!

/ aNumber

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

%{  /* NOCONTEXT */

    OBJ newFloat;

    double result, val;

    if (_isSmallInteger(aNumber)) {

        if (aNumber != _MKSMALLINT(0)) {

            result = _floatVal(self) / ( (double)_intVal(aNumber)) ;

retResult:

            _qMKFLOAT(newFloat, result, SENDER);

            RETURN ( newFloat );

        }

    } else {

        if ((aNumber != nil) && (_qClass(aNumber) == Float)) {

            val = _floatVal(aNumber);

            if (val != 0.0) {

                result = _floatVal(self) / val;

                goto retResult;

            }

        }

    }

%}

.

    ((aNumber == 0) or:[aNumber = 0.0]) ifTrue:[

        ^ DivisionByZeroSignal raise.

    ].

    ^ aNumber quotientFromFloat:self

!

negated

    "return myself negated"

%{  /* NOCONTEXT */

    OBJ newFloat;

    _qMKFLOAT(newFloat, - _floatVal(self), SENDER);

    RETURN ( newFloat );

%}

! !

!Float methodsFor:'testing'!

positive

    "return true if the receiver is greater or equal to zero"

%{  /* NOCONTEXT */

    RETURN ( (_floatVal(self) >= 0.0) ? true : false );

%}

!

negative

    "return true if the receiver is less than zero"

%{  /* NOCONTEXT */

    RETURN ( (_floatVal(self) < 0.0) ? true : false );

%}

! !

!Float methodsFor:'comparing'!

< aNumber

    "return true, if the argument is greater"

%{  /* NOCONTEXT */

    if (_isSmallInteger(aNumber)) {

        RETURN ( (_floatVal(self) < (double)(_intVal(aNumber))) ? true : false );

    }

    if ((aNumber != nil) && (_qClass(aNumber) == Float)) {

        RETURN ( (_floatVal(self) < _floatVal(aNumber)) ? true : false );

    }

%}

.

    ^ aNumber lessFromFloat:self

!

> aNumber

    "return true, if the argument is less"

%{  /* NOCONTEXT */

    if (_isSmallInteger(aNumber)) {

        RETURN ( (_floatVal(self) > (double)(_intVal(aNumber))) ? true : false );

    }

    if ((aNumber != nil) && (_qClass(aNumber) == Float)) {

        RETURN ( (_floatVal(self) > _floatVal(aNumber)) ? true : false );

    }

%}

.

    ^ self retry:#> coercing:aNumber

!

<= aNumber

    "return true, if the argument is greater or equal"

%{  /* NOCONTEXT */

    if (_isSmallInteger(aNumber)) {

        RETURN ( (_floatVal(self) <= (double)(_intVal(aNumber))) ? true : false );

    }

    if ((aNumber != nil) && (_qClass(aNumber) == Float)) {

        RETURN ( (_floatVal(self) <= _floatVal(aNumber)) ? true : false );

    }

%}

.

    ^ self retry:#<= coercing:aNumber

!

>= aNumber

    "return true, if the argument is less or equal"

%{  /* NOCONTEXT */

    if (_isSmallInteger(aNumber)) {

        RETURN ( (_floatVal(self) >= (double)(_intVal(aNumber))) ? true : false );

    }

    if ((aNumber != nil) && (_qClass(aNumber) == Float)) {

        RETURN ( (_floatVal(self) >= _floatVal(aNumber)) ? true : false );

    }

%}

.

    ^ self retry:#>= coercing:aNumber

!

= aNumber

    "return true, if the arguments value are equal"

%{  /* NOCONTEXT */

    if (_isSmallInteger(aNumber)) {

        RETURN ( (_floatVal(self) == (double)(_intVal(aNumber))) ? true : false );

    }

    if ((aNumber != nil) && (_qClass(aNumber) == Float)) {

        RETURN ( (_floatVal(self) == _floatVal(aNumber)) ? true : false );

    }

%}

.

    ^ self retry:#= coercing:aNumber

!

~= aNumber

    "return true, if the arguments value are not equal"

%{  /* NOCONTEXT */

    if (_isSmallInteger(aNumber)) {

        RETURN ( (_floatVal(self) != (double)(_intVal(aNumber))) ? true : false );

    }

    if ((aNumber != nil) && (_qClass(aNumber) == Float)) {

        RETURN ( (_floatVal(self) != _floatVal(aNumber)) ? true : false );

    }

%}

.

    ^ self retry:#~= coercing:aNumber

!

hash

    "return a number for hashing; redefined, since floats compare

     by numeric value (i.e. 3.0 = 3), therefore 3.0 hash must be the same

     as 3 hash."

    |i idx|

    (self >= SmallInteger minVal and:[self <= SmallInteger maxVal]) ifTrue:[

        i := self asInteger.

        self = i ifTrue:[

            ^ i hash

        ].

    ].

    "

     mhmh take my value-bits to hash on

    "

    idx := self basicSize.

    ^ (((self basicAt:idx) bitAnd:16r3F) bitShift:24) +

      ((self basicAt:idx-1) bitShift:16) +

      ((self basicAt:idx-2) bitShift:8) +

      (self basicAt:idx-3)

    "

     3 hash       

     3.0 hash

     3.1 hash  

     3.14159 hash  

     31.4159 hash 

     3.141591 hash 

     1.234567890123456 hash  

     1.234567890123457 hash   

     Set withAll:#(3 3.0 99 99.0 3.1415)

    "

! !

!Float methodsFor:'coercion and converting'!

coerce:aNumber

    "return aNumber converted into receivers type"

    ^ aNumber asFloat

!

generality

    "return the generality value - see ArithmeticValue>>retry:coercing:"

    ^ 80

!

asFloat

    "return a float with same value - thats me"

    ^ self

!

asInteger

    "return an integer with same value - might truncate"

    |l v sign|

%{  /* NOCONTEXT */

    if ((_floatVal(self) >= (double)_MIN_INT)

     && (_floatVal(self) <= (double)_MAX_INT)) {

        RETURN ( _MKSMALLINT( (INT)_floatVal(self)) );

    }

%}

.

    ^ super asInteger

    "12345.0 asInteger"

    "1e15 asInteger"

! !

!Float methodsFor:'truncation and rounding'!

truncated

    "return the receiver truncated towards zero as an integer"

    |val|

%{

    double floor(), ceil();

    double dVal;

    dVal = _floatVal(self);

    if (dVal < 0.0) {

        dVal = ceil(dVal);

    } else {

        dVal = floor(dVal);

    }

    /*

     * ST-80 (and X3J20) returns integer.

     */

    if ((dVal >= (double)_MIN_INT) && (dVal <= (double)_MAX_INT)) {

        RETURN ( _MKSMALLINT( (INT) dVal ) );

    }

    val = _MKFLOAT(dVal COMMA_CON);

%}.

    ^ val asInteger

!

rounded

    "return the receiver rounded to the nearest integer as an integer"

    |val|

%{

    double floor();

    double dVal;

    /*

     * ST-80 (and X3J20) returns integer.

     */

    dVal = floor(_floatVal(self) + 0.5);

    if ((dVal >= (double)_MIN_INT) && (dVal <= (double)_MAX_INT)) {

        RETURN ( _MKSMALLINT( (INT) dVal ) );

    }

    val = _MKFLOAT(dVal COMMA_CON);

%}.

    ^ val asInteger

!

floor

    "return the integer nearest the receiver towards negative infinity."

    |val|

%{

    double floor();

    double dVal;

    /*

     * ST-80 (and X3J20) returns integer.

     */

    dVal = floor(_floatVal(self));

    if ((dVal >= (double)_MIN_INT) && (dVal <= (double)_MAX_INT)) {

        RETURN ( _MKSMALLINT( (INT) dVal ) );

    }

    val = _MKFLOAT(dVal COMMA_CON);

%}.

    ^ val asInteger