Class TRealX

TRealX

Support

Supported from 5.0

Description

A class encapsulating an extended precision real value.

This class provides 64 bit precision and a dynamic range of approximately 1E-9863 to 1E+9863. All member functions are optimized for speed.

Defined in TRealX:
Add(), AddEq(), Div(), DivEq(), GetTReal(), IsFinite(), IsInFinite(), IsNaN(), IsZero(), Mod(), ModEq(), Mult(), MultEq(), Set(), SetInfinite(), SetNaN(), SetZero(), Sub(), SubEq(), TRealX(), operator TInt(), operator TInt64(), operator TReal32(), operator TReal64(), operator TUint(), operator!=(), operator%(), operator%=(), operator*(), operator*=(), operator+(), operator++(), operator++(TInt), operator+=(), operator-(), operator--(), operator--(TInt), operator-=(), operator/(), operator/=(), operator<(), operator<=(), operator==(), operator>(), operator>=()

TRealX();

Description

Constructs a default extended precision object. This sets the value to zero.

TRealX(TInt aInt);

Description

Constructs an extended precision object from a signed integer value.

Parameters

TInt aInt The signed integer value.

TRealX(TUint aInt);

Description

Constructs an extended precision object from an unsigned integer value.

Parameters

TUint aInt The unsigned integer value.

TRealX(TUint aExp, TUint aMantHi, TUint aMantLo);

Description

Constructs an extended precision object from an explicit exponent and a 64 bit mantissa.

Parameters

TUint aExp The exponent TUint aMantHi The high order 32 bits of the 64 bit mantissa TUint aMantLo The low order 32 bits of the 64 bit mantissa

TRealX(const TInt64& aInt);

Description

Constructs an extended precision object from a 64 bit integer.

Parameters

const TInt64& aInt A reference to a 64 bit integer.

TRealX(TReal32 aReal);

Description

Constructs an extended precision object from a single precision floating point number.

Parameters

TReal32 aReal The single precision floating point value.

TRealX(TReal64 aReal);

Description

Constructs an extended precision object from a double precision floating point number.

Parameters

TReal32 aReal The double precision floating point value.

TInt Set(TInt aInt);

Description

Gives this extended precision object a new value taken from a signed integer.

Parameters

TInt aInt The signed integer value..

Return value

TInt KErrNone, always

TInt Set(TUint aInt);

Description

Gives this extended precision object a new value taken from an unsigned integer.

Parameters

TInt aInt The unsigned integer value.

Return value

TInt KErrNone, always

TInt Set(const TInt64& aInt);

Description

Gives this extended precision object a new value taken from a 64 bit integer.

Parameters

const TInt64& aInt The 64 bit integer value.

Return value

TInt KErrNone, always

TInt Set(TReal32 aReal);

Description

Gives this extended precision object a new value taken from a single precision floating point number.

Parameters

TReal32 aReal The single precision floating point value.

Return value

TInt KErrNone, if a valid number KErrOverflow, if the number is infinite KErrArgument, if not a number

TInt Set(TReal64 aReal);

Description

Gives this extended precision object a new value taken from a double precision floating point number.

Parameters

TReal64 aReal The double precision floating point value.

Return value

TInt KErrNone, if a valid number KErrOverflow, if the number is infinite KErrArgument, if not a number

void SetZero(TBool aNegative=EFalse);

Description

Sets the value of this extended precision object to zero.

Parameters

TBool aNegative ETrue, the value is a negative zero EFalse, the value is a positive zero; this is the default.

void SetNaN();

Description

Sets the value of this extended precision object to 'not a number'.

void SetInfinite(TBool aNegative);

Description

Sets the value of this extended precision object to infinity.

Parameters

TBool aNegative ETrue, the value is a negative zero EFalse, the value is a positive zero

operator TInt();

Description

Returns the extended precision value as a signed integer value.

The operator returns:

• zero , if the extended precision value is not a number

• 0x7FFFFFFF, if the value is positive and too big to fit into aTInt.

• 0x80000000, if the value is negative and too big to fit into aTInt.

operator TUint();

Description

Returns the extended precision value as an unsigned signed integer value.

The operator returns:

• zero, if the extended precision value is not a number

• 0xFFFFFFFF, if the value is positive and too big to fit into aTUint.

