Class: TDoubleLong

Declaration: PrimitiveTypes.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

None.

Inherited By:

None.

Purpose:

Implements a signed integer data type twice as wide as the long data-type. It supports most standard integer operations, as defined by ANSI C, thus serving as an extension of the long data type.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

None. Do not derive from this class.

Concurrency:

Multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TDoubleLong::TDoubleLong

  1. TDoubleLong (long mostSignificant, unsigned long leastSignificant)
  2. TDoubleLong (unsigned long)
  3. TDoubleLong (long)
  4. TDoubleLong (unsigned int)
  5. TDoubleLong (int)
  6. TDoubleLong ()
  7. TDoubleLong (long double)
  8. TDoubleLong (double)

Interface Category:

API.

Purpose:

  1. Creates a TDoubleLong object, given its high and low long words.
  2. Creates a TDoubleLong object from an unsigned long integral type.
  3. Creates a TDoubleLong object from a long integral type.
  4. Creates a TDoubleLong object from an unsigned int integral type.
  5. Creates a TDoubleLong object from an int integral type.
  6. Default constructor -does no initialization.
  7. Creates a TDoubleLong object from a long double floating-point type.
  8. Creates a TDoubleLong object from a double floating-point type.

Calling Context:

  1. Designed to work in nondefault floating-point modes.
    2. Call this function directly.
  2. Designed to work in nondefault floating-point modes.
    3. Call this function directly.
  3. Designed to work in nondefault floating-point modes.
    4. Call this function directly.
  4. Designed to work in nondefault floating-point modes.
    5. Call this function directly.
  5. Designed to work in nondefault floating-point modes.
    6. Call this function directly.
  6. Called by the stream-in operators.
  7. Designed to work in nondefault floating-point modes.
    8. Call this function directly.
  8. Designed to work in nondefault floating-point modes.
    9. Call this function directly.

Parameters:

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TDoubleLong::~TDoubleLong

~ TDoubleLong ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Called to destroy an object.

Parameters:

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TDoubleLong::operatorlongdouble

operator long double () const

Interface Category:

API.

Purpose:

Conversion from TDoubleLong to long double.

Calling Context:

Designed to work in nondefault floating-point modes. Call this function directly.

Parameters:

Return Value:

Long double. Result of long double casting a TDoubleLong.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

Uses floating-point directly.

Member Function: TDoubleLong::TDoubleLongMax

static TDoubleLong TDoubleLongMax (void)

Interface Category:

API.

Purpose:

Returns the largest TDoubleLong value.

Calling Context:

Designed to work in nondefault floating-point modes. Call this function directly.

Parameters:

Return Value:

Returns a TDoubleLong object containing the largest TDoubleLong value.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TDoubleLong::TDoubleLongMin

static TDoubleLong TDoubleLongMin (void)

Interface Category:

API.

Purpose:

Returns the smallest (most negative) TDoubleLong value.

Calling Context:

Designed to work in nondefault floating-point modes. Call this function directly.

Parameters:

Return Value:

Returns a TDoubleLong object containing the smallest TDoubleLong value.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TDoubleLong::GetMostSignificant

long GetMostSignificant () const

Interface Category:

API.

Purpose:

Returns the high long word of a TDoubleLong object.

Calling Context:

Designed to work in nondefault floating-point modes. Call this function directly.

Parameters:

Return Value:

Returns the high long word of a TDoubleLong object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TDoubleLong::GetLeastSignificant

unsigned long GetLeastSignificant () const

Interface Category:

API.

Purpose:

Returns the low unsigned long word of a TDoubleLong object.

Calling Context:

Designed to work in nondefault floating-point modes. Call this function directly.

Parameters:

Return Value:

Returns the low unsigned long word of a TDoubleLong object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TDoubleLong::Hash

HashResult Hash () const

Interface Category:

API.

Purpose:

Hashes a TDoubleLong object to type HashResult.

Calling Context:

Designed to work in nondefault floating-point modes. Call this function directly.

Parameters:

Return Value:

HashResult -Returns a hash value that is dependent on a TDoubleLong object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TDoubleLong::operator>>=

  1. TStream & operator >>=(TStream &) const
  2. TDoubleLong & operator >>=(int)

