Package convex.core.data.prim

Class CVMDouble

java.lang.Object

convex.core.data.AObject

convex.core.data.ACell

convex.core.data.prim.APrimitive

convex.core.data.prim.ANumeric

convex.core.data.prim.CVMDouble

All Implemented Interfaces:

IValidated, IWriteable, Comparable<ANumeric>

public final class CVMDouble
extends ANumeric

Class for CVM double floating-point values. Follows the Java standard / IEEE 784 spec.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	MAX_ENCODING_LENGTH
static final CVMDouble	MINUS_ONE
static final CVMDouble	NaN
static final CVMDouble	NEGATIVE_INFINITY
static final CVMDouble	NEGATIVE_ZERO
static final CVMDouble	ONE
static final CVMDouble	POSITIVE_INFINITY
static final CVMDouble	ZERO

Fields inherited from class convex.core.data.ACell

cachedRef, memorySize

Fields inherited from class convex.core.data.AObject

encoding

Method Summary

Modifier and Type	Method	Description
ANumeric	abs()	Gets the absolute value of this number.
ANumeric	add(ANumeric b)	Adds a second numeric value to this value
int	compareTo(ANumeric o)
static CVMDouble	create(double value)	Creates a CVMDouble.
double	doubleValue()
int	encode(byte[] bs, int pos)	Writes this Cell's encoding to a byte array, including a tag byte which will be written first.
int	encodeRaw(byte[] bs, int pos)	Writes this Cell's encoding to a byte array, excluding the tag byte.
CVMLong	ensureLong()	Gets the numeric value as a Long integer, or null if not a valid Long
boolean	equals(ACell a)	Checks for equality with another Cell.
boolean	equals(CVMDouble a)
int	estimatedEncodingSize()	Estimate the encoded data size for this Cell.
byte	getTag()	Gets the tag byte for this cell.
AType	getType()	Gets the most specific known runtime Type for this Cell.
int	hashCode()	Gets the Java hashCode for this cell.
boolean	isZero()	Check if this numeric value is equal to zero
long	longValue()
ANumeric	multiply(ANumeric b)	Multiplies a second numeric value with this value
ANumeric	negate()	Negates this numeric value
Class<?>	numericType()	Gets the numeric type that should be used as for calculations
static CVMDouble	parse(String s)	Parses a CVM Double value.
boolean	print(BlobBuilder bb, long limit)	Prints this Object to a readable String Representation.
static CVMDouble	read(byte tag, Blob blob, int offset)
static CVMDouble	read(double value)
CVMDouble	signum()	Gets the signum of this numerical value.
ANumeric	sub(ANumeric b)	Subtracts a second numeric value to this value
AString	toCVMString(long limit)	Returns the CVM String representation of this Cell.
CVMDouble	toDouble()	Casts to a CVM Double value.
AInteger	toInteger()	Converts this numeric value to the nearest integer
CVMLong	toLong()	Casts to a CVM Long value.
String	toString()	Returns the Java String representation of this Cell.
static CVMDouble	unsafeCreate(double value)
void	validateCell()	Validates the local structure and invariants of this cell.

Methods inherited from class convex.core.data.prim.APrimitive

calcMemorySize, getRef, getRefCount, isCanonical, isCVMValue, isDataValue, isEmbedded, toCanonical, updateRefs

Methods inherited from class convex.core.data.ACell

attachMemorySize, attachRef, cachedEncoding, cachedHash, createEncoding, createRef, equals, genericEquals, getCanonical, getChildRefs, getEncoding, getEncodingLength, getHash, getMemorySize, getMemorySize, getRef, validate

Methods inherited from class convex.core.data.AObject

attachEncoding, print, print

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

ZERO

public static final CVMDouble ZERO

NEGATIVE_ZERO

public static final CVMDouble NEGATIVE_ZERO

ONE

public static final CVMDouble ONE

MINUS_ONE

public static final CVMDouble MINUS_ONE

NaN

public static final CVMDouble NaN

