"{ Encoding: utf8 }"

"

 COPYRIGHT (c) 2018 by eXept Software AG

              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:libbasic2' }"

"{ NameSpace: Smalltalk }"

LimitedPrecisionReal variableByteSubclass:#OctaFloat

	instanceVariableNames:''

	classVariableNames:'OctaFloatZero OctaFloatOne Pi E Epsilon NaN PositiveInfinity

		NegativeInfinity Halfpi HalfpiNegative Phi'

	poolDictionaries:''

	category:'Magnitude-Numbers'

!

!OctaFloat primitiveDefinitions!

%{

#ifdef __xxosx__

# define SUPPORT_OCTAFLOAT

#endif 

#include <math.h>

extern float256_t STX_addQ(float256_t, float256_t, int);

extern float256_t STX_mulQ(float256_t, float256_t);

extern float256_t STX_divQ(float256_t, float256_t);

extern float256_t STX_negQ(float256_t);

extern float256_t STX_absQ(float256_t);

extern float256_t STX_floorQ(float256_t);

extern float256_t STX_frexpQ(float256_t, int*);

extern float256_t STX_ceilQ(float256_t);

extern float256_t STX_logQ(float256_t);

extern float256_t STX_log10Q(float256_t);

extern float256_t STX_log2Q(float256_t);

extern float256_t STX_expQ(float256_t);

extern float256_t STX_sinQ(float256_t);

extern float256_t STX_cosQ(float256_t);

extern float256_t STX_tanQ(float256_t);

extern float256_t STX_sinhQ(float256_t);

extern float256_t STX_coshQ(float256_t);

extern float256_t STX_tanhQ(float256_t);

extern float256_t STX_asinQ(float256_t);

extern float256_t STX_acosQ(float256_t);

extern float256_t STX_atanQ(float256_t);

extern float256_t STX_asinhQ(float256_t);

extern float256_t STX_acoshQ(float256_t);

extern float256_t STX_atanhQ(float256_t);

extern float256_t STX_QZero;

extern float256_t STX_dbltoQ(double);

extern float256_t STX_inttoQ(long);

extern double STX_Qtodbl(float256_t);

extern int STX_isNanQ(float256_t*);

extern int STX_prcmpQ(float256_t*, float256_t*);

#define STX_isfiniteQ(q)    (!STX_isNanQ(&(q)) && !STX_isInfQ(&(q)))

#define STX_eqQ(x1, x2)     (STX_prcmpQ (&(x1), &(x2)) == 0)

#define STX_neqQ(x1, x2)    (STX_prcmpQ (&(x1), &(x2)) != 0)

#define STX_gtQ(x1, x2)     (STX_prcmpQ (&(x1), &(x2)) > 0)

#define STX_geQ(x1, x2)     (STX_prcmpQ (&(x1), &(x2)) >= 0)

#define STX_ltQ(x1, x2)     (STX_prcmpQ (&(x1), &(x2)) < 0)

#define STX_leQ(x1, x2)     (STX_prcmpQ (&(x1), &(x2)) <= 0)

#ifdef __win32__

/*

 * no finite(x) ?

 * no isnan(x) ?

 */

# ifndef isnan

#  define isnan(x)      \

	((((unsigned int *)(&x))[0] == 0x00000000) && \

	 (((unsigned int *)(&x))[1] == 0xFFF80000))

# endif

# ifndef isPositiveInfinity

#  define isPositiveInfinity(x) \

	((((unsigned int *)(&x))[0] == 0x00000000) && \

	 (((unsigned int *)(&x))[1] == 0x7FF00000))

# endif

# ifndef isNegativeInfinity

#  define isNegativeInfinity(x) \

	((((unsigned int *)(&x))[0] == 0x00000000) && \

	 (((unsigned int *)(&x))[1] == 0xFFF00000))

# endif

# ifndef isinf

#  define isinf(x) \

	((((unsigned int *)(&x))[0] == 0x00000000) && \

	 ((((unsigned int *)(&x))[1] & 0x7FF00000) == 0x7FF00000))

# endif

# ifndef isfinite

#  define isfinite(x) (!isinf(x) && !isnan(x))

# endif

#else // not win32

#endif

%}

