Package convex.core.lang.impl

Class ADataFn<T extends ACell>

java.lang.Object

convex.core.data.AObject

convex.core.data.ACell

convex.core.lang.AFn<T>

convex.core.lang.impl.ADataFn<T>

Type Parameters:

T - Type of function return value

All Implemented Interfaces:

IValidated, IWriteable, IFn<T>

Direct Known Subclasses:

KeywordFn, MapFn, SeqFn, SetFn

public abstract class ADataFn<T extends ACell>
extends AFn<T>

Abstract base class for data structure lookup functions. Not a canonical object, can't exist as CVM value.

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

Method Summary

Modifier and Type	Method	Description
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.
int	estimatedEncodingSize()	Estimate the encoded data size for this Cell.
int	getRefCount()	Gets the number of Refs contained within this Cell.
byte	getTag()	Gets the tag byte for this cell.
boolean	hasArity(int n)	Tests if this function supports the given arity.
Context	invoke(Context context, ACell[] args)	Invoke this function in the given context.
boolean	isCanonical()	Returns true if this Cell is in a canonical representation.
boolean	isCVMValue()	Returns true if this cell is a first class CVM Value allowable in the CVM state Sub-structural cells that are not themselves first class values should return false Records and types that are not permissible on the CVM should return false.
ACell	toCanonical()	Converts this Cell to a canonical version.
AFn<T>	updateRefs(IRefFunction func)	Updates all Refs in this object using the given function.
void	validateCell()	Validates the local structure and invariants of this cell.

Methods inherited from class convex.core.lang.AFn

equals, getType, isDataValue, supportsArgs

Methods inherited from class convex.core.data.ACell

attachMemorySize, attachRef, cachedEncoding, cachedHash, calcMemorySize, createEncoding, createRef, equals, genericEquals, getCanonical, getChildRefs, getEncoding, getEncodingLength, getHash, getMemorySize, getMemorySize, getRef, getRef, hashCode, isEmbedded, toCVMString, toString, validate

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

Constructor Details

ADataFn

public ADataFn()

Method Details

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.

invoke

public Context invoke(Context context,
 ACell[] args)

Description copied from interface: IFn

Invoke this function in the given context.

Specified by:

invoke in interface IFn<T extends ACell>

Specified by:

invoke in class AFn<T extends ACell>

Parameters:

context - Context in which the function is to be executed

args - Arguments to the function

Returns:

Context containing result of function invocation, or an exceptional value

updateRefs

public AFn<T> updateRefs(IRefFunction func)

Description copied from class: ACell

Updates all Refs in this object using the given function. The function *must not* change the hash value of Refs, in order to ensure structural integrity of modified data structures. The implementation *should* re-attach any original encoding in order to prevent re-encoding or surplus hashing This is a building block for a very sneaky trick that enables use to do a lot of efficient operations on large trees of smart references. Must return the same object if no Refs are altered.

Specified by:

updateRefs in class AFn<T extends ACell>

Parameters:

func - Ref update function

Returns:

Cell with updated Refs

hasArity

public boolean hasArity(int n)

Description copied from class: AFn

Tests if this function supports the given arity.

Specified by:

hasArity in class AFn<T extends ACell>

Parameters:

n - Arity to check

Returns:

true if function supports the given arity, false otherwise

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

isCanonical

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

Specified by:

isCanonical in class ACell

Returns:

true if the object is in canonical format, false otherwise

toCanonical

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

Specified by:

toCanonical in class ACell

Returns:

Canonical version of Cell

isCVMValue

public boolean isCVMValue()

Description copied from class: ACell

Returns true if this cell is a first class CVM Value allowable in the CVM state Sub-structural cells that are not themselves first class values should return false Records and types that are not permissible on the CVM should return false. Pretty much everything else should return true. Note: CVM values might not be in a canonical format, e.g. temporary data structures

Overrides:

isCVMValue in class AFn<T extends ACell>

Returns:

true if the object is a CVM Value, false otherwise

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.

Overrides:

getTag in class AFn<T extends ACell>

Returns:

Tag byte for this Cell

getRefCount

public int getRefCount()

Description copied from class: ACell

Gets the number of Refs contained within this Cell. This number is final / immutable for any given instance and is defined by the Cell encoding rules. Contained Refs may be either external or embedded.

Overrides:

getRefCount in class ACell

Returns:

The number of Refs in this Cell