• zero, if the value is negative and too big to fit into aTUint.

operator TInt64();

Description

Returns the extended precision value as a 64 bit integer value.

The operator returns:

• zero, if the extended precision value is not a number

• 0x7FFFFFFF FFFFFFFF, if the value is positive and too big to fit into aTInt64

• 0x80000000 00000000, if the value is negative and too big to fit into aTInt.

operator TReal32();

Description

Returns the extended precision value as a single precision floating point value.

TInt GetTReal(TReal32& aVal) const;

Description

Extracts the extended precision value as a single precision floating point value.

Parameters

TReal32& aVal A reference to an single precision object which contains the result of the operation.

Return value

TInt KErrNone, if the operation is successfulKErrOverflow, if the operation results in overflowKErrUnderflow, if the operation results in underflow.

operator TReal64();

Description

Returns the extended precision value as a double precision floating point value.

TInt GetTReal(TReal64& aVal) const;

Description

Extracts the extended precision value as a double precision floating point value.

Parameters

TReal64& aVal A reference to a double precision object which contains the result of the operation.

Return value

TInt KErrNone, if the operation is successfulKErrOverflow, if the operation results in overflowKErrUnderflow, if the operation results in underflow.

TBool IsZero() const;

Description

Determines whether the extended precision value is zero.

Return value

TBool True, if the extended precision value is zero false, otherwise.

TBool IsNaN() const;

Description

Determines whether the extended precision value is not a number.

Return value

TBool True, if the extended precision value is not a number. false, otherwise.

TBool IsFinite() const;

Description

Determines whether the extended precision value has a finite value.

Return value

TBool True, if the extended precision value is finite. false, if the value is not a number or is infinite,

TBool IsInfinite() const;

Description

Determines whether the extended precision value has an infinite value.

Return value

TBool True, if the extended precision value is infinite. false, otherwise.

const TRealX& operator+=(const TRealX& aVal);

Description

Adds an extended precision value to this extended precision number.

The operator raises a:

• MATHX KErrOverflow panic if the operation results in overflow.

• MATHX KErrUnderflow panic if the operation results in underflow.

Parameters

const TRealX& aVal The extended precision value to be added.

Return value

const TRealX& A reference to this object.

const TRealX& operator-=(const TRealX& aVal);

Description

Subtracts an extended precision value from this extended precision number.

The operator raises a:

• MATHX KErrOverflow panic if the operation results in overflow.

• MATHX KErrUnderflow panic if the operation results in underflow.

Parameters

const TRealX& aVal The extended precision value to be subtracted.

Return value

const TRealX& A reference to this object.

const TRealX& operator*=(const TRealX& aVal);

Description

Multiplies this extended precision number by an extended precision value.

The operator raises a:

• MATHX KErrOverflow panic if the operation results in overflow.

• MATHX KErrUnderflow panic if the operation results in underflow.

Parameters

const TRealX& aVal The extended precision value to be used as the multiplier.

Return value

const TRealX& A reference to this object.

const TRealX& operator/=(const TRealX& aVal);

Description

Divides this extended precision number by an extended precision value.

The operator raises a:

• MATHX KErrOverflow panic if the operation results in overflow.

• MATHX KErrUnderflow panic if the operation results in underflow.

• MATHX KErrDivideByZero panic if the divisor is zero.

Parameters

const TRealX& aVal The extended precision value to be used as the divisor.

Return value

const TRealX& A reference to this object.

const TRealX& operator%=(const TRealX& aVal);

Description

Modulo-divides this extended precision number by an extended precision value.

The operator raises a:

• MATHX KErrTotalLossOfPrecision panic if precision is lost.

• MATHX KErrUnderflow panic if the operation results in underflow.

Parameters

const TRealX& aVal The extended precision value to be used as the divisor.

Return value

const TRealX& A reference to this object.

TRealX operator+() const;

Description

Returns this extended precision number unchanged.

Return value

TRealX The extended precision number

Notes:

• This may also be referred to as a unary plus operator.

TRealX operator-() const;

Description

Negates this extended precision number.

Return value

TRealX The negative of the extended precision number

Notes:

• This may also be referred to as a unary minus operator.

TRealX& operator++();

Description

Increments this extended precision number by one and returns a reference to it.

The operator raises a:

• MATHX KErrOverflow panic if the operation results in overflow.

