//
-// Open Service Platform
// Copyright (c) 2012 Samsung Electronics Co., Ltd.
//
// Licensed under the Apache License, Version 2.0 (the License);
//
/**
- * @file FBaseDouble.h
- * @brief This is the header file for the %Double class.
- *
- * @see Tizen::Base::Number
+ * @file FBaseDouble.h
+ * @brief This is the header file for the %Double class.
*
* This header file contains the declarations of the %Double class.
+ *
+ * @see Tizen::Base::Number
*/
#ifndef _FBASE_DOUBLE_H_
#define _FBASE_DOUBLE_H_
#include <FBaseNumber.h>
-
namespace Tizen { namespace Base
{
/**
* 1.79769313486232e308 to positive 1.79769313486232e308. This class is useful when passing a @c double
* value to a method expecting an instance of Object, such as Tizen::Base::Collection::Queue or
* Tizen::Base::Collection::Stack. Furthermore, this class provides methods for converting
- * %Double (and @c double) to String, and String to %Double (and @c double).
+ * %Double (and @c double) to String, and %String to %Double (and @c double).
*
* The following example demonstrates how to use the %Double class.
*
*
* @since 2.0
*
- * @param[in] value A @c double value
+ * @param[in] value The @c double value
*/
Double(double value = 0.0L);
-
/**
* Copying of objects using this copy constructor is allowed.
*
* @since 2.0
*
- * @param[in] value An instance of %Double
+ * @param[in] value An instance of %Double to copy
*/
Double(const Double& value);
*
* @since 2.0
*
- * @param[in] rhs An instance of %Double
+ * @param[in] rhs An instance of %Double to copy
*/
Double& operator =(const Double& rhs);
*
* @since 2.0
*
- * @return A 32-bit @c signed integer value
+ * @return The 32-bit @c signed integer value
* @code
- * < 0 if the value of @c d1 is less than the value of @c d2
- * == 0 if the value of @c d1 is equal to the value of @c d2
- * > 0 if the value of @c d1 is greater than the value of @c d2
+ * < 0 if the value of d1 is less than the value of d2
+ * == 0 if the value of d1 is equal to the value of d2
+ * > 0 if the value of d1 is greater than the value of d2
* @endcode
* @param[in] d1 The first @c double value to compare
* @param[in] d2 The second @c double value to compare
*
* @since 2.0
*
- * @return A 32-bit @c signed integer value
+ * @return The 32-bit @c signed integer value
* @code
- * < 0 if the value of the current instance is less than the specified @c signed @c double
- * == 0 if the value of the current instance is equal to the specified @c signed @c double
- * > 0 if the value of the current instance is greater than the specified @c signed @c double
+ * < 0 if the value of the current instance is less than the specified signed double
+ * == 0 if the value of the current instance is equal to the specified signed double
+ * > 0 if the value of the current instance is greater than the specified signed double
* @endcode
* @param[in] value A @c signed @c double value
*/
*
* @since 2.0
*
- * @return A 32-bit @c signed integer value
+ * @return The 32-bit @c signed integer value
* @code
* < 0 if the value of the current instance is less than the value of the specified instance
* == 0 if the value of the current instance is equal to the value of the specified instance
*
* @since 2.0
*
- * @return @c true if the value of the specified instance of %Object is equal to the value of the current instance of %Double, @n
+ * @return @c true if the value of the specified instance of Object is equal to the value of the current instance of %Double, @n
* else @c false
* @param[in] obj An instance of Object to compare
- * @see Tizen::Base::Object::Equals
+ * @see Tizen::Base::Object::Equals()
*/
virtual bool Equals(const Object& obj) const;
*
* @since 2.0
*
- * @return An integer value indicating the hash value of the current instance of %Double
- * @remarks Two equal instances must return the same hash value. For better performance,
- * the used hash function must generate a random distribution for all inputs. @n
- * The default implementation of this method returns the value of the current instance.
+ * @return The integer value that indicates the hash value of the current instance of %Double
+ * @remarks
+ * - Two equal instances must return the same hash value. @n
+ * For better performance, the used hash function must generate a random distribution for all the inputs.
+ * - The default implementation of this method returns the value of the current instance.
*/
virtual int GetHashCode(void) const;
/**
- * Gets the hash value of the specified @c double value.
- *
- * @since 2.0
- *
- * @return An integer value indicating the hash value of the specified @c double value
- * @param[in] val A @c double value to get the hash value
- */
+ * Gets the hash value of the specified @c double value.
+ *
+ * @since 2.0
+ *
+ * @return The integer value that indicates the hash value of the specified @c double value
+ * @param[in] val The @c double value to get the hash value
+ */
static int GetHashCode(double val);
/**
- * Parses the specified string representing a numeric value and returns the value as @c signed @c double (as out parameter).
+ * Parses the specified string that represents a numeric value and returns the value as @c signed @c double (as out parameter).
*
* @since 2.0
*
* @return An error code
- * @param[in] s A unicode representation of @c signed @c double value
- * @param[out] ret The converted numeric value
+ * @param[in] s The unicode representation of @c signed @c double value
+ * @param[out] ret The converted numeric value
* @exception E_SUCCESS The method is successful.
* @exception E_NUM_FORMAT The specified string does not contain a number that can be parsed.
- * @remarks This method guarantees that the original value of out-parameter is not changed when the method returns error.
+ * @remarks
+ * - This method guarantees that the original value of the out-parameter is not changed when the method returns an error.
+ * - The behavior of this method is dependent on the system default locale setting.
*/
static result Parse(const String& s, double& ret);
*
* @since 2.0
*
- * @return A @c signed @c char equivalent of the current instance
+ * @return The @c signed @c char equivalent of the current instance
*/
virtual char ToChar(void) const;
*
* @since 2.0
*
- * @return A @c signed @c short equivalent of the current instance
+ * @return The @c signed @c short equivalent of the current instance
*/
virtual short ToShort(void) const;
*
* @since 2.0
*
- * @return A @c signed @c int equivalent of the current instance
+ * @return The @c signed @c int equivalent of the current instance
*/
virtual int ToInt(void) const;
*
* @since 2.0
*
- * @return A @c signed @c long equivalent of the current instance
+ * @return The @c signed @c long equivalent of the current instance
*/
virtual long ToLong(void) const;
*
* @since 2.0
*
- * @return A @c signed @c long @c long equivalent of the current instance
+ * @return The @c signed @c long @c long equivalent of the current instance
*/
virtual long long ToLongLong(void) const;
*
* @since 2.0
*
- * @return A @c signed @c float equivalent of the current instance
+ * @return The @c signed @c float equivalent of the current instance
*/
virtual float ToFloat(void) const;
*
* @since 2.0
*
- * @return A @c signed @c double equivalent of the current instance
+ * @return The @c signed @c double equivalent of the current instance
*/
virtual double ToDouble(void) const;
/**
- * Gets the string representing the value of the current instance of %Double.
+ * Gets the string that represents the value of the current instance of %Double.
*
* @since 2.0
*
- * @return A string containing a Unicode representation of the value of the current instance
- * @remarks If the value of the current instance is Not-a-Number (NaN), the result is the string "NaN". Furthermore, infinity
+ * @return The string that contains the Unicode representation of the value of the current instance
+ * @remarks
+ * - If the value of the current instance is Not-a-Number (NaN), the result is the string "NaN". Furthermore, infinity
* produces the result "Infinity". @n
* 6 digits are given for the precision of this method. Use String::Format() to set the specific precision.
+ * - The behavior of this method is dependent on the system default locale setting.
*/
virtual String ToString(void) const;
/**
- * Gets the string representing the specified @c double value.
+ * Gets the string that represents the specified @c double value.
*
* @since 2.0
*
- * @return A string containing a Unicode representation of the specified @c double value
- * @param[in] value A @c double value to convert
- * @remarks If the input value is Not-a-Number (NaN), the result is the string "NaN". Furthermore, infinity
+ * @return The string that contains the Unicode representation of the specified @c double value
+ * @param[in] value The @c double value to convert
+ * @remarks
+ * - If the input value is Not-a-Number (NaN), the result is the string "NaN". Furthermore, infinity
* produces the result "Infinity". @n
* 6 digits are given for the precision of this method. Use String::Format() to set the specific precision.
+ * - The behavior of this method is dependent on the system default locale setting.
*/
static String ToString(double value);
* @since 2.0
*
* @return The bits that represent the floating-point number in the IEEE 754 floating-point "double format" bit layout
- * @param[in] value A @c double value to convert
+ * @param[in] value The @c double value to convert
*/
static long long ToBits(double value);
* @since 2.0
*
* @return The @c double floating-point value with the same bit pattern
- * @param[in] value The floating-point value to convert
+ * @param[in] value The floating-point value to convert
*/
static double ToDoubleFromBits(long long value);
/**
- * Checks whether the current value of %Double is equal to negative or positive infinity.
+ * Checks whether the current value of %Double is equal to the negative or positive infinity.
*
* @since 2.0
*
- * @return @c true if the current value equals negative or positive infinity, @n
+ * @return @c true if the current value equals the negative or positive infinity, @n
* else @c false
*/
bool IsInfinity(void) const;
/**
- * Checks whether the specified @c double value is equal to negative or positive infinity.
+ * Checks whether the specified @c double value is equal to the negative or positive infinity.
*
* @since 2.0
*
- * @return @c true if the specified value equals negative or positive infinity, @n
+ * @return @c true if the specified value equals the negative or positive infinity, @n
* else @c false
- * @param[in] value A @c double value to check
+ * @param[in] value The @c double value to check
*/
-
static bool IsInfinity(double value);
/**
*
* @return @c true if the specified value is Not-a-Number, @n
* else @c false
- * @param[in] value A @c double value to check
+ * @param[in] value The @c double value to check
*/
static bool IsNaN(double value);
/**
- * Gets a constant holding the largest positive finite value of type @c double. @n
+ * Gets the constant holding the largest positive finite value of type @c double. @n
* This is equal to the value defined in Limit.h of the C library.
*
* @since 2.0
*
- * @return A constant holding the largest positive finite value of type @c double
+ * @return The constant holding the largest positive finite value of type @c double
*/
static double GetMaxValue(void);
/**
- * Gets a constant holding the smallest positive non-zero value of type @c double. @n
+ * Gets the constant holding the smallest positive non-zero value of type @c double. @n
* This is equal to the value defined in Limit.h of the C library.
*
* @since 2.0
*
- * @return A constant holding the smallest possible non-zero value of type @c double
+ * @return The constant holding the smallest possible non-zero value of type @c double
*/
static double GetMinValue(void);
/**
- * A @c double value of this instance.
+ * The @c double value of this instance.
*
* @since 2.0
*/
double value;
-
private:
/**
* Checks if the specified @c double value is finite.
static const int __DBL_MAX_10_EXP = 308;
friend class _DoubleImpl;
- class _DoubleImpl * __pDoubleImpl;
+ class _DoubleImpl* __pDoubleImpl;
}; // Double
-
}} // Tizen::Base
-
#endif //_FBASE_DOUBLE_H_
projects / platform / framework / native / appfw.git / blobdiff