SUMMARY:  INNER | FIELD | CONSTR | METHOD | FRIEND DETAIL:  FIELD | CONSTR | METHOD | FRIEND


Platform::Lang::TypeProperties
Template Struct FloatingPointType

NonConstructibleType
   |
   +-FloatingPointType

Implemented in:
Platform.Lang.TypeProperties.FloatingPointType.h
Direct Known Subclasses:
Traits<Platform::Double>, Traits<Platform::Float>

template <typename Type>
struct FloatingPointType:
private NonConstructibleType

Implements type properties and common functions for the floating-point types.

See Also:
Traits

Inner Compounds, Typedefs, and Enumscollapse
typedef HasNothrowAssign
          Defines HasNothrowAssign property, set to TrueType for this type.
typedef HasNothrowConstructor
          Defines HasNothrowConstructor property, set to TrueType for this type.
typedef HasNothrowCopy
          Defines HasNothrowCopy property, set to TrueType for this type.
typedef HasTrivialAssign
          Defines HasTrivialAssign property, set to TrueType for this type.
typedef HasTrivialConstructor
          Defines HasTrivialConstructor property, set to TrueType for this type.
typedef HasTrivialCopy
          Defines HasTrivialCopy property, set to TrueType for this type.
typedef HasTrivialDestructor
          Defines HasTrivialDestructor property, set to TrueType for this type.
typedef IsAGP
          Defines IsAGP property, set to FalseType for this type.
typedef IsBoolean
          Defines IsBoolean property, set to FalseType for this type.
typedef IsCharacter
          Defines IsCharacter property, set to FalseType for this type.
typedef IsFloatingPoint
          Defines IsFloatingPoint property, set to TrueType for this type.
typedef IsFundamental
          Defines IsFundamental property, set to TrueType for this type.
typedef IsIntegral
          Defines IsIntegral property, set to FalseType for this type.
typedef IsPOD
          Defines IsPOD property, set to TrueType for this type.
typedef IsSigned
          Defines IsSigned property, set to FalseType for this type.
typedef IsTextual
          Defines IsTextual property, set to FalseType for this type.
typedef IsUnsigned
          Defines IsUnsigned property, set to FalseType for this type.
typedef IsVoid
          Defines IsVoid property, set to FalseType for this type.

Method Summarycollapse
template <typename TypeX>
static Int
compare(const Type& objectA, const TypeX& objectB)
          Compares two objects for order (total order relation).
template <typename TypeX>
static Int
compare(const Type& objectA, const TypeX& objectB, Type threshold)
          Compares two objects for order (total order relation).
static UInt deepSizeOf(const Type& object)
          Returns the deep size of the specified object, in bytes.
template <typename TypeX>
static Bool
equal(const Type& objectA, const TypeX& objectB)
          Tests whether two objects are equal (equivalence relation).
template <typename TypeX>
static Bool
equal(const Type& objectA, const TypeX& objectB, Type threshold)
          Tests whether two objects are equal (equivalence relation).
static Void exchange(Type& objectA, Type& objectB)
          Exchanges the values of two objects.
static UInt hashCodeOf(const Type& object)
          Returns the hash code for the specified object.
static Bool isInfinity(const Type& object)
          Tests whether the specified object is an Infinity.
static Bool isNaN(const Type& object)
          Tests whether the specified object is a NaN (Not A Number).
static String toString(const Type& object)
          Returns a string representation of the specified object.
static String toXml(const Type& object)
          Returns an XML representation of the specified object.
static const Char* typeName()
          Returns the formal name of this type.

 

Method Detail

compare[nothrow, inline]

template <typename TypeX>
static Int compare(const Type& objectA, const TypeX& objectB)

Compares two objects for order (total order relation).

Parameters:
objectA - first object
objectB - second object
Returns:
a signed integer number indicating total order relationship between the objects
  • result < 0 if objectA < objectB
  • result == 0 if objectA == objectB
  • result > 0 if objectA > objectB
See Also:
Lang::compare

compare[nothrow, inline]

template <typename TypeX>
static Int compare(const Type& objectA, const TypeX& objectB, Type threshold)

Compares two objects for order (total order relation).

Parameters:
objectA - first object
objectB - second object
threshold - a threshold
Returns:
a signed integer number indicating total order relationship between the objects
  • result < 0 if objectA < objectB
  • result == 0 if objectA == objectB
  • result > 0 if objectA > objectB
See Also:
Lang::compare

deepSizeOf[nothrow, inline]

static UInt deepSizeOf(const Type& object)

Returns the deep size of the specified object, in bytes.

Parameters:
object - an object
Returns:
the deep size of the specified object, in bytes
See Also:
Lang::deepSizeOf

equal[nothrow, inline]

template <typename TypeX>
static Bool equal(const Type& objectA, const TypeX& objectB)

Tests whether two objects are equal (equivalence relation).

Parameters:
objectA - first object
objectB - second object
Returns:
True if the objects are equal, False otherwise
See Also:
Lang::equal

equal[nothrow, inline]

template <typename TypeX>
static Bool equal(const Type& objectA, const TypeX& objectB, Type threshold)

Tests whether two objects are equal (equivalence relation).

Parameters:
objectA - first object
objectB - second object
threshold - a threshold
Returns:
True if the objects are equal, False otherwise
See Also:
Lang::equal

exchange[nothrow, inline]

static Void exchange(Type& objectA, Type& objectB)

Exchanges the values of two objects.

Parameters:
objectA - first object
objectB - second object
See Also:
Lang::exchange

hashCodeOf[nothrow, inline]

static UInt hashCodeOf(const Type& object)

Returns the hash code for the specified object.

Parameters:
object - an object
Returns:
hash code for the specified object
See Also:
Lang::hashCodeOf

isInfinity[nothrow, inline]

static Bool isInfinity(const Type& object)

Tests whether the specified object is an Infinity.

Parameters:
object - an object
Returns:
True if the specified object is an Infinity, False otherwise

isNaN[nothrow, inline]

static Bool isNaN(const Type& object)

Tests whether the specified object is a NaN (Not A Number).

Parameters:
object - an object
Returns:
True if the specified object is a NaN, False otherwise

toString[nothrow, inline]

static String toString(const Type& object)

Returns a string representation of the specified object.

Parameters:
object - an object
Returns:
a string representation of the object
See Also:
Lang::toString

toXml[nothrow, inline]

static String toXml(const Type& object)

Returns an XML representation of the specified object.

Parameters:
object - an object
Returns:
an XML representation of the object
See Also:
Lang::toXml

typeName[nothrow, inline]

static const Char* typeName()

Returns the formal name of this type.

Returns:
the formal name of this type


SUMMARY:  INNER | FIELD | CONSTR | METHOD | FRIEND DETAIL:  FIELD | CONSTR | METHOD | FRIEND