POSITIVE_INFINITY

public static final CVMDouble POSITIVE_INFINITY

NEGATIVE_INFINITY

public static final CVMDouble NEGATIVE_INFINITY

MAX_ENCODING_LENGTH

public static final int MAX_ENCODING_LENGTH

See Also:

• Constant Field Values

Method Details

create

public static CVMDouble create(double value)

Creates a CVMDouble. Forces NaN to be canonical instance.

Parameters:

value - Double value to wrap

Returns:

CVMDouble value

unsafeCreate

public static CVMDouble unsafeCreate(double value)

getType

public AType getType()

Description copied from class: ACell

Gets the most specific known runtime Type for this Cell.

Overrides:

getType in class ACell

Returns:

The Type of this Call

longValue

public long longValue()

Specified by:

longValue in class APrimitive

Returns:

Java long value representing this primitive CVM value

toLong

public CVMLong toLong()

Description copied from class: ANumeric

Casts to a CVM Long value. Takes last 64 bits.

Specified by:

toLong in class ANumeric

Returns:

Long representation of this number

toDouble

public CVMDouble toDouble()

Description copied from class: ANumeric

Casts to a CVM Double value.

Specified by:

toDouble in class ANumeric

Returns:

Double value

signum

public CVMDouble signum()

Description copied from class: ANumeric

Gets the signum of this numerical value. Will be -1, 0 or 1 for Longs, -1.0, 0.0 , 1.0 or ##NaN for Doubles.

Specified by:

signum in class ANumeric

Returns:

Signum of the numeric value

estimatedEncodingSize

public int estimatedEncodingSize()

Description copied from interface: IWriteable

Estimate the encoded data size for this Cell. Used for quickly sizing buffers. Implementations should try to return a size that is highly likely to contain the entire object when encoded, including the tag byte. Should not traverse soft Refs, i.e. must be usable on arbitrary partial data structures

Returns:

The estimated size for the binary representation of this object.

validateCell

public void validateCell()
                  throws InvalidDataException

Description copied from class: ACell

Validates the local structure and invariants of this cell. Called by validate() super implementation. Should validate directly contained data, but should not validate all other structure of this cell. In particular, should not traverse potentially missing child Refs.

Specified by:

validateCell in class ACell

Throws:

InvalidDataException - If the Cell is invalid

encode

public int encode(byte[] bs,
 int pos)

Description copied from class: ACell

Writes this Cell's encoding to a byte array, including a tag byte which will be written first. Cell must be canonical, or else an error may occur.

Specified by:

encode in interface IWriteable

Specified by:

encode in class ACell

Parameters:

bs - A byte array to which to write the encoding

pos - The offset into the byte array

Returns:

New position after writing

encodeRaw

public int encodeRaw(byte[] bs,
 int pos)

Description copied from class: ACell

Writes this Cell's encoding to a byte array, excluding the tag byte.

Specified by:

encodeRaw in class ACell

Parameters:

bs - A byte array to which to write the encoding

pos - The offset into the byte array

Returns:

New position after writing

toString

public String toString()

Description copied from class: ACell

Returns the Java String representation of this Cell. The String representation is intended to be a easy-to-read textual representation of the Cell's data content.

Overrides:

toString in class ACell

print

public boolean print(BlobBuilder bb,
 long limit)

Description copied from class: AObject

Prints this Object to a readable String Representation. SECURITY: Must halt and return false in O(1) time when limit of printing is exceeded otherwise DoS attacks may be possible.

Specified by:

print in class AObject

Parameters:

bb - BlobBuilder to append to. May be partially written if print limit exceeded

limit - Limit of printing in string bytes

Returns:

True if fully printed within limit, false otherwise

numericType

public Class<?> numericType()

Description copied from class: ANumeric

Gets the numeric type that should be used as for calculations

Specified by:

numericType in class ANumeric

Returns:

Double.class or Long.class, or null if not a numeric type

doubleValue

public double doubleValue()

