Package net.sf.saxon.value
Class FloatValue
java.lang.Object
net.sf.saxon.value.Value
net.sf.saxon.value.AtomicValue
net.sf.saxon.value.NumericValue
net.sf.saxon.value.FloatValue
- All Implemented Interfaces:
Serializable
,Comparable
,PullEvent
,SequenceIterable
,GroundedValue
,Item
,ValueRepresentation
,ConversionResult
A numeric (single precision floating point) value
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final FloatValue
static final FloatValue
static final FloatValue
static final FloatValue
Fields inherited from class net.sf.saxon.value.AtomicValue
typeLabel
Fields inherited from class net.sf.saxon.value.Value
EMPTY_CLASS_ARRAY, INDETERMINATE_ORDERING
Fields inherited from interface net.sf.saxon.om.ValueRepresentation
EMPTY_VALUE_ARRAY
-
Constructor Summary
ConstructorsConstructorDescriptionFloatValue
(float value) Constructor supplying a floatFloatValue
(float value, AtomicType type) Constructor supplying a float and an AtomicType, for creating a value that belongs to a user-defined subtype of xs:float.FloatValue
(CharSequence val) Constructor supplying a string -
Method Summary
Modifier and TypeMethodDescriptionceiling()
Implement the XPath ceiling() functionint
compareTo
(long other) Compare the value to a longint
Compare the value to another numeric valueconvertPrimitive
(BuiltInAtomicType requiredType, boolean validate, XPathContext context) Convert to target data typecopyAsSubType
(AtomicType typeLabel) Create a copy of this atomic value, with a different type labelboolean
Get the effective boolean valuefloor()
Implement the XPath floor() functionGet the canonical lexical representation as defined in XML Schema.double
Get the numeric value as a doublefloat
Get the valueDetermine the primitive type of the value.Get an object that implements XML Schema comparison semanticsGet the value as a StringGet the value as a Stringint
hashCode()
Get the hashCode.boolean
isNaN()
Test whether the value is the double/float value NaNboolean
Determine whether the value is a whole number, that is, whether it compares equal to some integernegate()
Negate the valueround()
Implement the XPath round() functionroundHalfToEven
(int scale) Implement the XPath round-to-half-even() functiondouble
signum()
Determine whether the value is negative, zero, or positiveMethods inherited from class net.sf.saxon.value.NumericValue
equals, getDecimalValue, getXPathComparable, isInteger, longValue, parseNumber, promote, toString
Methods inherited from class net.sf.saxon.value.AtomicValue
asAtomic, checkPermittedContents, convert, convert, getCardinality, getComponent, getItemType, getLength, getTypedValue, getTypeLabel, itemAt, iterate, process, setTypeLabel, subsequence
Methods inherited from class net.sf.saxon.value.Value
asItem, asItem, asIterator, asValue, convertToJava, fromItem, getIterator, iterate, makeQNameValue, reduce, stringToNumber
-
Field Details
-
ZERO
-
NEGATIVE_ZERO
-
ONE
-
NaN
-
-
Constructor Details
-
FloatValue
Constructor supplying a string- Throws:
ValidationException
-
FloatValue
public FloatValue(float value) Constructor supplying a float- Parameters:
value
- the value of the float
-
FloatValue
Constructor supplying a float and an AtomicType, for creating a value that belongs to a user-defined subtype of xs:float. It is the caller's responsibility to ensure that the supplied value conforms to the supplied type.- Parameters:
value
- the value of the NumericValuetype
- the type of the value. This must be a subtype of xs:float, and the value must conform to this type. The method does not check these conditions.
-
-
Method Details
-
copyAsSubType
Create a copy of this atomic value, with a different type label- Specified by:
copyAsSubType
in classAtomicValue
- Parameters:
typeLabel
- the type label of the new copy. The caller is responsible for checking that the value actually conforms to this type.- Returns:
- the copied value
-
getPrimitiveType
Determine the primitive type of the value. This delivers the same answer as getItemType().getPrimitiveItemType(). The primitive types are the 19 primitive types of XML Schema, plus xs:integer, xs:dayTimeDuration and xs:yearMonthDuration, and xs:untypedAtomic. For external objects, the result is AnyAtomicType.- Specified by:
getPrimitiveType
in classAtomicValue
- Returns:
- the primitive type
-
getFloatValue
public float getFloatValue()Get the value- Overrides:
getFloatValue
in classNumericValue
- Returns:
- a float representing this numeric value; NaN if it cannot be converted
-
getDoubleValue
public double getDoubleValue()Description copied from class:NumericValue
Get the numeric value as a double- Overrides:
getDoubleValue
in classNumericValue
- 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 classNumericValue
- Returns:
- the hash code of the numeric value
- See Also:
-
isNaN
public boolean isNaN()Test whether the value is the double/float value NaN- Overrides:
isNaN
in classAtomicValue
- Returns:
- true if the value is float NaN or double NaN; otherwise false
-
effectiveBooleanValue
public boolean effectiveBooleanValue()Get the effective boolean value- Overrides:
effectiveBooleanValue
in classAtomicValue
- Returns:
- true unless the value is zero or NaN
-
convertPrimitive
public ConversionResult convertPrimitive(BuiltInAtomicType requiredType, boolean validate, XPathContext context) Convert to target data type- Specified by:
convertPrimitive
in classAtomicValue
- Parameters:
requiredType
- an integer identifying the required atomic typecontext
- XPath dynamic context. Not used when converting from floatvalidate
- 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
-
getStringValue
Get the value as a String- Specified by:
getStringValue
in interfaceItem
- Specified by:
getStringValue
in interfaceValueRepresentation
- Specified by:
getStringValue
in classAtomicValue
- Returns:
- a String representation of the value
- See Also:
-
getStringValueCS
Get the value as a String- Specified by:
getStringValueCS
in interfaceItem
- Specified by:
getStringValueCS
in interfaceValueRepresentation
- Overrides:
getStringValueCS
in classAtomicValue
- Returns:
- a String representation of the value
- See Also:
-
getCanonicalLexicalRepresentation
Get the canonical lexical representation as defined in XML Schema. This is not always the same as the result of casting to a string according to the XPath rules. For xs:float, the canonical representation always uses exponential notation.- Overrides:
getCanonicalLexicalRepresentation
in classValue
- Returns:
- the canonical lexical representation if defined in XML Schema; otherwise, the result of casting to string according to the XPath 2.0 rules
-
negate
Negate the value- Specified by:
negate
in classNumericValue
- Returns:
- a value, of the same type as the original, with its sign inverted
-
floor
Implement the XPath floor() function- Specified by:
floor
in classNumericValue
- Returns:
- a value, of the same type as that supplied, rounded towards minus infinity
-
ceiling
Implement the XPath ceiling() function- Specified by:
ceiling
in classNumericValue
- Returns:
- a value, of the same type as that supplied, rounded towards plus infinity
-
round
Implement the XPath round() function- Specified by:
round
in classNumericValue
- Returns:
- a value, of the same type as that supplied, rounded towards the nearest whole number (0.5 rounded up)
-
roundHalfToEven
Implement the XPath round-to-half-even() function- Specified by:
roundHalfToEven
in classNumericValue
- 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 classNumericValue
- 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 classNumericValue
- Returns:
- true if the value is a whole number
-
compareTo
Description copied from class:NumericValue
Compare the value to another numeric value- Specified by:
compareTo
in interfaceComparable
- Overrides:
compareTo
in classNumericValue
- 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, or if either value is NaN. Where NaN values are involved, they should be handled by the caller before invoking this method.
-
compareTo
public int compareTo(long other) Compare the value to a long- Specified by:
compareTo
in classNumericValue
- 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
-
getSchemaComparable
Get an object that implements XML Schema comparison semantics- Specified by:
getSchemaComparable
in classAtomicValue
- Returns:
- a Comparable that follows XML Schema comparison rules
-