Package convex.core.data.prim

Class CVMLong

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

convex.core.data.prim.CVMLong

All Implemented Interfaces:

IValidated, IWriteable, Comparable<ANumeric>

public final class CVMLong
extends AInteger

Class for CVM long values. Longs are signed 64-bit integers, and are the primary fixed point integer type on the CVM.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	MAX_ENCODING_LENGTH
static final CVMLong	MAX_VALUE
static final CVMLong	MIN_VALUE
static final CVMLong	MINUS_ONE
static final CVMLong	ONE
static final CVMLong	ZERO

Fields inherited from class convex.core.data.ACell

cachedRef, EMPTY_ARRAY

Fields inherited from class convex.core.data.AObject

encoding

Constructor Summary

Constructors

Constructor	Description
CVMLong(long value)

Method Summary

Modifier and Type	Method	Description
AInteger	abs()	Gets the absolute value of this number.
AInteger	add(AInteger a)	Adds another integer to this integer
AInteger	add(CVMLong b)
BigInteger	big()	Converts this integer to a Java BigInteger.
long	byteLength()	Number of bytes in minimal representation of this Integer.
int	compareTo(ANumeric o)
static CVMLong	create(long value)	Creates a CVMLong wrapping the given Java long value.
static CVMLong	create(Long value)	Creates a CVMLong wrapping the given Java long value.
AInteger	dec()	Decrements this Integer
AInteger	div(AInteger base)	Divides this integer with a given denominator.
CVMLong	div(CVMLong base)
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 c)	Checks for equality with another Cell.
boolean	equals(CVMLong c)
int	estimatedEncodingSize()	Estimate the encoded data size for this Cell.
static CVMLong	forByte(byte b)	Gets the CVMLong representing an unsigned byte value
static final CVMLong	forSignum(long value)	Gets a CVMLong representing the signum of the given value
byte	getTag()	Gets the tag byte for this cell.
AType	getType()	Gets the most specific known runtime Type for this Cell.
AInteger	inc()	Increments this Integer
boolean	isCanonical()	Returns true if this Cell is in a canonical representation for message writing.
boolean	isZero()	Check if this numeric value is equal to zero
long	longValue()
AInteger	mod(AInteger base)	Returns the modulus of this integer with a given integer base
CVMLong	mod(CVMLong base)
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 CVMLong	parse(Object o)	Parse an Object as a CVM Long, on a best efforts basis
static CVMLong	parse(String s)	Parse a String as a CVM Long.
boolean	print(BlobBuilder bb, long limit)	Prints this Object to a readable String Representation.
AInteger	quot(AInteger base)	Divides this integer with a given denominator.
CVMLong	quot(CVMLong base)
static CVMLong	read(byte tag, Blob blob, int offset)
AInteger	rem(AInteger base)	Returns the remainder of dividing this integer with a given divisor
CVMLong	rem(CVMLong base)
CVMLong	signum()	Gets the signum of this numerical value.
AInteger	sub(AInteger a)	Subtracts another integer from this integer
AInteger	sub(CVMLong b)
AInteger	toCanonical()	Converts this Cell to its canonical version.
AString	toCVMString(long limit)	Returns the CVM String representation of this Cell.
CVMDouble	toDouble()	Casts to a CVM Double value.
CVMLong	toLong()	Casts to a CVM Long value.
String	toString()	Returns the Java String representation of this Cell.
void	validateCell()	Validates the local structure and invariants of this cell.

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

add, create, create, sub, toInteger

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

calcMemorySize, getRefCount, isCVMValue, isEmbedded

Methods inherited from class convex.core.data.ACell

announce, announce, attachMemorySize, attachRef, cachedEncoding, cachedHash, createAnnounced, createEncoding, createPersisted, createPersisted, createRef, equals, getCanonical, getChildRefs, getEncoding, getEncodingLength, getHash, getMemorySize, getRef, getRef, hashCode, isCompletelyEncoded, mark, mark, updateRefs, validate, write

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 CVMLong ZERO

ONE

public static final CVMLong ONE

MINUS_ONE

public static final CVMLong MINUS_ONE

MAX_VALUE

public static final CVMLong MAX_VALUE

MIN_VALUE

public static final CVMLong MIN_VALUE

MAX_ENCODING_LENGTH

public static final int MAX_ENCODING_LENGTH

See Also:

• Constant Field Values

Constructor Details

CVMLong