! !

!OctaFloat primitiveVariables!

%{

%}

! !

!OctaFloat primitiveFunctions!

%{

%}

! !

!OctaFloat class methodsFor:'documentation'!

copyright

"

 COPYRIGHT (c) 2018 by eXept Software AG

              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

"

    OctaFloats represent rational numbers with limited precision

    and are mapped to IEEE octuple precision format (256bit),

    also called binary256.

    Notice, that a software emulation is done, which is much slower.

    Thus only use them, if you really need the additional precision;

    if not, use Float (which are doubles) or LongFloats which usually have IEEE extended precision (80bit).

    OctaFloats give you definite 256 bit quadruple floats,

    thus, code using octaFloats is guaranteed to be portable from one architecture to another.

    Representation:

	    256bit octuple IEEE floats (32bytes);

	    237 bit mantissa,

	    19 bit exponent,

	    71 decimal digits (approx.)

    Mixed mode arithmetic:

	octaFloat op anyFloat    -> octaFloat

	anyFloat op octaFloat    -> octaFloat

    Range and precision of storage formats: see LimitedPrecisionReal >> documentation

    [author:]

	Claus Gittinger

    [see also:]

	Number

	Float ShortFloat LongFloat Fraction FixedPoint Integer Complex

	FloatArray DoubleArray

	https://en.wikipedia.org/wiki/Extended_precision

	https://en.wikipedia.org/wiki/Octuple-precision_floating-point_format

"

! !

!OctaFloat class methodsFor:'instance creation'!

basicNew

    "return a new octaFloat - here we return 0.0

     - OctaFloats are usually NOT created this way ...

     Its implemented here to allow things like binary store & load

     of quadFloats.

     (but it is not a good idea to store the bits of a float - the reader might have a

      totally different representation - so floats should be

      binary stored in a device independent format)."

%{  /* NOCONTEXT */

#ifdef SUPPORT_OCTAFLOAT

    OBJ newFloat;

    float256_t qf = STX_QZero;

    __qMKFLOAT256(newFloat, qf);   /* OBJECT ALLOCATION */

    RETURN (newFloat);

#endif /* SUPPORT_QUADFLOAT */

%}.

    self error:'OctaFloats not supported on this patform'

    "Created: / 06-06-2019 / 17:18:58 / Claus Gittinger"

!

fromFloat:aFloat

    "return a new quadFloat, given a float value"

%{  /* NOCONTEXT */

#ifdef SUPPORT_OCTAFLOAT

    OBJ newFloat;

    if (__isFloatLike(aFloat)) {

        double f = __floatVal(aFloat);

        float256_t qf;

        qf = STX_dbltoQ (f);

        __qMKFLOAT256(newFloat, qf);   /* OBJECT ALLOCATION */

        RETURN (newFloat);

    }

#endif /* SUPPORT_OCTAFLOAT */

%}.

    aFloat isFloat ifTrue:[

        self errorUnsupported.

        ^ aFloat asLongFloat

    ].

    ArgumentError raise

    "

     OctaFloat fromFloat:123.0

     123.0 asOctaFloat

     123 asOctaFloat

    "

    "Created: / 06-06-2019 / 18:01:03 / Claus Gittinger"

!

fromInteger:anInteger

    "return a new quadFloat, given an integer value"