• MATHX KErrUnderflow panic if the operation results in overflow.

Return value

TRealX& A reference to this object

Notes:

• This is also referred to as a prefix operator.

TRealX operator++(TInt);

Description

Returns this extended precision number before incrementing it by one.

The operator raises a:

• MATHX KErrOverflow panic if the operation results in overflow.

• MATHX KErrUnderflow panic if the operation results in underflow.

Return value

TRealX An extended precision object.

Notes:

• This is also referred to as a postfix operator.

TRealX& operator--();

Description

Decrements this extended precision number by one and returns a reference to it.

The operator raises a:

• MATHX KErrOverflow panic if the operation results in overflow.

• MATHX KErrUnderflow panic if the operation results in underflow.

Return value

TRealX& A reference to this object

Notes:

• This is also referred to as a prefix operator.

TRealX operator--(TInt);

Description

Returns this extended precision number before decrementing it by one.

The operator raises a:

• MATHX KErrOverflow panic if the operation results in overflow.

• MATHX KErrUnderflow panic if the operation results in underflow.

Return value

TRealX An extended precision object.

Notes:

• This is also referred to as a postfix operator.

TRealX operator+(const TRealX& aVal) const;

Description

Adds an extended precision value to this extended precision number.

The operator raises a:

• MATHX KErrOverflow panic if the operation results in overflow.

• MATHX KErrUnderflow panic if the operation results in underflow.

Parameters

const TRealX& aVal The extended precision value to be added.

Return value

TRealX An extended precision object containing the result

TRealX operator-(const TRealX& aVal) const;

Description

Subtracts an extended precision value from this extended precision number.

The operator raises a:

• MATHX KErrOverflow panic if the operation results in overflow.

• MATHX KErrUnderflow panic if the operation results in underflow.

Parameters

const TRealX& aVal The extended precision value to be subtracted.

Return value

TRealX An extended precision object containing the result.

TRealX operator*(const TRealX& aVal) const;

Description

Multiplies this extended precision number by an extended precision value.

The operator raises a:

• MATHX KErrOverflow panic if the operation results in overflow.

• MATHX KErrUnderflow panic if the operation results in underflow.

Parameters

const TRealX& aVal The extended precision value to be used as the multiplier.

Return value

TRealX An extended precision object containing the result.

TRealX operator/(const TRealX& aVal) const;

Description

Divides this extended precision number by an extended precision value.

The operator raises a:

• MATHX KErrOverflow panic if the operation results in overflow.

• MATHX KErrUnderflow panic if the operation results in underflow.

• MATHX KErrDivideByZero panic if the divisor is zero.

Parameters

const TRealX& aVal The extended precision value to be used as the divisor.

Return value

TRealX An extended precision object containing the result.

TRealX operator%(const TRealX& aVal) const;

Description

Modulo-divides this extended precision number by an extended precision value.

The operator raises a:

• MATHX KErrTotalLossOfPrecision panic if precision is lost.

• MATHX KErrUnderflow panic if the operation results in underflow.

Parameters

const TRealX& aVal The extended precision value to be used as the divisor.

Return value

TRealX An extended precision object containing the result.

TInt AddEq(const TRealX& aVal);

Description

Adds an extended precision value to this extended precision number.

Parameters

const TRealX& aVal The extended precision value to be added.

Return value

TInt KErrNone, if the operation is successfulKErrOverflow, if the operation results in overflowKErrUnderflow, if the operation results in underflow.

TInt SubEq(const TRealX& aVal);

Description

Subtracts an extended precision value from this extended precision number.

Parameters

const TRealX& aVal The extended precision value to be subtracted.

Return value

TInt KErrNone, if the operation is successfulKErrOverflow, if the operation results in overflowKErrUnderflow, if the operation results in underflow

TInt MultEq(const TRealX& aVal);

Description

Multiplies this extended precision number by an extended precision value.

Parameters

const TRealX& aVal The extended precision value to be used as the multiplier.

Return value

TInt KErrNone, if the operation is successfulKErrOverflow, if the operation results in overflowKErrUnderflow, if the operation results in underflow.

TInt DivEq(const TRealX& aVal);

Description

Divides this extended precision number by an extended precision value.

Parameters

const TRealX& aVal The extended precision value to be used as the divisor.

