Package convex.core.data

Class ACountable<E extends ACell>

java.lang.Object

convex.core.data.AObject

convex.core.data.ACell

convex.core.data.ACountable<E>

Type Parameters:

E - Type of element that is counted

All Implemented Interfaces:

IValidated, IWriteable

Direct Known Subclasses:

ABlobLike, ADataStructure

public abstract class ACountable<E extends ACell>
extends ACell

Abstract base class for Countable objects, supporting `count`, `nth`, `empty?` and `slice` Countable values support a count of elements and the ability to get by an element index.

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

Method Summary

Modifier and Type	Method	Description
abstract long	count()	Returns the number of elements in this value
abstract ACountable<E>	empty()	Returns a canonical, singleton empty instance of the same type as this Countable value.
abstract E	get(long index)	Gets the element at the specified element index in this value
abstract Ref<E>	getElementRef(long index)	Gets a Ref to the element at the specified element index in this collection
boolean	isEmpty()	Checks if this data structure is empty, i.e.
int	size()	Gets the size of this data structure as an int.
ACountable<E>	slice(long start)	Gets a slice of this data structure from start to the end
abstract ACountable<E>	slice(long start, long end)	Gets a slice of this data structure

Methods inherited from class convex.core.data.ACell

attachMemorySize, attachRef, cachedEncoding, cachedHash, calcMemorySize, createEncoding, createRef, encode, encodeRaw, equals, equals, genericEquals, getCanonical, getChildRefs, getEncoding, getEncodingLength, getHash, getMemorySize, getMemorySize, getRef, getRef, getRefCount, getTag, getType, hashCode, isCanonical, isCVMValue, isDataValue, isEmbedded, toCanonical, toCVMString, toString, updateRefs, 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

ACountable

public ACountable()

Method Details

count

public abstract long count()

Returns the number of elements in this value

Returns:

Number of elements

get

public abstract E get(long index)

Gets the element at the specified element index in this value

Parameters:

index - Index of element to get

Returns:

Element at the specified index

getElementRef

public abstract Ref<E> getElementRef(long index)

Gets a Ref to the element at the specified element index in this collection

Parameters:

index - Index of element to get

Returns:

Element at the specified index

isEmpty

public boolean isEmpty()

Checks if this data structure is empty, i.e. has a count of zero elements.

Returns:

true if this data structure is empty, false otherwise

empty

public abstract ACountable<E> empty()

Returns a canonical, singleton empty instance of the same type as this Countable value.

Returns:

An empty Countable value, or null if there is no empty instance

size

public int size()

Gets the size of this data structure as an int. Returns Integer.MAX_SIZE if the count is larger than can fit in an int. If this might be a problem, use count() instead.

Returns:

Number of elements in this collection.

slice

public abstract ACountable<E> slice(long start,
 long end)

Gets a slice of this data structure

Parameters:

start - Start index (inclusive)

end - end index (exclusive)

Returns:

Slice of data structure, or null if invalid slice

slice

public ACountable<E> slice(long start)

Gets a slice of this data structure from start to the end

Parameters:

start - Start index (inclusive)

Returns:

Slice of data structure, or null if invalid slice