%{  /* NOCONTEXT */

#ifdef SUPPORT_OCTAFLOAT

    OBJ newFloat;

    if (__isSmallInteger(anInteger)) {

	INT iVal = __intVal(anInteger);

	float256_t qf;

	qf = STX_inttoQ( (long)iVal );

	__qMKFLOAT256(newFloat, qf);   /* OBJECT ALLOCATION */

	RETURN (newFloat);

    }

#endif /* SUPPORT_OCTAFLOAT */

%}.

    ^ super fromInteger:anInteger

    "

     OctaFloat fromInteger:123

     123 asOctaFloat

    "

!

fromLongFloat:aFloat

    "return a new quadFloat, given a long float value"

%{  /* NOCONTEXT */

#ifdef xSUPPORT_OCTAFLOAT

    OBJ newFloat;

    union {

        LONGFLOAT_t lf;         // is long double

        extFloat80_t ef;        // is 80bit ext

        float256_t qf;          // is 128bit quad

    } u;

    if (__isLongFloat(aFloat)) {

        u.lf = __longFloatVal(aFloat);

        if (sizeof(LONGFLOAT_t) == 16) {

            // longFloat is already 128 bits in size (sparc)

            __qMKFLOAT256(newFloat, u.qf);   /* OBJECT ALLOCATION */

            RETURN (newFloat);

        }

        if (sizeof(LONGFLOAT_t) < 16) {

            // assume 80bit extended float format (amd64, x86_64)

            u.qf = extF80_to_f128( u.ef);

            __qMKFLOAT256(newFloat, u.qf);   /* OBJECT ALLOCATION */

            RETURN (newFloat);

        }

        // fall into error case

    }

#endif /* SUPPORT_OCTAFLOAT */

%}.

    aFloat isLongFloat ifTrue:[

        self errorUnsupported.

        ^ aFloat

    ].

    ArgumentError raise

    "

     OctaFloat fromLongFloat:123.0 asLongFloat

    "

!

fromShortFloat:aShortFloat

    "return a new quadFloat, given a float value"

    ^ self fromFloat:(aShortFloat asFloat)

    "

     OctaFloat fromShortFloat:123.0 asShortFloat

    "

    "Created: / 08-06-2019 / 03:28:37 / Claus Gittinger"

! !

!OctaFloat class methodsFor:'coercing & converting'!

coerce:aNumber

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

    ^ aNumber asOctaFloat.

    "Created: / 06-06-2019 / 16:51:01 / Claus Gittinger"

! !

!OctaFloat class methodsFor:'constants'!

NaN

    "return a quadFloat which represents not-a-Number (i.e. an invalid number)"

    |nan|

    NaN isNil ifTrue:[

%{  /* NOCONTEXT */

#ifdef xSUPPORT_OCTAFLOAT

	{

	    OBJ newFloat;

	    float256_t qf;

	    softfloat_commonNaNToF128M( (uint32_t*)(&qf) );

	    __qMKFLOAT256(newFloat, qf);   /* OBJECT ALLOCATION */

	    nan = newFloat;

	}

#endif /* SUPPORT_OCTAFLOAT */

%}.

        nan isNil ifTrue:[

	    self errorUnsupported

        ].

	NaN := nan

    ].

    ^ NaN

!

e

    "return the constant e as quadFloat"

    E isNil ifTrue:[

	"/ eDigits has enough digits for 128bit IEEE quads

	"/ do not use as a literal constant here - we cannot depend on the underlying C-compiler here...

	E  := self readFrom:(Number eDigits)

    ].

    ^ E

    "Created: / 06-06-2019 / 17:01:54 / Claus Gittinger"

!

infinity

    "return a quadFloat which represents +INF"

    |inf|

    PositiveInfinity isNil ifTrue:[

%{  /* NOCONTEXT */

#ifdef xSUPPORT_OCTAFLOAT

	{

	    OBJ newFloat;

	    struct uint128 uiZ;

	    union ui128_f128 uZ;

	    float256_t qf;

	    uiZ.v64 = packToF128UI64( 0, 0x7FFF, 0 );

	    uiZ.v0 = 0;

	    uZ.ui = uiZ;

	    qf = uZ.f;

	    __qMKFLOAT256(newFloat, qf);   /* OBJECT ALLOCATION */

	    inf = newFloat;

	}

#endif /* SUPPORT_OCTAFLOAT */

%}.

        inf isNil ifTrue:[

	    self errorUnsupported

        ].

	PositiveInfinity := inf

    ].

    ^ PositiveInfinity

    "Created: / 08-06-2019 / 14:05:26 / Claus Gittinger"

