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 %Float class.
22 * @see Tizen::Base::Number
24 * This header file contains the declarations of the %Float class.
26 #ifndef _FBASE_FLOAT_H_
27 #define _FBASE_FLOAT_H_
29 #include <FBaseNumber.h>
32 namespace Tizen { namespace Base
36 * @brief This class is the wrapper class for the @c signed @c float built-in type.
40 * The %Float class represents a single-precision 32-bit floating number. The %Float class wraps a @c float type value. This enables
41 * passing a @c float value to a method that only accepts an instance of Object class. This class provides methods to compare instances
42 * of this type, convert the value of an instance to its string representation, and convert the string representation
43 * of a number to an instance of this type.
45 * The following example demonstrates how to use the %Float class.
51 * using namespace Tizen::Base;
53 * // This method checks whether the given string object contains the string
54 * // representation of the pre-defined minimum float value.
56 * MyClass::Verify(String& string, bool& out)
58 * // Creates and initializes an instance of Double
59 * static const Float MINIMUM(1.23L);
61 * result r = E_SUCCESS;
65 * // Parses the string representation of the numeric value
66 * // Returns f (value as signed float)
67 * r = Float::Parse(string, f);
75 * out = (MINIMUM.CompareTo(f) == 0) ? true: false;
82 class _OSP_EXPORT_ Float
87 * Initializes this instance of %Float with the specified value.
91 * @param[in] value A @c float value
93 Float(float value = 0.0);
97 * Copying of objects using this copy constructor is allowed.
101 * @param[in] value An instance of %Float
103 Float(const Float& value);
106 * This destructor overrides Tizen::Base::Object::~Object().
110 virtual ~Float(void);
113 * Copying of objects using this copy assignment operator is allowed.
117 * @param[in] rhs An instance of %Float
119 Float& operator =(const Float& rhs);
122 * Compares two @c float values.
126 * @return A 32-bit @c signed integer value
128 * < 0 if the value of @c f1 is less than the value of @c f2
129 * == 0 if the value of @c f1 is equal to the value of @c f2
130 * > 0 if the value of @c f1 is greater than the value of @c f2
132 * @param[in] f1 The first @c float value to compare
133 * @param[in] f2 The second @c float value to compare
135 static int Compare(float f1, float f2);
138 * Compares the value of the current instance with the value of the specified instance of the %Float class.
142 * @return A 32-bit @c signed integer value
144 * @li < 0 if the value of the current instance is less than the value of the specified instance
145 * @li == 0 if the value of the current instance is equal to the value of the specified instance
146 * @li > 0 if the value of the current instance is greater than the value of the specified instance
148 * @param[in] value An instance of the %Float class to compare
150 int CompareTo(const Float& value) const;
153 * Checks whether the value of the specified instance of Object is equal to the value of the current instance of %Float.
157 * @return @c true if the value of the specified instance of Object is equal to the value of the current instance of %Float, @n
159 * @param[in] obj An instance of Object to compare
160 * @see Tizen::Base::Object::Equals()
162 virtual bool Equals(const Object& obj) const;
166 * Gets the hash value of the current instance of %Float.
170 * @return An integer value indicating the hash value of the current instance of %Float
171 * @remarks Two equal instances must return the same hash value. For better performance,
172 * the used hash function must generate a random distribution for all inputs. @n
173 * The default implementation of this method returns the value of the current instance.
175 virtual int GetHashCode(void) const;
178 * Gets the hash value of the specified @c float value.
182 * @return An integer value indicating the hash value of the specified @c float value
183 * @param[in] val A @c float value to get the hash value
185 static int GetHashCode(float val);
188 * Parses the specified string representing a numeric value and returns the value as @c signed @c float (as out parameter).
192 * @return An error code
193 * @param[in] s A unicode string representing a @c signed @c float value
194 * @param[out] ret The numeric representation of the string
195 * @exception E_SUCCESS The method is successful.
196 * @exception E_NUM_FORMAT The specified string does not contain a number that can be parsed.
198 * - This method guarantees that the original value of out-parameter is not changed when the method returns error.
199 * - The behavior of this method is dependent on the system default locale setting.
200 * @see Tizen::Base::Double::Parse()
202 static result Parse(const String& s, float& ret);
205 * Gets the @c signed @c char equivalent of the current instance of the %Float class.
209 * @return A @c signed @c char equivalent of the current instance
211 virtual char ToChar(void) const;
214 * Gets the @c signed @c short equivalent of the current instance of the %Float class.
218 * @return A @c signed @c short equivalent of the current instance
220 virtual short ToShort(void) const;
223 * Gets the @c signed @c int equivalent of the current instance of the %Float class.
227 * @return A @c signed @c int equivalent of the current instance
229 virtual int ToInt(void) const;
232 * Gets the @c signed @c long equivalent of the current instance of the %Float class.
236 * @return A @c signed @c long equivalent of the current instance
238 virtual long ToLong(void) const;
241 * Gets the @c signed @c long @c long equivalent of the current instance of the %Float class.
245 * @return A @c signed @c long @c long equivalent of the current instance
247 virtual long long ToLongLong(void) const;
250 * Gets the @c signed @c float equivalent of the current instance of the %Float class.
254 * @return A @c signed @c float equivalent of the current instance
256 virtual float ToFloat(void) const;
259 * Gets the @c signed @c double equivalent of the current instance of the %Float class.
263 * @return A @c signed @c double equivalent of the current instance
265 virtual double ToDouble(void) const;
268 * Gets the string representing the value of the current instance of %Float.
272 * @return A string containing a Unicode representation of the value of the current instance
274 * - If the value is Not-a-Number (NaN), the result is the string "NaN". Furthermore, infinity
275 * produces the result "Infinity". @n
276 * 6 digits are given for the precision of this method. Use String::Format() to set the specific precision.
277 * - The behavior of this method is dependent on the system default locale setting.
279 virtual String ToString(void) const;
282 * Gets the string representing the specified @c float value.
286 * @return A string containing a Unicode representation of the specified @c float value
287 * @param[in] value A @c float value to convert
289 * - If the value is Not-a-Number (NaN), the result is the string "NaN". Furthermore, infinity
290 * produces the result "Infinity". @n
291 * 6 digits are given for the precision of this method. Use String::Format() to set the specific precision.
292 * - The behavior of this method is dependent on the system default locale setting.
294 static String ToString(float value);
297 * Gets the IEEE 754 floating-point "single format" bit layout representation of the specified @c float value.
301 * @return The bits that represent the floating-point number in the IEEE 754 floating-point "single format" bit layout
302 * @param[in] value A @c float value to convert
303 * @see Tizen::Base::Double::Parse()
305 static int ToBits(float value);
308 * Gets the @c float value corresponding to the specified floating-point value in the IEEE 754 floating-point "single format" bit layout.
312 * @return The @c float floating-point value with the same bit pattern
313 * @param[in] value A floating-point value in the IEEE 754 floating-point "single format" bit layout
314 * @see Tizen::Base::Double::Parse()
316 static float ToFloatFromBits(int value);
319 * Checks whether the current value of %Float is equal to negative or positive infinity.
323 * @return @c true if the current value equals negative or positive infinity, @n
326 bool IsInfinity(void) const;
329 * Checks whether the specified @c float value is equal to negative or positive infinity.
333 * @return @c true if the specified value equals negative or positive infinity, @n
335 * @param[in] value A @c float value to check
337 static bool IsInfinity(float value);
340 * Checks whether the current value is Not-a-Number.
344 * @return @c true if the current value is Not-a-Number, @n
347 bool IsNaN(void) const;
350 * Checks whether the specified value is Not-a-Number.
354 * @return @c true if the specified value is Not-a-Number, @n
356 * @param[in] value A @c float value to check
358 static bool IsNaN(float value);
361 * Gets a constant holding the largest positive finite value of type @c float. @n
362 * This is equal to the value defined in Limit.h of the C library.
366 * @return A constant holding the largest positive finite value of type @c float
368 static float GetMaxValue(void);
371 * Gets a constant holding the smallest positive non-zero value of type @c float. @n
372 * This is equal to the value defined in Limit.h of the C library.
376 * @return A constant holding the smallest possible non-zero value of type @c float
378 static float GetMinValue(void);
381 * A @c float value of this instance.
390 * Checks if the specified @c float value is finite.
394 * @return @c true if the specified value is finite, @n
396 * @param[in] value A @c float value to check
398 static bool IsFinite(float value);
400 static const int __DBL_MAX_10_EXP = 308;
402 friend class _FloatImpl;
403 class _FloatImpl * __pFloatImpl;
409 #endif //_FBASE_FLOAT_H_