Package convex.core.data.prim

Class AInteger

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.AInteger

All Implemented Interfaces:

IValidated, IWriteable, Comparable<ANumeric>

Direct Known Subclasses:

CVMBigInteger, CVMLong

public abstract class AInteger
extends ANumeric

Abstract base class for CVM Integer values

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
AInteger()

Method Summary

Modifier and Type	Method	Description
abstract AInteger	add(AInteger a)	Adds another integer to this integer
ANumeric	add(ANumeric b)	Adds a second numeric value to this value
abstract BigInteger	big()	Converts this integer to a Java BigInteger.
abstract long	byteLength()	Number of bytes in minimal representation of this Integer.
static AInteger	create(long value)	Create a canonical CVM integer representation of the given Java Long
static AInteger	create(Number value)	Create a canonical CVM integer representation of the given Java Number
static AInteger	create(BigInteger bi)	Create a canonical CVM integer representation of the given Java BigInteger
abstract AInteger	dec()	Decrements this Integer
abstract AInteger	div(AInteger base)	Divides this integer with a given denominator.
AType	getType()	Gets the most specific known runtime Type for this Cell.
abstract AInteger	inc()	Increments this Integer
abstract boolean	isCanonical()	Returns true if this Cell is in a canonical representation.
abstract boolean	isLong()	Return true if this value is a valid 64-bit long integer
abstract AInteger	mod(AInteger base)	Returns the modulus of this integer with a given integer base
static AInteger	parse(Object o)	Parse a value as a canonical integer
static AInteger	parse(String s)	Parse an integer value as a canonical value
abstract AInteger	quot(AInteger divisor)	Divides this integer with a given denominator.
abstract AInteger	rem(AInteger divisor)	Returns the remainder of dividing this integer with a given divisor
abstract CVMLong	signum()	Gets the signum of this numerical value.
abstract AInteger	sub(AInteger a)	Subtracts another integer from this integer
ANumeric	sub(ANumeric b)	Subtracts a second numeric value to this value
abstract ABlob	toBlob()	Converts this Integer value to Blob form
abstract AInteger	toCanonical()	Converts this Cell to a canonical version.
AInteger	toInteger()	Converts this numeric value to the nearest integer
AInteger	toPower(AInteger power)	Raise the integer to the given power

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

abs, doubleValue, ensureLong, isZero, multiply, negate, numericType, toDouble, toLong

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

calcMemorySize, getRef, getRefCount, isCVMValue, isDataValue, isEmbedded, longValue, 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, 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

AInteger

public AInteger()

Method Details

isCanonical

public abstract boolean isCanonical()

Description copied from class: ACell

Returns true if this Cell is in a canonical representation. Non-canonical objects may be used on a temporary internal basis, they should be converted to canonical representations for general purpose use.

Overrides:

isCanonical in class APrimitive

Returns:

true if the object is in canonical format, false otherwise

toCanonical

public abstract AInteger toCanonical()

Description copied from class: ACell

Converts this Cell to a canonical version. Must return this Cell if already canonical, may be O(n) in size of value otherwise. Callers should usually use getCanonical(), which caches canonical instances once created

Overrides:

toCanonical in class APrimitive

Returns:

Canonical version of Cell

inc

public abstract AInteger inc()

Increments this Integer

Returns:

Incremented value

signum

public abstract CVMLong 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

dec

public abstract AInteger dec()

Decrements this Integer

Returns:

Decremented 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

parse

public static AInteger parse(String s)

Parse an integer value as a canonical value

Parameters:

s - String to parse

Returns:

AInteger instance, or null if not convertible

parse

public static AInteger parse(Object o)

Parse a value as a canonical integer

Parameters:

o - Object to parse

Returns:

AInteger instance, or null if not convertible

byteLength

public abstract long byteLength()

Number of bytes in minimal representation of this Integer. Returns 0 if and only if the integer is zero.

Returns:

Number of bytes

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

add

public abstract AInteger add(AInteger a)

Adds another integer to this integer

Parameters:

a - Integer value to add

Returns:

New integer

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

sub

public abstract AInteger sub(AInteger a)

Subtracts another integer from this integer

Parameters:

a - Integer value to subtract

Returns:

New integer

big

public abstract BigInteger big()

Converts this integer to a Java BigInteger. WARNING: might be O(n)

Returns:

Java BigInteger

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)

create

public static AInteger create(BigInteger bi)

Create a canonical CVM integer representation of the given Java BigInteger

Parameters:

bi - BigInteger value

Returns:

AInteger instance

create

public static AInteger create(long value)

Create a canonical CVM integer representation of the given Java Long

Parameters:

value - Long value

Returns:

AInteger instance

create

public static AInteger create(Number value)

Create a canonical CVM integer representation of the given Java Number

Parameters:

value - Long value

Returns:

AInteger instance

mod

public abstract AInteger mod(AInteger base)

Returns the modulus of this integer with a given integer base

Parameters:

base - Base of modulus operation

Returns:

Modulus result

div

public abstract AInteger div(AInteger base)

Divides this integer with a given denominator. Performs Euclidian division consistent with mod

Parameters:

base - Base of division

Returns:

Division result

quot

public abstract AInteger quot(AInteger divisor)

Divides this integer with a given denominator. Performs division consistent with rem

Parameters:

divisor - Base of division

Returns:

Division result

rem

public abstract AInteger rem(AInteger divisor)

Returns the remainder of dividing this integer with a given divisor

Parameters:

divisor - Base of division operation

Returns:

Modulus result

toBlob

public abstract ABlob toBlob()

Converts this Integer value to Blob form

Returns:

minimal blob representing the integer value

isLong

public abstract boolean isLong()

Return true if this value is a valid 64-bit long integer

Returns:

true if this integer fits in a 64-bit long

toPower

public AInteger toPower(AInteger power)

Raise the integer to the given power

Parameters:

power - Power to raise integer to

Returns:

Result, or null if invalid