1 /****************************************************************************
3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
4 ** Contact: http://www.qt-project.org/
6 ** This file is part of the QtXmlPatterns module of the Qt Toolkit.
8 ** $QT_BEGIN_LICENSE:LGPL$
9 ** GNU Lesser General Public License Usage
10 ** This file may be used under the terms of the GNU Lesser General Public
11 ** License version 2.1 as published by the Free Software Foundation and
12 ** appearing in the file LICENSE.LGPL included in the packaging of this
13 ** file. Please review the following information to ensure the GNU Lesser
14 ** General Public License version 2.1 requirements will be met:
15 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
17 ** In addition, as a special exception, Nokia gives you certain additional
18 ** rights. These rights are described in the Nokia Qt LGPL Exception
19 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
21 ** GNU General Public License Usage
22 ** Alternatively, this file may be used under the terms of the GNU General
23 ** Public License version 3.0 as published by the Free Software Foundation
24 ** and appearing in the file LICENSE.GPL included in the packaging of this
25 ** file. Please review the following information to ensure the GNU General
26 ** Public License version 3.0 requirements will be met:
27 ** http://www.gnu.org/copyleft/gpl.html.
30 ** Alternatively, this file may be used in accordance with the terms and
31 ** conditions contained in a signed written agreement between you and Nokia.
40 ****************************************************************************/
46 // This file is not part of the Qt API. It exists purely as an
47 // implementation detail. This header file may change from version to
48 // version without notice, or even be removed.
52 #ifndef Patternist_Numeric_H
53 #define Patternist_Numeric_H
55 #include <private/qitem_p.h>
56 #include <private/qprimitives_p.h>
64 * @short Contains class Numeric. This file was originally called qnumeric_p.h,
65 * but various build systems cannot handle that that name happens to be
66 * identical to another one, the one in QtCore.
72 * @short Base class for all numeric values.
74 * @section creation Creating Instances
77 * - Depending on what type of val
78 * - Numeric::createFromString
79 * - Various classes has ::Zero(), ::PosINF(), ::NaN(), NegINF()
80 * - Never use constructor, use createFromNative, or createFromString.
82 * @see <a href="http://www.w3.org/TR/xquery-operators/#numeric-functions">XQuery 1.0
83 * and XPath 2.0 Functions and Operators, 6 Functions and Operators on Numerics</a>
84 * @see <a href="http://www.w3.org/TR/xquery-operators/#func-overloading">XQuery 1.0
85 * and XPath 2.0 Functions and Operators, 1.2 Function Overloading</a>
86 * @author Frans Englich <frans.englich@nokia.com>
87 * @ingroup Patternist_xdm
88 * @todo discuss data hierarchy the non existatnt number data type
90 class Numeric : public AtomicValue
94 typedef QExplicitlySharedDataPointer<Numeric> Ptr;
97 * Creates a Numeric sub-class that is appropriate for @p number.
99 * @note usages of e/E is not handled; Double::fromLexical should
100 * be used in that case. There is no function similar to fromLexical that also
101 * takes double values into account(because that distinction is done in the scanner).
103 * Currently used in the parser to create appropriate expressions.
105 static AtomicValue::Ptr fromLexical(const QString &number);
108 * @returns the particular number's value as a native representation of
109 * the type xs:double. This can be considered that the value is cast to
112 virtual xsDouble toDouble() const = 0;
115 * @returns the particular number's value as a native representation of
116 * the type xs:integer. This can be considered that the value is cast to
119 virtual xsInteger toInteger() const = 0;
122 * @returns the number as an unsigned integer. If the value is not
123 * unsigned, the code asserts and behavior is undefined.
125 virtual qulonglong toUnsignedInteger() const = 0;
128 * @returns the particular number's value as a native representation of
129 * the type xs:float. This can be considered that the value is cast to
132 virtual xsFloat toFloat() const = 0;
135 * @returns the particular number's value as a native representation of
136 * the type xs:decimal. This can be considered that the value is cast to
139 virtual xsFloat toDecimal() const = 0;
142 * Performs the algorithm specified for the function fn:round on this Numeric,
143 * and whose result is returned.
145 * @see <a href="http://www.w3.org/TR/xpath-functions/#func-round">XQuery 1.0
146 * and XPath 2.0 Functions and Operators, 6.4.4 fn:round</a>
148 virtual Numeric::Ptr round() const = 0;
151 * Performs rounding as defined for the fn:round-half-to-even on this Numeric,
152 * and whose result is returned.
154 * @see <a href="http://www.w3.org/TR/xpath-functions/#func-round-half-to-even">XQuery 1.0
155 * and XPath 2.0 Functions and Operators, 6.4.5 fn:round-half-to-even</a>
157 virtual Numeric::Ptr roundHalfToEven(const xsInteger scale) const = 0;
160 * Performs the algorithm specified for the function fn:floor on this Numeric,
161 * and whose result is returned.
163 * @see <a href="http://www.w3.org/TR/xpath-functions/#func-floor">XQuery 1.0
164 * and XPath 2.0 Functions and Operators, 6.4.3 fn:floor</a>
166 virtual Numeric::Ptr floor() const = 0;
169 * Performs the algorithm specified for the function fn:ceiling on this Numeric,
170 * and whose result is returned.
172 * @see <a href="http://www.w3.org/TR/xpath-functions/#func-ceiling">XQuery 1.0
173 * and XPath 2.0 Functions and Operators, 6.4.2 fn:ceiling</a>
175 virtual Numeric::Ptr ceiling() const = 0;
178 * Performs the algorithm specified for the function fn:abs on this Numeric,
179 * and whose result is returned.
181 * @see <a href="http://www.w3.org/TR/xpath-functions/#func-ceiling">XQuery 1.0
182 * and XPath 2.0 Functions and Operators, 6.4.1 fn:abs</a>
184 virtual Numeric::Ptr abs() const = 0;
187 * Determines whether this Numeric is not-a-number, @c NaN. For numeric types
188 * that cannot represent @c NaN, this function should return @c false.
190 * @returns @c true if this Numeric is @c NaN
192 virtual bool isNaN() const = 0;
195 * Determines whether this Numeric is an infinite number. Signedness
196 * is irrelevant, -INF as well as INF is considered infinity.
198 * For numeric types that cannot represent infinity, such as xs:integer
199 * , this function should return @c false.
201 * @returns @c true if this Numeric is an infinite number
203 virtual bool isInf() const = 0;
208 virtual Item toNegated() const = 0;
211 * @short Returns @c true if this value is signed. If @c false is
212 * returned, the value is unsigned.
214 * For float and decimal values, @c xs:double, @c xs:float and @c
215 * xs:decimal, the code asserts and behavior is undefined.
217 virtual bool isSigned() const = 0;
221 * @short Implements @c fn:round() for types implemented with floating
224 * MS Windows and at least IRIX does not have C99's nearbyint() function(see the man
225 * page), so we reinvent it.
227 static xsDouble roundFloat(const xsDouble val);