Interface Category:

API.

Purpose:

  1. Stream-out operator.
  2. Right-shift assignment operator.

Calling Context:

  1. Called to stream out data. Designed to work in nondefault floating-point modes.
  2. Call this function directly.

Parameters:

Return Value:

  1. Returns a reference to the stream the object streams itself out to.
  2. Returns a reference to the shifted object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TDoubleLong::operator<<=

  1. TStream & operator <<= (TStream &)
  2. TDoubleLong & operator <<= (int)

Interface Category:

API.

Purpose:

  1. Stream-in operator.
  2. Left-shift assignment operator.

Calling Context:

  1. Called to stream in data. Designed to work in nondefault floating-point modes.
  2. Call this function directly.

Parameters:

Return Value:

  1. Returns a reference to the stream the object streams itself in from.
  2. Returns a reference to the shifted object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TDoubleLong::operator++

  1. TDoubleLong & operator ++ ()
  2. TDoubleLong & operator ++ (int)

Interface Category:

API.

Purpose:

  1. Prefix increment operator.
  2. Postfix increment operator.

Calling Context:

  1. Call this function directly.
  2. Call this function directly.

Parameters:

Return Value:

TDoubleLong -Original value incremented by one.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TDoubleLong::operator--

  1. TDoubleLong & operator --()
  2. TDoubleLong & operator --(int)

Interface Category:

API.

Purpose:

  1. Prefix decrement operator.
  2. Postfix decrement operator.

Calling Context:

  1. Call this function directly.
  2. Call this function directly.

Parameters:

Return Value:

TDoubleLong -Original value decremented by one.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TDoubleLong::operator+=

TDoubleLong & operator += (const TDoubleLong &)

Interface Category:

API.

Purpose:

Addition assignment operator.

Calling Context:

Designed to work in nondefault floating-point modes. Call this function directly.

Parameters:

Return Value:

A reference to the modified object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TDoubleLong::operator-=

TDoubleLong & operator -=(const TDoubleLong &)

Interface Category:

API.

Purpose:

Subtraction assignment operator.

Calling Context:

Designed to work in nondefault floating-point modes. Call this function directly.

Parameters:

Return Value:

A reference to the modified object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TDoubleLong::operator*=

TDoubleLong & operator *= (const TDoubleLong &)

Interface Category:

API.

Purpose:

Multiplication assignment operator.

Calling Context:

Designed to work in nondefault floating-point modes. Call this function directly.

Parameters:

Return Value:

A reference to the modified object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TDoubleLong::operator/=

TDoubleLong & operator /= (const TDoubleLong &)

Interface Category:

API.

Purpose:

Division assignment operator.

Calling Context:

Designed to work in nondefault floating-point modes. Call this function directly.

Parameters:

Return Value:

A reference to the modified object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TDoubleLong::operator%=

TDoubleLong & operator %= (const TDoubleLong &)

Interface Category:

API.

Purpose:

Remainder assignment operator.

Calling Context:

Designed to work in nondefault floating-point modes. Call this function directly.

Parameters:

Return Value:

A reference to the modified object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TDoubleLong::operator|=

TDoubleLong & operator |=(const TDoubleLong &)

Interface Category:

API.

Purpose:

Bitwise inclusive OR assignment operator.

Calling Context:

Designed to work in nondefault floating-point modes. Call this function directly.

Parameters:

Return Value:

A reference to the modified object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TDoubleLong::operator&=

TDoubleLong & operator &= (const TDoubleLong &)

Interface Category:

API.

Purpose:

Bitwise AND assignment operator.

Calling Context:

Designed to work in nondefault floating-point modes. Call this function directly.

Parameters:

Return Value:

A reference to the modified object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TDoubleLong::operator^=

TDoubleLong & operator ^= (const TDoubleLong &)

Interface Category:

API.

Purpose:

Bitwise exclusive OR assignment operator.

Calling Context:

Designed to work in nondefault floating-point modes. Call this function directly.

Parameters:

Return Value:

A reference to the modified object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.
Click the icon to mail questions or corrections about this material to Taligent personnel.
Copyright©1995 Taligent,Inc. All rights reserved.