Class: TCanonicalNumberRef

Declaration: CanonicalNumber.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

None.

Inherited By:

None.

Purpose:

This class is used as a liaison class, and intended only for supporting the subscript operator of TCanonicalNumber to distinguish between reading and writing to its internal buffer of significand digits. It is not intended for general use on its own.

Instantiation:

Do not instantiate.

Deriving Classes:

Do not derive from this class.

Concurrency:

Multithread safe.

Resource Use:

No special requirements.

Other Considerations:

Not intended for use on its own.

Member Function: TCanonicalNumberRef::TCanonicalNumberRef

TCanonicalNumberRef (TCanonicalNumber & TCN, unsigned short index)

Interface Category:

API.

Purpose:

Constructor

Calling Context:

Used internally to support the subscript operator of TCanonicalNumber. Not intended for general use. Designed to work in non-default floating-point rounding modes.

Parameters:

TCanonicalNumber & TCN -The host TCanonicalNumber object.
unsigned short index -Location in internal buffer.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

Not intended for use on its own.

Member Function: TCanonicalNumberRef::operator=

TCanonicalNumberRef & operator =(TCanonicalNumber :: Digit)

Interface Category:

API.

Purpose:

Used internally to support the subscript operator of TCanonicalNumber.

Calling Context:

Used internally to support the subscript operator of TCanonicalNumber. Used to read digits from a TCanonicalNumber object. Designed to work in non-default floating-point rounding modes.

Parameters:

TCanonicalNumber :: Digit -Value to write into the buffer.

Return Value:

Returns a TCanonicalNumberRef & that refers to the buffer entry to be written.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

Not intended for use on its own.

Member Function: TCanonicalNumberRef::operatorTCanonicalNumber::Digit

operator TCanonicalNumber :: Digit ()

Interface Category:

API.

Purpose:

Used internally to support the subscript operator of TCanonicalNumber.

Calling Context:

Used internally to support the subscript operator of TCanonicalNumber. May be called directly, but the only anticipated clients of TCanonicalNumber are the TNumberFormat classes. Used to write digits into a TCanonicalNumber object. Designed to work in non-default floating-point rounding modes.

Parameters:

Takes no parameters.

Return Value:

Implicitly int.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

Not intended for use on its own.

Click the icon to mail questions or corrections about this material to Taligent personnel.