Package convex.core.data.prim

Class ANumeric

java.lang.Object

convex.core.data.AObject

convex.core.data.ACell

convex.core.data.prim.APrimitive

convex.core.data.prim.ANumeric

All Implemented Interfaces:

IValidated, IWriteable, Comparable<ANumeric>

Direct Known Subclasses:

AInteger, CVMDouble

public abstract class ANumeric
extends APrimitive
implements Comparable<ANumeric>

BAse class for CVM numeric types

Field Summary

Fields inherited from class convex.core.data.ACell

cachedRef, memorySize

Fields inherited from class convex.core.data.AObject

encoding

Constructor Summary

Constructors

Constructor	Description
ANumeric()

Method Summary

Modifier and Type	Method	Description
abstract ANumeric	abs()	Gets the absolute value of this number.
abstract ANumeric	add(ANumeric b)	Adds a second numeric value to this value
abstract double	doubleValue()
abstract CVMLong	ensureLong()	Gets the numeric value as a Long integer, or null if not a valid Long
abstract boolean	isZero()	Check if this numeric value is equal to zero
abstract ANumeric	multiply(ANumeric b)	Multiplies a second numeric value with this value
abstract ANumeric	negate()	Negates this numeric value
abstract Class<?>	numericType()	Gets the numeric type that should be used as for calculations
abstract APrimitive	signum()	Gets the signum of this numerical value.
abstract ANumeric	sub(ANumeric b)	Subtracts a second numeric value to this value
abstract CVMDouble	toDouble()	Casts to a CVM Double value.
abstract AInteger	toInteger()	Converts this numeric value to the nearest integer
abstract CVMLong	toLong()	Casts to a CVM Long value.

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

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

Methods inherited from class convex.core.data.ACell

attachMemorySize, attachRef, cachedEncoding, cachedHash, createEncoding, createRef, encode, encodeRaw, equals, equals, genericEquals, getCanonical, getChildRefs, getEncoding, getEncodingLength, getHash, getMemorySize, getMemorySize, getRef, getTag, getType, hashCode, toCVMString, toString, validate, validateCell

Methods inherited from class convex.core.data.AObject

attachEncoding, print, print, print

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface convex.core.data.IWriteable

estimatedEncodingSize

Constructor Details

ANumeric

public ANumeric()

Method Details

toLong

public abstract CVMLong toLong()

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

Returns:

Long representation of this number

toDouble

public abstract CVMDouble toDouble()

Casts to a CVM Double value.

Returns:

Double value

doubleValue

public abstract double doubleValue()

Specified by:

doubleValue in class APrimitive

Returns:

Java double value representing this primitive CVM value

numericType

public abstract Class<?> numericType()

Gets the numeric type that should be used as for calculations

Returns:

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

signum

public abstract APrimitive signum()

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.

Returns:

Signum of the numeric value

abs

public abstract ANumeric abs()

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

Returns:

Absolute value of the numeric value

ensureLong

public abstract CVMLong ensureLong()

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

Returns:

CVMLong value, or null

add

public abstract ANumeric add(ANumeric b)

Adds a second numeric value to this value

Parameters:

b - Second number to add

Returns:

Result of addition

sub

public abstract ANumeric sub(ANumeric b)

Subtracts a second numeric value to this value

Parameters:

b - Number to subtract

Returns:

Result of subtraction

negate

public abstract ANumeric negate()

Negates this numeric value

Returns:

Negated value

multiply

public abstract ANumeric multiply(ANumeric b)

Multiplies a second numeric value with this value

Parameters:

b - Second number to add

Returns:

Result of multiplication

toInteger

public abstract AInteger toInteger()

Converts this numeric value to the nearest integer

Returns:

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

isZero

public abstract boolean isZero()

Check if this numeric value is equal to zero

Returns:

True if this value is numerically equal to zero