public CVMLong(long value)

Method Details

create

public static CVMLong create(long value)

Creates a CVMLong wrapping the given Java long value. Always succeeds.

Parameters:

value - Java long

Returns:

CVMLong instance.

create

public static CVMLong create(Long value)

Creates a CVMLong wrapping the given Java long value. Always succeeds.

Parameters:

value - Java long

Returns:

CVMLong instance.

forByte

public static CVMLong forByte(byte b)

Gets the CVMLong representing an unsigned byte value

Parameters:

b - Byte to convery to CVMLong (will be interpreted as unsigned)

Returns:

CVMLong value

getType

public AType getType()

Description copied from class: ACell

Gets the most specific known runtime Type for this Cell.

Overrides:

getType in class AInteger

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

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

read

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

Throws:

BadFormatException

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 CVMLong parse(Object o)

Parse an Object as a CVM Long, on a best efforts basis

Parameters:

o - String to parse

Returns:

CVM Long value or null if parse failed

parse

public static CVMLong parse(String s)

Parse a String as a CVM Long. Throws an exception if the string is not valid

Parameters:

s - String to parse

Returns:

CVM Long value, or null if not convertible

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

signum

public 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

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. MUST return null in O(1) time if the length of the CVM String would exceed limit. 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

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

equals

public boolean equals(ACell c)

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.

Overrides:

equals in class ACell

Parameters:

c - Cell to compare with. May be null.

Returns:

True if this cell is equal to the other object

equals

public boolean equals(CVMLong c)

forSignum

public static final CVMLong forSignum(long value)

Gets a CVMLong representing the signum of the given value

Parameters:

value - Value to test for signum

Returns:

1, 0 or -1 as a CVM Long

isCanonical

public boolean isCanonical()

Description copied from class: ACell

Returns true if this Cell is in a canonical representation for message writing. Non-canonical objects may be used on a temporary internal basis, they must always be converted to canonical representations for external use (e.g. Encoding).

Specified by:

isCanonical in class AInteger

Returns:

true if the object is in canonical format, false otherwise

abs

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

inc

public AInteger inc()

Description copied from class: AInteger

Increments this Integer

Specified by:

inc in class AInteger

Returns:

Incremented value

dec

public AInteger dec()

Description copied from class: AInteger

Decrements this Integer

Specified by:

dec in class AInteger

Returns:

Decremented 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

byteLength

public long byteLength()

Description copied from class: AInteger

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

Specified by:

byteLength in class AInteger

Returns:

Number of bytes

add

public AInteger add(AInteger a)

Description copied from class: AInteger

Adds another integer to this integer

Specified by:

add in class AInteger

Parameters:

a - Integer value to add

Returns:

New integer

add

public AInteger add(CVMLong b)

sub

public AInteger sub(AInteger a)

Description copied from class: AInteger

Subtracts another integer from this integer

Specified by:

sub in class AInteger

Parameters:

a - Integer value to subtract

Returns:

New integer

sub

public AInteger sub(CVMLong b)

big

public BigInteger big()

Description copied from class: AInteger

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

Specified by:

big in class AInteger

Returns:

Java BigInteger

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

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

mod

public AInteger mod(AInteger base)

Description copied from class: AInteger

Returns the modulus of this integer with a given integer base

Specified by:

mod in class AInteger

Parameters:

base - Base of modulus operation

Returns:

Modulus result

mod

public CVMLong mod(CVMLong base)

div

public AInteger div(AInteger base)

Description copied from class: AInteger

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

Specified by:

div in class AInteger

Parameters:

base - Base of division

Returns:

Division result

div

public CVMLong div(CVMLong base)

rem

public AInteger rem(AInteger base)

Description copied from class: AInteger

Returns the remainder of dividing this integer with a given divisor

Specified by:

rem in class AInteger

Parameters:

base - Base of division operation

Returns:

Modulus result

rem

public CVMLong rem(CVMLong base)

quot

public AInteger quot(AInteger base)

Description copied from class: AInteger

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

Specified by:

quot in class AInteger

Parameters:

base - Base of division

Returns:

Division result

quot

public CVMLong quot(CVMLong base)

toCanonical

public AInteger toCanonical()

Description copied from class: ACell

Converts this Cell to its canonical version. Must return this Cell if already canonical, may be O(n) in size of value otherwise.

Specified by:

toCanonical in class AInteger

Returns:

Canonical version of Cell