!

negativeInfinity

    "return a quadFloat which represents -INF"

    |inf|

    NegativeInfinity isNil ifTrue:[

%{  /* NOCONTEXT */

#ifdef xSUPPORT_OCTAFLOAT

	{

	    OBJ newFloat;

	    struct uint128 uiZ;

	    union ui128_f128 uZ;

	    float256_t qf;

	    uiZ.v64 = packToF128UI64( 1, 0x7FFF, 0 );

	    uiZ.v0 = 0;

	    uZ.ui = uiZ;

	    qf = uZ.f;

	    __qMKFLOAT256(newFloat, qf);   /* OBJECT ALLOCATION */

	    inf = newFloat;

	}

#endif /* SUPPORT_OCTAFLOAT */

%}.

        inf isNil ifTrue:[

	    self errorUnsupported

        ].

	NegativeInfinity := inf

    ].

    ^ NegativeInfinity

    "Created: / 08-06-2019 / 14:05:50 / Claus Gittinger"

!

phi

    "return the constant phi as quadFloat"

    Phi isNil ifTrue:[

	"/ phiDigits has enough digits for 128bit IEEE quads

	"/ do not use as a literal constant here - we cannot depend on the underlying C-compiler here...

	Phi  := self readFrom:(Number phiDigits)

    ].

    ^ Phi

!

pi

    "return the constant pi as quadFloat"

    Pi isNil ifTrue:[

	"/ piDigits has enough digits for 128bit IEEE quads

	"/ do not use as a literal constant here - we cannot depend on the underlying C-compiler here...

	Pi  := self readFrom:(Number piDigits)

    ].

    ^ Pi

    "Created: / 06-06-2019 / 17:09:51 / Claus Gittinger"

!

unity

    "return the neutral element for multiplication (1.0) as OctaFloat"

    OctaFloatOne isNil ifTrue:[

	OctaFloatOne := 1.0 asOctaFloat.

    ].

    ^ OctaFloatOne

    "Created: / 07-06-2019 / 03:26:38 / Claus Gittinger"

!

zero

    "return the neutral element for addition (0.0) as OctaFloat"

    OctaFloatZero isNil ifTrue:[

	OctaFloatZero := 0.0 asOctaFloat

    ].

    ^ OctaFloatZero

    "Created: / 07-06-2019 / 09:22:56 / Claus Gittinger"

! !

!OctaFloat class methodsFor:'error reportng'!

errorUnsupported

    "you may proceed from this error, to get a long float number result 

     (of course, with less than expected precision)"

    self errorUnsupported:'OctaFloats not supported on this patform'

    "Created: / 07-06-2019 / 02:44:39 / Claus Gittinger"

    "

     UnimplementedFunctionalityError handle:[:ex |

         ex proceed

     ] do:[

         1.0 asQuadFloat

     ]. 

    "

! !

!OctaFloat class methodsFor:'queries'!

epsilon

    "return the maximum relative spacing of instances of mySelf

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

    Epsilon isNil ifTrue:[

	Epsilon := self computeEpsilon.

    ].

    ^ Epsilon

    "

     self epsilon

    "

    "Created: / 10-06-2019 / 21:21:18 / Claus Gittinger"

!

exponentCharacter

    "return the character used to print between mantissa an exponent.

     Also used by the scanner when reading numbers."

    ^ $O

    "Created: / 10-06-2019 / 21:28:04 / Claus Gittinger"

!

numBitsInExponent