Return value

TInt KErrNone, if the operation is successfulKErrOverflow, if the operation results in overflowKErrUnderflow, if the operation results in underflowKErrDivideByZero, if the divisor is zero.

TInt ModEq(const TRealX& aVal);

Description

Modulo-divides this extended precision number by an extended precision value.

Parameters

const TRealX& aVal The extended precision value to be used as the divisor.

Return value

TInt KErrNone, if the operation is successfulKErrTotalLossOfPrecision, if precision is lostKErrUnderflow, if the operation results in underflow.

TInt Add(TRealX& aResult,const TRealX& aVal) const;

Description

Adds an extended precision value to this extended precision number.

Parameters

TRealX& aResult On return, a reference to an extended precision object containing the result of the operation. const TRealX& aVal The extended precision value to be added.

Return value

TInt KErrNone, if the operation is successfulKErrOverflow, if the operation results in overflowKErrUnderflow, if the operation results in underflow.

TInt Sub(TRealX& aResult,const TRealX& aVal) const;

Description

Subtracts an extended precision value from this extended precision number.

Parameters

TRealX& aResult On return, a reference to an extended precision object containing the result of the operation. const TRealX& aVal The extended precision value to be subtracted.

Return value

TInt KErrNone, if the operation is successfulKErrOverflow, if the operation results in overflowKErrUnderflow, if the operation results in underflow.

TInt Mult(TRealX& aResult,const TRealX& aVal) const;

Description

Multiplies this extended precision number by an extended precision value.

Parameters

TRealX& aResult On return, a reference to an extended precision object containing the result of the operation. const TRealX& aVal The extended precision value to be used as the multiplier.

Return value

TInt KErrNone, if the operation is successfulKErrOverflow, if the operation results in overflowKErrUnderflow, if the operation results in underflow.

TInt Div(TRealX& aResult,const TRealX& aVal) const;

Description

Divides this extended precision number by an extended precision value.

Parameters

TRealX& aResult On return, a reference to an extended precision object containing the result of the operation. const TRealX& aVal The extended precision value to be used as the divisor.

Return value

TInt KErrNone, if the operation is successfulKErrOverflow, if the operation results in overflowKErrUnderflow, if the operation results in underflowKErrDivideByZero, if the divisor is zero

TInt Mod(TRealX& aResult,const TRealX& aVal) const;

Description

Modulo-divides this extended precision number by an extended precision value.

Parameters

TRealX& aResult On return, a reference to an extended precision object containing the result of the operation. const TRealX& aVal The extended precision value to be used as the divisor.

Return value

TInt KErrNone, if the operation is successfulKErrTotalLossOfPrecision, if precision is lostKErrUnderflow, if the operation results in underflow.

TBool operator==(const TRealX& aVal) const;

Description

Compares this extended precision number for equality with another.

Parameters

const TRealX& aVal A reference to the extended precision value to be compared.

Return value

TBool True, if this extended precision number is equal to aValfalse, otherwise.

TBool operator!=(const TRealX& aVal) const;

Description

Compares this extended precision number for in-equality with another.

Parameters

const TRealX& aVal A reference to the extended precision value to be compared.

Return value

TBool True, if this extended precision number is not equal toaVal false, otherwise.

TBool operator>=(const TRealX& aVal) const;

Description

Compares this extended precision number for being greater than or equal to another.

Parameters

const TRealX& aVal A reference to the extended precision value to be compared.

Return value

TBool True, if this extended precision number is greater than or equal toaVal false, otherwise

TBool operator<=(const TRealX& aVal) const;

Description

Compares this extended precision number for being less than or equal to another.

Parameters

const TRealX& aVal A reference to the extended precision value to be compared.

Return value

TBool True, if this extended precision number is less than or equal toaVal false, otherwise.

TBool operator>(const TRealX& aVal) const;

Description

Compares this extended precision number for being greater than another.

Parameters

const TRealX& aVal A reference to the extended precision value to be compared.

Return value

TBool True, if this extended precision number is greater than or equal toaVal false, otherwise,

TBool operator<(const TRealX& aVal) const;

Description

Compares this extended precision number for being less than another.

Parameters

const TRealX& aVal A reference to the extended precision value to be compared.

Return value

TBool True, if this extended precision number is less than or equal toaVal false, otherwise,