2 // Open Service Platform
3 // Copyright (c) 2012 Samsung Electronics Co., Ltd.
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
9 // http://www.apache.org/licenses/LICENSE-2.0
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.
20 * @brief This is the header file for the %Double class.
22 * @see Tizen::Base::Number
24 * This header file contains the declarations of the %Double class.
26 #ifndef _FBASE_DOUBLE_H_
27 #define _FBASE_DOUBLE_H_
29 #include <FBaseNumber.h>
32 namespace Tizen { namespace Base
36 * @brief This class is the wrapper class for the @c signed @c double built-in type.
40 * The %Double class is the wrapper class for the @c signed @c double built-in type.
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).
48 * The following example demonstrates how to use the %Double class.
54 * using namespace Tizen::Base;
56 * // This method checks whether the given string object contains a string
57 * // representation of the pre-defined minimum double value.
59 * MyClass::Verify(const String& string, bool& out)
61 * static const Double MINIMUM(1.23L);
63 * result r = E_SUCCESS;
66 * r = Double::Parse(string, d);
72 * out = (MINIMUM.CompareTo(d) == 0) ? true: false;
80 class _OSP_EXPORT_ Double
85 * Initializes this instance of %Double with the specified value.
89 * @param[in] value A @c double value
91 Double(double value = 0.0L);
95 * Copying of objects using this copy constructor is allowed.
99 * @param[in] value An instance of %Double
101 Double(const Double& value);
104 * This destructor overrides Tizen::Base::Object::~Object().
108 virtual ~Double(void);
111 * Copying of objects using this copy assignment operator is allowed.
115 * @param[in] rhs An instance of %Double
117 Double& operator =(const Double& rhs);
120 * Compares two @c double values.
124 * @return A 32-bit @c signed integer value
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
130 * @param[in] d1 The first @c double value to compare
131 * @param[in] d2 The second @c double value to compare
133 static int Compare(double d1, double d2);
136 * Compares the value of the current instance of %Double with the value of the specified @c signed @c double.
140 * @return A 32-bit @c signed integer value
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
146 * @param[in] value A @c signed @c double value
148 int CompareTo(double value) const;
151 * Compares the value of the current instance of %Double with the value of the specified instance of %Double.
155 * @return A 32-bit @c signed integer value
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
161 * @param[in] value An instance of %Double
163 int CompareTo(const Double& value) const;
166 * Checks whether the value of the specified instance of Object is equal to the value of the current instance of %Double.
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
172 * @param[in] obj An instance of Object to compare
173 * @see Tizen::Base::Object::Equals
175 virtual bool Equals(const Object& obj) const;
178 * Gets the hash value of the current instance of %Double.
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.
187 virtual int GetHashCode(void) const;
190 * Gets the hash value of the specified @c double value.
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
197 static int GetHashCode(double val);
200 * Parses the specified string representing a numeric value and returns the value as @c signed @c double (as out parameter).
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.
210 static result Parse(const String& s, double& ret);
213 * Gets the @c signed @c char equivalent of the current instance of %Double.
217 * @return A @c signed @c char equivalent of the current instance
219 virtual char ToChar(void) const;
222 * Gets the @c signed @c short equivalent of the current instance of %Double.
226 * @return A @c signed @c short equivalent of the current instance
228 virtual short ToShort(void) const;
231 * Gets the @c signed @c int equivalent of the current instance of %Double.
235 * @return A @c signed @c int equivalent of the current instance
237 virtual int ToInt(void) const;
240 * Gets the @c signed @c long equivalent of the current instance of %Double.
244 * @return A @c signed @c long equivalent of the current instance
246 virtual long ToLong(void) const;
249 * Gets the @c signed @c long @c long equivalent of the current instance of %Double.
253 * @return A @c signed @c long @c long equivalent of the current instance
255 virtual long long ToLongLong(void) const;
258 * Gets the @c signed @c float equivalent of the current instance of %Double.
262 * @return A @c signed @c float equivalent of the current instance
264 virtual float ToFloat(void) const;
267 * Gets the @c signed @c double equivalent of the current instance of %Double.
271 * @return A @c signed @c double equivalent of the current instance
273 virtual double ToDouble(void) const;
276 * Gets the string representing the value of the current instance of %Double.
280 * @return A string containing a Unicode representation of the value of the current instance
281 * @remarks If the value of the current instance is Not-a-Number (NaN), the result is the string "NaN". Furthermore, infinity
282 * produces the result "Infinity". @n
283 * 6 digits are given for the precision of this method. Use String::Format() to set the specific precision.
285 virtual String ToString(void) const;
288 * Gets the string representing the specified @c double value.
292 * @return A string containing a Unicode representation of the specified @c double value
293 * @param[in] value A @c double value to convert
294 * @remarks If the input value is Not-a-Number (NaN), the result is the string "NaN". Furthermore, infinity
295 * produces the result "Infinity". @n
296 * 6 digits are given for the precision of this method. Use String::Format() to set the specific precision.
298 static String ToString(double value);
301 * Gets the IEEE 754 floating-point "double format" bit layout representation of the specified @c double value.
305 * @return The bits that represent the floating-point number in the IEEE 754 floating-point "double format" bit layout
306 * @param[in] value A @c double value to convert
308 static long long ToBits(double value);
311 * Gets the @c double value equivalent of the specified floating-point value represented in the IEEE 754 floating-point "double format" bit layout.
315 * @return The @c double floating-point value with the same bit pattern
316 * @param[in] value The floating-point value to convert
318 static double ToDoubleFromBits(long long value);
321 * Checks whether the current value of %Double is equal to negative or positive infinity.
325 * @return @c true if the current value equals negative or positive infinity, @n
328 bool IsInfinity(void) const;
331 * Checks whether the specified @c double value is equal to negative or positive infinity.
335 * @return @c true if the specified value equals negative or positive infinity, @n
337 * @param[in] value A @c double value to check
340 static bool IsInfinity(double value);
343 * Checks whether the current value is Not-a-Number.
347 * @return @c true if the current value is Not-a-Number, @n
350 bool IsNaN(void) const;
353 * Checks whether the specified value is Not-a-Number.
357 * @return @c true if the specified value is Not-a-Number, @n
359 * @param[in] value A @c double value to check
361 static bool IsNaN(double value);
364 * Gets a constant holding the largest positive finite value of type @c double. @n
365 * This is equal to the value defined in Limit.h of the C library.
369 * @return A constant holding the largest positive finite value of type @c double
371 static double GetMaxValue(void);
374 * Gets a constant holding the smallest positive non-zero value of type @c double. @n
375 * This is equal to the value defined in Limit.h of the C library.
379 * @return A constant holding the smallest possible non-zero value of type @c double
381 static double GetMinValue(void);
384 * A @c double value of this instance.
393 * Checks if the specified @c double value is finite.
397 * @return @c true if the specified value is finite, @n
399 * @param[in] value A @c double value to check
401 static bool IsFinite(double d);
403 static const int __DBL_MAX_10_EXP = 308;
405 friend class _DoubleImpl;
406 class _DoubleImpl * __pDoubleImpl;
412 #endif //_FBASE_DOUBLE_H_