inc/FBaseDouble.h

   1 //
   2 // Open Service Platform
   3 // Copyright (c) 2012 Samsung Electronics Co., Ltd.
   4 //
   5 // Licensed under the Apache License, Version 2.0 (the License);
   6 // you may not use this file except in compliance with the License.
   7 // You may obtain a copy of the License at
   8 //
   9 //     http://www.apache.org/licenses/LICENSE-2.0
  10 //
  11 // Unless required by applicable law or agreed to in writing, software
  12 // distributed under the License is distributed on an "AS IS" BASIS,
  13 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14 // See the License for the specific language governing permissions and
  15 // limitations under the License.
  16 //
  17
  18 /**
  19  * @file                FBaseDouble.h
  20  * @brief               This is the header file for the %Double class.
  21  *
  22  * @see                 Tizen::Base::Number
  23  *
  24  * This header file contains the declarations of the %Double class.
  25  */
  26 #ifndef _FBASE_DOUBLE_H_
  27 #define _FBASE_DOUBLE_H_
  28
  29 #include <FBaseNumber.h>
  30
  31
  32 namespace Tizen { namespace Base
  33 {
  34 /**
  35  *      @class  Double
  36  *      @brief  This class is the wrapper class for the @c signed @c double built-in type.
  37  *
  38  *      @since 2.0
  39  *
  40  *  The %Double class is the wrapper class for the @c signed @c double built-in type.
  41  *
  42  *      It represents a double-precision 64-bit number with values ranging from negative
  43  *      1.79769313486232e308 to positive 1.79769313486232e308. This class is useful when passing a @c double
  44  *      value to a method expecting an instance of Object, such as Tizen::Base::Collection::Queue or
  45  *      Tizen::Base::Collection::Stack. Furthermore, this class provides methods for converting
  46  *      %Double (and @c double) to String, and String to %Double (and @c double).
  47  *
  48  *  The following example demonstrates how to use the %Double class.
  49  *
  50  *      @code
  51  *
  52  *      #include <FBase.h>
  53  *
  54  *      using namespace Tizen::Base;
  55  *
  56  *      // This method checks whether the given string object contains a string
  57  *      // representation of the pre-defined minimum double value.
  58  *      result
  59  *      MyClass::Verify(const String& string, bool& out)
  60  *      {
  61  *              static const Double MINIMUM(1.23L);
  62  *
  63  *              result r = E_SUCCESS;
  64  *
  65  *              double d;
  66  *              r = Double::Parse(string, d);
  67  *              if (IsFailed(r))
  68  *              {
  69  *                      goto CATCH;
  70  *              }
  71  *
  72  *              out = (MINIMUM.CompareTo(d) == 0) ? true: false;
  73  *
  74  *              return r;
  75  *      CATCH:
  76  *              return r;
  77  *      }
  78  *      @endcode
  79  */
  80 class _OSP_EXPORT_ Double
  81         : public Number
  82 {
  83 public:
  84         /**
  85          * Initializes this instance of %Double with the specified value.
  86          *
  87          * @since 2.0
  88          *
  89          * @param[in]   value   A @c double value
  90          */
  91         Double(double value = 0.0L);
  92
  93
  94         /**
  95          * Copying of objects using this copy constructor is allowed.
  96          *
  97          * @since 2.0
  98          *
  99          * @param[in]   value   An instance of %Double
 100          */
 101         Double(const Double& value);
 102
 103         /**
 104          * This destructor overrides Tizen::Base::Object::~Object().
 105          *
 106          * @since 2.0
 107          */
 108         virtual ~Double(void);
 109
 110         /**
 111          * Copying of objects using this copy assignment operator is allowed.
 112          *
 113          * @since 2.0
 114          *
 115          * @param[in]   rhs     An instance of %Double
 116          */
 117         Double& operator =(const Double& rhs);
 118
 119         /**
 120          * Compares two @c double values.
 121          *
 122          * @since 2.0
 123          *
 124          * @return              A 32-bit @c signed integer value
 125          * @code
 126          * <  0  if the value of @c d1 is less than the value of @c d2
 127          * == 0  if the value of @c d1 is equal to the value of @c d2
 128          * >  0  if the value of @c d1 is greater than the value of @c d2
 129          * @endcode
 130          * @param[in]   d1      The first @c double value to compare
 131          * @param[in]   d2      The second @c double value to compare
 132          */
 133         static int Compare(double d1, double d2);
 134
 135         /**
 136          * Compares the value of the current instance of %Double with the value of the specified @c signed @c double.
 137          *
 138          * @since 2.0
 139          *
 140          * @return              A 32-bit @c signed integer value
 141          * @code
 142          * <  0  if the value of the current instance is less than the specified @c signed @c double
 143          * == 0  if the value of the current instance is equal to the specified @c signed @c double
 144          * >  0  if the value of the current instance is greater than the specified @c signed @c double
 145          * @endcode
 146          * @param[in]   value   A @c signed @c double value
 147          */
 148         int CompareTo(double value) const;
 149
 150         /**
 151          * Compares the value of the current instance of %Double with the value of the specified instance of %Double.
 152          *
 153          * @since 2.0
 154          *
 155          * @return              A 32-bit @c signed integer value
 156          * @code
 157          * <  0  if the value of the current instance is less than the value of the specified instance
 158          * == 0  if the value of the current instance is equal to the value of the specified instance
 159          * >  0  if the value of the current instance is greater than the value of the specified instance
 160          * @endcode
 161          * @param[in]   value   An instance of %Double
 162          */
 163         int CompareTo(const Double& value) const;
 164
 165         /**
 166          * Checks whether the value of the specified instance of Object is equal to the value of the current instance of %Double.
 167          *
 168          * @since 2.0
 169          *
 170          * @return              @c true if the value of the specified instance of %Object is equal to the value of the current instance of %Double, @n
 171          *                              else @c false
 172          * @param[in]   obj An instance of Object to compare
 173          * @see                 Tizen::Base::Object::Equals
 174          */
 175         virtual bool Equals(const Object& obj) const;
 176
 177         /**
 178          *      Gets the hash value of the current instance of %Double.
 179          *
 180          *      @since 2.0
 181          *
 182          *      @return         An integer value indicating the hash value of the current instance of %Double
 183          *      @remarks        Two equal instances must return the same hash value. For better performance,
 184          *                              the used hash function must generate a random distribution for all inputs. @n
 185          *                              The default implementation of this method returns the value of the current instance.
 186          */
 187         virtual int GetHashCode(void) const;
 188
 189         /**
 190         *        Gets the hash value of the specified @c double value.
 191         *
 192         *        @since 2.0
 193         *
 194         *        @return        An integer value indicating the hash value of the specified @c double value
 195         *        @param[in]   val   A @c double value to get the hash value
 196         */
 197         static int GetHashCode(double val);
 198
 199         /**
 200          * Parses the specified string representing a numeric value and returns the value as @c signed @c double (as out parameter).
 201          *
 202          * @since 2.0
 203          *
 204          * @return              An error code
 205          * @param[in]   s                               A unicode representation of @c signed @c double value
 206          * @param[out]  ret                     The converted numeric value
 207          * @exception   E_SUCCESS               The method is successful.
 208          * @exception   E_NUM_FORMAT    The specified string does not contain a number that can be parsed.
 209          * @remarks             This method guarantees that the original value of out-parameter is not changed when the method returns error.
 210          * @remarks             The behavior of this method is dependent on the system default locale setting.
 211          */
 212         static result Parse(const String& s, double& ret);
 213
 214         /**
 215          * Gets the @c signed @c char equivalent of the current instance of %Double.
 216          *
 217          * @since 2.0
 218          *
 219          * @return      A @c signed @c char equivalent of the current instance
 220          */
 221         virtual char ToChar(void) const;
 222
 223         /**
 224          * Gets the @c signed @c short equivalent of the current instance of %Double.
 225          *
 226          * @since 2.0
 227          *
 228          * @return      A @c signed @c short equivalent of the current instance
 229          */
 230         virtual short ToShort(void) const;
 231
 232         /**
 233          * Gets the @c signed @c int equivalent of the current instance of %Double.
 234          *
 235          * @since 2.0
 236          *
 237          * @return      A @c signed @c int equivalent of the current instance
 238          */
 239         virtual int ToInt(void) const;
 240
 241         /**
 242          * Gets the @c signed @c long equivalent of the current instance of %Double.
 243          *
 244          * @since 2.0
 245          *
 246          * @return      A @c signed @c long equivalent of the current instance
 247          */
 248         virtual long ToLong(void) const;
 249
 250         /**
 251          * Gets the @c signed @c long @c long equivalent of the current instance of %Double.
 252          *
 253          * @since 2.0
 254          *
 255          * @return      A @c signed @c long @c long equivalent of the current instance
 256          */
 257         virtual long long ToLongLong(void) const;
 258
 259         /**
 260          * Gets the @c signed @c float equivalent of the current instance of %Double.
 261          *
 262          * @since 2.0
 263          *
 264          * @return      A @c signed @c float equivalent of the current instance
 265          */
 266         virtual float ToFloat(void) const;
 267
 268         /**
 269          * Gets the @c signed @c double equivalent of the current instance of %Double.
 270          *
 271          * @since 2.0
 272          *
 273          * @return      A @c signed @c double equivalent of the current instance
 274          */
 275         virtual double ToDouble(void) const;
 276
 277         /**
 278          * Gets the string representing the value of the current instance of %Double.
 279          *
 280          * @since 2.0
 281          *
 282          * @return              A string containing a Unicode representation of the value of the current instance
 283          * @remarks             If the value of the current instance is Not-a-Number (NaN), the result is the string "NaN". Furthermore, infinity
 284          *                              produces the result "Infinity". @n
 285          *                              6 digits are given for the precision of this method. Use String::Format() to set the specific precision.
 286          * @remarks             The behavior of this method is dependent on the system default locale setting.
 287          */
 288         virtual String ToString(void) const;
 289
 290         /**
 291          * Gets the string representing the specified @c double value.
 292          *
 293          * @since 2.0
 294          *
 295          * @return              A string containing a Unicode representation of the specified @c double value
 296          * @param[in]   value A @c double value to convert
 297          * @remarks             If the input value is Not-a-Number (NaN), the result is the string "NaN". Furthermore, infinity
 298          *                              produces the result "Infinity". @n
 299          *                              6 digits are given for the precision of this method. Use String::Format() to set the specific precision.
 300          * @remarks             The behavior of this method is dependent on the system default locale setting.
 301          */
 302         static String ToString(double value);
 303
 304         /**
 305          * Gets the IEEE 754 floating-point "double format" bit layout representation of the specified @c double value.
 306          *
 307          * @since 2.0
 308          *
 309          * @return              The bits that represent the floating-point number in the IEEE 754 floating-point "double format" bit layout
 310          * @param[in]   value   A @c double value to convert
 311          */
 312         static long long ToBits(double value);
 313
 314         /**
 315          * Gets the @c double value equivalent of the specified floating-point value represented in the IEEE 754 floating-point "double format" bit layout.
 316          *
 317          * @since 2.0
 318          *
 319          * @return              The @c double floating-point value with the same bit pattern
 320          * @param[in]   value   The floating-point value to convert
 321          */
 322         static double ToDoubleFromBits(long long value);
 323
 324         /**
 325          * Checks whether the current value of %Double is equal to negative or positive infinity.
 326          *
 327          * @since 2.0
 328          *
 329          * @return              @c true if the current value equals negative or positive infinity, @n
 330          *                              else @c false
 331          */
 332         bool IsInfinity(void) const;
 333
 334         /**
 335          * Checks whether the specified @c double value is equal to negative or positive infinity.
 336          *
 337          * @since 2.0
 338          *
 339          * @return              @c true if the specified value equals negative or positive infinity, @n
 340          *                              else @c false
 341          * @param[in]   value   A @c double value to check
 342          */
 343
 344         static bool IsInfinity(double value);
 345
 346         /**
 347          * Checks whether the current value is Not-a-Number.
 348          *
 349          * @since 2.0
 350          *
 351          * @return              @c true if the current value is Not-a-Number, @n
 352          *                              else @c false
 353          */
 354         bool IsNaN(void) const;
 355
 356         /**
 357          * Checks whether the specified value is Not-a-Number.
 358          *
 359          * @since 2.0
 360          *
 361          * @return              @c true if the specified value is Not-a-Number, @n
 362          *                              else @c false
 363          * @param[in]   value   A @c double value to check
 364          */
 365         static bool IsNaN(double value);
 366
 367         /**
 368          * Gets a constant holding the largest positive finite value of type @c double. @n
 369          * This is equal to the value defined in Limit.h of the C library.
 370          *
 371          * @since 2.0
 372          *
 373          * @return              A constant holding the largest positive finite value of type @c double
 374          */
 375         static double GetMaxValue(void);
 376
 377         /**
 378          * Gets a constant holding the smallest positive non-zero value of type @c double. @n
 379          * This is equal to the value defined in Limit.h of the C library.
 380          *
 381          * @since 2.0
 382          *
 383          * @return              A constant holding the smallest possible non-zero value of type @c double
 384          */
 385         static double GetMinValue(void);
 386
 387         /**
 388          * A @c double value of this instance.
 389          *
 390          * @since 2.0
 391          */
 392         double value;
 393
 394
 395 private:
 396         /**
 397          *      Checks if the specified @c double value is finite.
 398          *
 399          *      @since 2.0
 400          *
 401          *      @return         @c true if the specified value is finite, @n
 402          *                              else @c false
 403          *      @param[in]      value   A @c double value to check
 404          */
 405         static bool IsFinite(double d);
 406
 407         static const int __DBL_MAX_10_EXP = 308;
 408
 409         friend class _DoubleImpl;
 410         class _DoubleImpl * __pDoubleImpl;
 411
 412 }; // Double
 413
 414 }} // Tizen::Base
 415
 416 #endif //_FBASE_DOUBLE_H_