2 // Copyright (c) 2012 Samsung Electronics Co., Ltd.
4 // Licensed under the Apache License, Version 2.0 (the License);
5 // you may not use this file except in compliance with the License.
6 // You may obtain a copy of the License at
8 // http://www.apache.org/licenses/LICENSE-2.0
10 // Unless required by applicable law or agreed to in writing, software
11 // distributed under the License is distributed on an "AS IS" BASIS,
12 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 // See the License for the specific language governing permissions and
14 // limitations under the License.
19 * @brief This is the header file for the %Float class.
21 * This header file contains the declarations of the %Float class.
23 * @see Tizen::Base::Number
25 #ifndef _FBASE_FLOAT_H_
26 #define _FBASE_FLOAT_H_
28 #include <FBaseNumber.h>
30 namespace Tizen { namespace Base
34 * @brief This class is the wrapper class for the @c signed @c float built-in type.
38 * The %Float class represents a single-precision 32-bit floating number. The %Float class wraps a @c float type value. This enables
39 * passing a @c float value to a method that only accepts an instance of Object class. This class provides methods to compare instances
40 * of this type, convert the value of an instance to its string representation, and convert the string representation
41 * of a number to an instance of this type.
43 * The following example demonstrates how to use the %Float class.
49 * using namespace Tizen::Base;
51 * // This method checks whether the given string object contains the string
52 * // representation of the pre-defined minimum float value.
54 * MyClass::Verify(String& string, bool& out)
56 * // Creates and initializes an instance of Double
57 * static const Float MINIMUM(1.23L);
59 * result r = E_SUCCESS;
63 * // Parses the string representation of the numeric value
64 * // Returns f (value as signed float)
65 * r = Float::Parse(string, f);
73 * out = (MINIMUM.CompareTo(f) == 0) ? true: false;
80 class _OSP_EXPORT_ Float
85 * Initializes this instance of %Float with the specified value.
89 * @param[in] value The @c float value
91 Float(float value = 0.0);
95 * Copying of objects using this copy constructor is allowed.
99 * @param[in] value An instance of %Float to copy
101 Float(const Float& value);
104 * This destructor overrides Tizen::Base::Object::~Object().
108 virtual ~Float(void);
111 * Copying of objects using this copy assignment operator is allowed.
115 * @param[in] rhs An instance of %Float to copy
117 Float& operator =(const Float& rhs);
120 * Compares two @c float values.
124 * @return The 32-bit @c signed integer value
126 * < 0 if the value of f1 is less than the value of f2
127 * == 0 if the value of f1 is equal to the value of f2
128 * > 0 if the value of f1 is greater than the value of f2
130 * @param[in] f1 The first @c float value to compare
131 * @param[in] f2 The second @c float value to compare
133 static int Compare(float f1, float f2);
136 * Compares the value of the current instance with the value of the specified instance of %Float.
140 * @return The 32-bit @c signed integer value
142 * @li < 0 if the value of the current instance is less than the value of the specified instance
143 * @li == 0 if the value of the current instance is equal to the value of the specified instance
144 * @li > 0 if the value of the current instance is greater than the value of the specified instance
146 * @param[in] value An instance of the %Float class to compare
148 int CompareTo(const Float& value) const;
151 * Checks whether the value of the specified instance of Object is equal to the value of the current instance of %Float.
155 * @return @c true if the value of the specified instance of :Object is equal to the value of the current instance of %Float, @n
157 * @param[in] obj An instance of Object to compare
158 * @see Tizen::Base::Object::Equals()
160 virtual bool Equals(const Object& obj) const;
164 * Gets the hash value of the current instance of %Float.
168 * @return The integer value that indicates the hash value of the current instance of %Float
170 * - Two equal instances must return the same hash value. @n
171 * For better performance, the used hash function must generate a random distribution for all the inputs. @n
172 * - The default implementation of this method returns the value of the current instance.
174 virtual int GetHashCode(void) const;
177 * Gets the hash value of the specified @c float value.
181 * @return The integer value that indicates the hash value of the specified @c float value
182 * @param[in] val The @c float value used to get the hash value
184 static int GetHashCode(float val);
187 * Parses the specified string that represents a numeric value and returns the value as @c signed @c float (as out parameter).
191 * @return An error code
192 * @param[in] s The unicode string that represents the @c signed @c float value
193 * @param[out] ret The numeric representation of the string
194 * @exception E_SUCCESS The method is successful.
195 * @exception E_NUM_FORMAT The specified string does not contain a number that can be parsed.
197 * - This method guarantees that the original value of the out-parameter is not changed when the method returns an error.
198 * - The behavior of this method is dependent on the system default locale setting.
199 * @see Tizen::Base::Double::Parse()
201 static result Parse(const String& s, float& ret);
204 * Gets the @c signed @c char equivalent of the current instance of %Float.
208 * @return The @c signed @c char equivalent of the current instance
210 virtual char ToChar(void) const;
213 * Gets the @c signed @c short equivalent of the current instance of %Float.
217 * @return The @c signed @c short equivalent of the current instance
219 virtual short ToShort(void) const;
222 * Gets the @c signed @c int equivalent of the current instance of %Float.
226 * @return The @c signed @c int equivalent of the current instance
228 virtual int ToInt(void) const;
231 * Gets the @c signed @c long equivalent of the current instance of %Float.
235 * @return The @c signed @c long equivalent of the current instance
237 virtual long ToLong(void) const;
240 * Gets the @c signed @c long @c long equivalent of the current instance of %Float
244 * @return The @c signed @c long @c long equivalent of the current instance
246 virtual long long ToLongLong(void) const;
249 * Gets the @c signed @c float equivalent of the current instance of %Float.
253 * @return The @c signed @c float equivalent of the current instance
255 virtual float ToFloat(void) const;
258 * Gets the @c signed @c double equivalent of the current instance of %Float.
262 * @return The @c signed @c double equivalent of the current instance
264 virtual double ToDouble(void) const;
267 * Gets the string that represents the value of the current instance of %Float.
271 * @return The string that contains the Unicode representation of the value of the current instance
273 * - If the value is Not-a-Number (NaN), the result is the string "NaN". Furthermore, infinity
274 * produces the result "Infinity". @n
275 * 6 digits are given for the precision of this method. Use String::Format() to set a specific precision.
276 * - The behavior of this method is dependent on the system default locale setting.
278 virtual String ToString(void) const;
281 * Gets the string that represents the specified @c float value.
285 * @return The string that contains the Unicode representation of the specified @c float value
286 * @param[in] value The @c float value to convert
288 * - If the value is Not-a-Number (NaN), the result is the string "NaN". Furthermore, infinity
289 * produces the result "Infinity". @n
290 * 6 digits are given for the precision of this method. Use String::Format() to set a specific precision.
291 * - The behavior of this method is dependent on the system default locale setting.
293 static String ToString(float value);
296 * Gets the IEEE 754 floating-point "single format" bit layout representation of the specified @c float value.
300 * @return The bits that represent the floating-point number in the IEEE 754 floating-point "single format" bit layout
301 * @param[in] value The @c float value to convert
302 * @see Tizen::Base::Double::Parse()
304 static int ToBits(float value);
307 * Gets the @c float value corresponding to the specified floating-point value in the IEEE 754 floating-point "single format" bit layout.
311 * @return The @c float floating-point value with the same bit pattern
312 * @param[in] value The floating-point value in the IEEE 754 floating-point "single format" bit layout
313 * @see Tizen::Base::Double::Parse()
315 static float ToFloatFromBits(int value);
318 * Checks whether the current value of %Float is equal to the negative or positive infinity.
322 * @return @c true if the current value equals the negative or positive infinity, @n
325 bool IsInfinity(void) const;
328 * Checks whether the specified @c float value is equal to the negative or positive infinity.
332 * @return @c true if the specified value equals the negative or positive infinity, @n
334 * @param[in] value The @c float value to check
336 static bool IsInfinity(float value);
339 * Checks whether the current value is Not-a-Number.
343 * @return @c true if the current value is Not-a-Number, @n
346 bool IsNaN(void) const;
349 * Checks whether the specified value is Not-a-Number.
353 * @return @c true if the specified value is Not-a-Number, @n
355 * @param[in] value The @c float value to check
357 static bool IsNaN(float value);
360 * Gets the constant holding the largest positive finite value of type @c float. @n
361 * This is equal to the value defined in Limit.h of the C library.
365 * @return The constant holding the largest positive finite value of type @c float
367 static float GetMaxValue(void);
370 * Gets the constant holding the smallest positive non-zero value of type @c float. @n
371 * This is equal to the value defined in Limit.h of the C library.
375 * @return The constant holding the smallest possible non-zero value of type @c float
377 static float GetMinValue(void);
380 * The @c float value of this instance.
389 * Checks if the specified @c float value is finite.
393 * @return @c true if the specified value is finite, @n
395 * @param[in] value A @c float value to check
397 static bool IsFinite(float value);
399 static const int __DBL_MAX_10_EXP = 308;
401 friend class _FloatImpl;
402 class _FloatImpl* __pFloatImpl;
408 #endif //_FBASE_FLOAT_H_