1 /****************************************************************************
3 ** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
4 ** All rights reserved.
5 ** Contact: Nokia Corporation (qt-info@nokia.com)
7 ** This file is part of the QtXmlPatterns module of the Qt Toolkit.
9 ** $QT_BEGIN_LICENSE:LGPL$
10 ** GNU Lesser General Public License Usage
11 ** This file may be used under the terms of the GNU Lesser General Public
12 ** License version 2.1 as published by the Free Software Foundation and
13 ** appearing in the file LICENSE.LGPL included in the packaging of this
14 ** file. Please review the following information to ensure the GNU Lesser
15 ** General Public License version 2.1 requirements will be met:
16 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
18 ** In addition, as a special exception, Nokia gives you certain additional
19 ** rights. These rights are described in the Nokia Qt LGPL Exception
20 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
22 ** GNU General Public License Usage
23 ** Alternatively, this file may be used under the terms of the GNU General
24 ** Public License version 3.0 as published by the Free Software Foundation
25 ** and appearing in the file LICENSE.GPL included in the packaging of this
26 ** file. Please review the following information to ensure the GNU General
27 ** Public License version 3.0 requirements will be met:
28 ** http://www.gnu.org/copyleft/gpl.html.
31 ** Alternatively, this file may be used in accordance with the terms and
32 ** 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_AbstractFloat_H
53 #define Patternist_AbstractFloat_H
59 #include "qcommonvalues_p.h"
60 #include "qdecimal_p.h"
61 #include "qschemanumeric_p.h"
62 #include "qvalidationerror_p.h"
63 #include "qbuiltintypes_p.h"
72 * @short Base template class for Float and Double classes.
74 * @author Vincent Ricard <magic@magicninja.org>
75 * @ingroup Patternist_xdm
77 template <const bool isDouble>
78 class AbstractFloat : public Numeric
81 static Numeric::Ptr fromValue(const xsDouble num);
82 static AtomicValue::Ptr fromLexical(const QString &strNumeric);
85 * @todo more extensive docs.
87 * Performs floating point comparison.
89 * @returns @c true if @p a and @p are equal, otherwise @c false.
91 static bool isEqual(const xsDouble a, const xsDouble b);
94 * Determines the Effective %Boolean Value of this number.
96 * @returns @c false if the number is 0 or @c NaN, otherwise @c true.
98 bool evaluateEBV(const QExplicitlySharedDataPointer<DynamicContext> &) const;
101 * Returns this AbstractFloat represented as an @c xs:string.
103 * @note In the XPath/XQuery languages, converting @c xs:double and @c xs:float
104 * to @c xs:string is not specified in XML Schema 1.0 Part 2: Datatypes Second Edition,
105 * but in XQuery 1.0 and XPath 2.0 Functions and Operators. This will change with W3C XML
108 * @see <a href="http://www.w3.org/TR/xpath-functions/#casting-to-string">XQuery 1.0
109 * and XPath 2.0 Functions and Operators, 17.1.2 Casting to xs:string and xdt:untypedAtomic</a>
111 virtual QString stringValue() const;
113 virtual xsDouble toDouble() const;
114 virtual xsInteger toInteger() const;
115 virtual xsFloat toFloat() const;
116 virtual xsDecimal toDecimal() const;
118 virtual Numeric::Ptr round() const;
119 virtual Numeric::Ptr roundHalfToEven(const xsInteger scale) const;
120 virtual Numeric::Ptr floor() const;
121 virtual Numeric::Ptr ceiling() const;
122 virtual Numeric::Ptr abs() const;
124 virtual bool isNaN() const;
125 virtual bool isInf() const;
127 virtual ItemType::Ptr type() const;
128 virtual Item toNegated() const;
129 virtual qulonglong toUnsignedInteger() const;
131 virtual bool isSigned() const;
133 AbstractFloat(const xsDouble num);
137 * From the Open Group's man page: "The signbit() macro shall return a
138 * non-zero value if and only if the sign of its argument value is
141 * MS Windows doesn't have std::signbit() so here's
142 * a reinvention of that function.
144 static inline int internalSignbit(const xsDouble v);
145 inline bool isZero() const;
147 const xsDouble m_value;
150 template <const bool isDouble>
151 Numeric::Ptr createFloat(const xsDouble num);
153 #include "qabstractfloat.cpp"
156 * @short An instantiation of AbsbstractFloat suitable for @c xs:double.
158 * @ingroup Patternist_xdm
160 typedef AbstractFloat<true> Double;
163 * @short An instantiation of AbstractFloat suitable for @c xs:float.
165 * @ingroup Patternist_xdm
167 typedef AbstractFloat<false> Float;