Package net.sf.saxon.value

Class FloatValue

    • Field Detail

      • roundablePattern

        static java.util.regex.Pattern roundablePattern
        Regex indicating that a number may be worth rounding

    • Constructor Detail

      • FloatValue

        public FloatValue​(java.lang.CharSequence val)
           throws DynamicError
        Constructor supplying a string
        Throws:
        DynamicError

      • FloatValue

        public FloatValue​(float value)
        Constructor supplying a float
        Parameters:
        value - the value of the float

    • Method Detail

      • getFloatValue

        public float getFloatValue()
        Get the value

      • getDoubleValue

        public double getDoubleValue()
        Description copied from class: NumericValue
        Get the numeric value as a double
        Overrides:
        getDoubleValue in class NumericValue
        Returns:
        A double representing this numeric value; NaN if it cannot be converted

      • hashCode

        public int hashCode()
        Get the hashCode. This must conform to the rules for other NumericValue hashcodes
        Specified by:
        hashCode in class NumericValue
        Returns:
        the hash code of the numeric value
        See Also:
        NumericValue.hashCode()

      • isNaN

        public boolean isNaN()
        Test whether the value is the double/float value NaN
        Overrides:
        isNaN in class NumericValue

      • convertPrimitive

        public AtomicValue convertPrimitive​(BuiltInAtomicType requiredType,
                                    boolean validate,
                                    XPathContext context)
        Convert to target data type
        Specified by:
        convertPrimitive in class AtomicValue
        Parameters:
        requiredType - an integer identifying the required atomic type
        context -
        validate - true if validation is required. If set to false, the caller guarantees that the value is valid for the target data type, and that further validation is therefore not required. Note that a validation failure may be reported even if validation was not requested.
        Returns:
        an AtomicValue, a value of the required type; or an ErrorValue

      • floatToString

        static java.lang.CharSequence floatToString​(float value)
        Internal method used for conversion of a float to a string
        Parameters:
        value - the actual value
        Returns:
        the value converted to a string, according to the XPath casting rules.

      • floatToStringOLD

        static java.lang.CharSequence floatToStringOLD​(float value,
                                               java.lang.String javaString)
        Internal method used for conversion of a float to a string
        Parameters:
        value - the actual value
        javaString - the result of converting the float to a string using the Java conventions. This value is adjusted as necessary to cater for the differences between the Java and XPath rules.
        Returns:
        the value converted to a string, according to the XPath casting rules.

      • negate

        public NumericValue negate()
        Negate the value
        Specified by:
        negate in class NumericValue
        Returns:
        a value, of the same type as the original, with its sign inverted

      • floor

        public NumericValue floor()
        Implement the XPath floor() function
        Specified by:
        floor in class NumericValue
        Returns:
        a value, of the same type as that supplied, rounded towards minus infinity

      • ceiling

        public NumericValue ceiling()
        Implement the XPath ceiling() function
        Specified by:
        ceiling in class NumericValue
        Returns:
        a value, of the same type as that supplied, rounded towards plus infinity

      • round

        public NumericValue round()
        Implement the XPath round() function
        Specified by:
        round in class NumericValue
        Returns:
        a value, of the same type as that supplied, rounded towards the nearest whole number (0.5 rounded up)

      • roundHalfToEven

        public NumericValue roundHalfToEven​(int scale)
        Implement the XPath round-to-half-even() function
        Specified by:
        roundHalfToEven in class NumericValue
        Parameters:
        scale - the decimal position for rounding: e.g. 2 rounds to a multiple of 0.01, while -2 rounds to a multiple of 100
        Returns:
        a value, of the same type as the original, rounded towards the nearest multiple of 10**(-scale), with rounding towards the nearest even number if two values are equally near

      • signum

        public double signum()
        Determine whether the value is negative, zero, or positive
        Specified by:
        signum in class NumericValue
        Returns:
        -1 if negative, 0 if zero (including negative zero), +1 if positive, NaN if NaN

      • isWholeNumber

        public boolean isWholeNumber()
        Determine whether the value is a whole number, that is, whether it compares equal to some integer
        Specified by:
        isWholeNumber in class NumericValue
        Returns:
        true if the value is a whole number

      • arithmetic

        public NumericValue arithmetic​(int operator,
                               NumericValue other,
                               XPathContext context)
                        throws XPathException
        Evaluate a binary arithmetic operator.
        Specified by:
        arithmetic in class NumericValue
        Parameters:
        operator - the binary arithmetic operation to be performed. Uses the constants defined in the Tokenizer class
        other - the other operand
        Returns:
        the result of the arithmetic operation
        Throws:
        XPathException - if an arithmetic error occurs
        See Also:
        Tokenizer

      • compareTo

        public int compareTo​(java.lang.Object other)
        Description copied from class: NumericValue
        Compare the value to another numeric value
        Specified by:
        compareTo in interface java.lang.Comparable
        Overrides:
        compareTo in class NumericValue
        Parameters:
        other - The other numeric value
        Returns:
        -1 if this one is the lower, 0 if they are numerically equal, +1 if this one is the higher.

      • compareTo

        public int compareTo​(long other)
        Compare the value to a long
        Specified by:
        compareTo in class NumericValue
        Parameters:
        other - the value to be compared with
        Returns:
        -1 if this is less, 0 if this is equal, +1 if this is greater or if this is NaN