Specified by:

doubleValue in class ANumeric

Returns:

Java double value representing this primitive CVM value

parse

public static CVMDouble parse(String s)

Parses a CVM Double value.

Parameters:

s - String to parse

Returns:

CVMDouble value

Throws:

NumberFormatException - If number format is invalid

getTag

public byte getTag()

Description copied from class: ACell

Gets the tag byte for this cell. The tag byte is always equal to the first byte of the Cell's canonical Encoding, and is sufficient to distinguish how to read the rest of the encoding.

Specified by:

getTag in class ACell

Returns:

Tag byte for this Cell

read

public static CVMDouble read(double value)
                      throws BadFormatException

Throws:

BadFormatException

read

public static CVMDouble read(byte tag,
 Blob blob,
 int offset)
                      throws BadFormatException

Throws:

BadFormatException

toCVMString

public AString toCVMString(long limit)

Description copied from class: ACell

Returns the CVM String representation of this Cell. Normally, this is as printed, but may be different for some types. SHOULD return null in O(1) time if the length of the CVM String can be proved to exceed the limit. MUST complete in O(limit) time and space otherwise The String representation is intended to be a easy-to-read textual representation of the Cell's data content.

Overrides:

toCVMString in class ACell

Parameters:

limit - Limit of CVM String length in UTF-8 bytes

Returns:

CVM String, or null if limit exceeded

equals

public boolean equals(ACell a)

Description copied from class: ACell

Checks for equality with another Cell. In general, Cells are considered equal if they have the same canonical representation, i.e. an identical encoding with the same hash value. Subclasses SHOULD override this if they have a more efficient equals implementation. MUST NOT require reads from Store.

Specified by:

equals in class ACell

Parameters:

a - Cell to compare with. May be null.

Returns:

True if this cell is equal to the other object

equals

public boolean equals(CVMDouble a)

hashCode

public int hashCode()

Description copied from class: ACell

Gets the Java hashCode for this cell. Must be consistent with equals. Default is the hashCode of the Encoding blob, since this is consistent with encoding-based equality. However, different Types may provide more efficient hashcodes provided that the usual invariants are preserved

Overrides:

hashCode in class ACell

Returns:

integer hash code.

abs

public ANumeric abs()

Description copied from class: ANumeric

Gets the absolute value of this number. May be ##NaN for Doubles.

Specified by:

abs in class ANumeric

Returns:

Absolute value of the numeric value

compareTo

public int compareTo(ANumeric o)

ensureLong

public CVMLong ensureLong()

Description copied from class: ANumeric

Gets the numeric value as a Long integer, or null if not a valid Long

Specified by:

ensureLong in class ANumeric

Returns:

CVMLong value, or null

add

public ANumeric add(ANumeric b)

Description copied from class: ANumeric

Adds a second numeric value to this value

Specified by:

add in class ANumeric

Parameters:

b - Second number to add

Returns:

Result of addition

sub

public ANumeric sub(ANumeric b)

Description copied from class: ANumeric

Subtracts a second numeric value to this value

Specified by:

sub in class ANumeric

Parameters:

b - Number to subtract

Returns:

Result of subtraction

negate

public ANumeric negate()

Description copied from class: ANumeric

Negates this numeric value

Specified by:

negate in class ANumeric

Returns:

Negated value

multiply

public ANumeric multiply(ANumeric b)

Description copied from class: ANumeric

Multiplies a second numeric value with this value

Specified by:

multiply in class ANumeric

Parameters:

b - Second number to add

Returns:

Result of multiplication

toInteger

public AInteger toInteger()

Description copied from class: ANumeric

Converts this numeric value to the nearest integer

Specified by:

toInteger in class ANumeric

Returns:

Integer value, or null if bad conversion (e.g. infinity or NaN)

isZero

public boolean isZero()

Description copied from class: ANumeric

Check if this numeric value is equal to zero

Specified by:

isZero in class ANumeric

Returns:

True if this value is numerically equal to zero