Package convex.core.lang

Class AFn<T extends ACell>

java.lang.Object

convex.core.data.AObject

convex.core.data.ACell

convex.core.lang.AFn<T>

Type Parameters:

T - Return type of functions.

All Implemented Interfaces:

IValidated, IWriteable, IFn<T>

Direct Known Subclasses:

AClosure, ADataFn, CoreFn

public abstract class AFn<T extends ACell>
extends ACell
implements IFn<T>

Base class for functions expressed as values "You know what's web-scale? The Web. And you know what it is? Dynamically typed." - Stuart Halloway

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

Method Summary

Modifier and Type	Method	Description
boolean	equals(ACell o)	Checks for equality with another Cell.
byte	getTag()	Gets the tag byte for this cell.
final AType	getType()	Gets the most specific known runtime Type for this Cell.
abstract boolean	hasArity(int arity)	Tests if this function supports the given arity.
abstract Context	invoke(Context context, ACell[] args)	Invoke this function in the given context.
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.
final boolean	isDataValue()	Returns true if this cell instance is a first class value, i.e.
boolean	supportsArgs(ACell[] args)	Tests if this function supports the given argument list By default, checks if the function supports the given arity only.
abstract AFn<T>	updateRefs(IRefFunction func)	Updates all Refs in this object using the given function.

Methods inherited from class convex.core.data.ACell

attachMemorySize, attachRef, cachedEncoding, cachedHash, calcMemorySize, createEncoding, createRef, encode, encodeRaw, equals, genericEquals, getCanonical, getChildRefs, getEncoding, getEncodingLength, getHash, getMemorySize, getMemorySize, getRef, getRef, getRefCount, hashCode, isCanonical, isEmbedded, toCanonical, 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 convex.core.data.IWriteable

estimatedEncodingSize

Constructor Details

AFn

public AFn()

Method Details

invoke

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

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

Overrides:

updateRefs in class ACell

Parameters:

func - Ref update function

Returns:

Cell with updated Refs

getType

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

supportsArgs

public boolean supportsArgs(ACell[] args)

Tests if this function supports the given argument list By default, checks if the function supports the given arity only. TODO: intention is to override this to include dynamic type checks etc.

Parameters:

args - Array of arguments

Returns:

true if function supports the specified args array

hasArity

public abstract boolean hasArity(int arity)

Tests if this function supports the given arity.

Parameters:

arity - Arity to check

Returns:

true if function supports the given arity, false otherwise

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

Specified by:

isCVMValue in class ACell

Returns:

true if the object is a CVM Value, false otherwise

isDataValue

public final boolean isDataValue()

Description copied from class: ACell

Returns true if this cell instance is a first class value, i.e. not a component of a larger data structure Sub-structural cells that are not themselves first class values should return false Everything else should return true.

Specified by:

isDataValue in class ACell

Returns:

true if the object is a 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.

Specified by:

getTag in class ACell

Returns:

Tag byte for this Cell

equals

public boolean equals(ACell o)

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:

o - Cell to compare with. May be null.

Returns:

True if this cell is equal to the other object