Package convex.core.data.impl

Class KeySet<K extends ACell,V extends ACell>

java.lang.Object

convex.core.data.AObject

convex.core.data.ACell

convex.core.data.ACountable<K>

convex.core.data.ADataStructure<K>

convex.core.data.ACollection<K>

convex.core.data.ASet<K>

convex.core.data.impl.ADerivedSet<K,K,V>

convex.core.data.impl.KeySet<K,V>

All Implemented Interfaces:

IAssociative<K,CVMBool>, IValidated, IWriteable, Iterable<K>, Collection<K>, Set<K>

public class KeySet<K extends ACell,V extends ACell>
extends ADerivedSet<K,K,V>

Field Summary

Fields inherited from class convex.core.data.impl.ADerivedSet

map

Fields inherited from class convex.core.data.ADataStructure

count

Fields inherited from class convex.core.data.ACell

cachedRef, memorySize

Fields inherited from class convex.core.data.AObject

encoding

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	KeySet(AHashMap<K,V> map)

Method Summary

Modifier and Type	Method	Description
ASet<K>	conj(ACell a)	Adds an element to this collection, according to the natural semantics of the collection
ASet<K>	conjAll(ACollection<? extends K> xs)	Adds multiple elements to this data structure, in the natural manner defined by the general data structure type.
boolean	contains(ACell o)	Tests if this Set contains a given value
boolean	containsAll(ASet<?> b)	Tests if this set contains all the elements of another set
protected <R> void	copyToArray(R[] arr, int offset)	Copies the elements of this collection in order to an array at the specified offset
static <K extends ACell, V extends ACell> KeySet<K,V>	create(AHashMap<K,V> map)
ASet<K>	disjAll(ACollection<K> xs)	Removes all elements from this set, returning a new set.
int	encode(byte[] bs, int pos)	Writes this Cell's encoding to a byte array, including a tag byte which will be written first.
protected int	encodeRaw(byte[] bs, int pos)	Writes this Cell's encoding to a byte array, excluding the tag byte.
boolean	equals(ACell a)	Checks for equality with another Cell.
int	estimatedEncodingSize()	Estimate the encoded data size for this Cell.
ASet<K>	exclude(ACell a)	Updates the set to exclude the given element
ASet<K>	excludeAll(ASet<K> elements)	Updates the set to exclude all the given elements.
protected ASet<K>	getCanonicalSet()
Ref<K>	getElementRef(long index)	Gets a Ref to the element at the specified element index in this collection
protected Ref<K>	getRefByHash(Hash hash)	Gets the Ref in the Set for a given hash, or null if not found
int	getRefCount()	Gets the number of Refs contained within this Cell.
Ref<K>	getValueRef(ACell k)	Gets the Ref in the Set for a given value, or null if not found
ASet<K>	include(K a)	Updates the set to include the given element
ASet<K>	includeAll(ASet<? extends K> elements)	Updates the set to include all the given elements.
ASet<K>	includeRef(Ref<K> ref)	Adds a value to this set using a Ref to the value
ASet<K>	intersectAll(ASet<K> xs)	Returns the intersection of two sets
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.
ASet<K>	slice(long start, long end)	Gets a slice of this Set
protected AHashSet<K>	toCanonical()	Converts this Cell to a canonical version.
void	validateCell()	Validates the local structure and invariants of this cell.

Methods inherited from class convex.core.data.impl.ADerivedSet

isCanonical

Methods inherited from class convex.core.data.ASet

assoc, contains, containsKey, empty, get, get, get, getTag, getType, isSubset, map, print, slice, toVector

Methods inherited from class convex.core.data.ACollection

add, addAll, clear, containsAll, iterator, remove, removeAll, retainAll, toArray, toArray, toCellArray

Methods inherited from class convex.core.data.ADataStructure

checkIndex, count, isDataValue, isEmpty, size, toCVMString

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, toString, updateRefs, validate

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

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.Set

add, addAll, clear, containsAll, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, spliterator, toArray, toArray

Constructor Details

KeySet

protected KeySet(AHashMap<K,V> map)

Method Details

create

public static <K extends ACell,
V extends ACell>
KeySet<K,V> create(AHashMap<K,V> map)

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.

include

public ASet<K> include(K a)

Description copied from class: ASet

Updates the set to include the given element

Specified by:

include in class ASet<K extends ACell>

Parameters:

a - Value to include

Returns:

Updated set

getCanonicalSet

protected ASet<K> getCanonicalSet()

exclude

public ASet<K> exclude(ACell a)

Description copied from class: ASet

Updates the set to exclude the given element

Specified by:

exclude in class ASet<K extends ACell>

Parameters:

a - Value to exclude

Returns:

Updated set

includeAll

public ASet<K> includeAll(ASet<? extends K> elements)

Description copied from class: ASet

Updates the set to include all the given elements. Can be used to implement union of sets

Specified by:

includeAll in class ASet<K extends ACell>

Parameters:

elements - Elements to include

Returns:

Updated set

excludeAll

public ASet<K> excludeAll(ASet<K> elements)

Description copied from class: ASet

Updates the set to exclude all the given elements.

Specified by:

excludeAll in class ASet<K extends ACell>

Parameters:

elements - Elements to exclude

Returns:

Updated set

conjAll

public ASet<K> conjAll(ACollection<? extends K> xs)

Description copied from class: ADataStructure

Adds multiple elements to this data structure, in the natural manner defined by the general data structure type. e.g. append at the end of a vector. This may be more efficient than using 'conj' for individual items.

Specified by:

conjAll in class ASet<K extends ACell>

Parameters:

xs - New elements to add

Returns:

The updated data structure, or null if a failure occurred due to invalid element types

disjAll

public ASet<K> disjAll(ACollection<K> xs)

Description copied from class: ASet

Removes all elements from this set, returning a new set.

Specified by:

disjAll in class ASet<K extends ACell>

Parameters:

xs - Collection of elements to remove

Returns:

Set with specified element(s) removed

intersectAll

public ASet<K> intersectAll(ASet<K> xs)

Description copied from class: ASet

Returns the intersection of two sets

Specified by:

intersectAll in class ASet<K extends ACell>

Parameters:

xs - Set to intersect with

Returns:

Intersection of the two sets

contains

public boolean contains(ACell o)

Description copied from class: ASet

Tests if this Set contains a given value

Specified by:

contains in class ASet<K extends ACell>

Parameters:

o - Value to test for set membership

Returns:

True if set contains value, false otherwise

includeRef

public ASet<K> includeRef(Ref<K> ref)

Description copied from class: ASet

Adds a value to this set using a Ref to the value

Specified by:

includeRef in class ASet<K extends ACell>

Parameters:

ref - Ref to value to include

Returns:

Updated set

conj

public ASet<K> conj(ACell a)

Description copied from class: ACollection

Adds an element to this collection, according to the natural semantics of the collection

Specified by:

conj in class ASet<K extends ACell>

Parameters:

a - Value to add, should be the element type of the data structure

Returns:

The updated collection

getValueRef

public Ref<K> getValueRef(ACell k)

Description copied from class: ASet

Gets the Ref in the Set for a given value, or null if not found

Specified by:

getValueRef in class ASet<K extends ACell>

Parameters:

k - Value to check for set membership

Returns:

Ref to value, or null

getRefByHash

protected Ref<K> getRefByHash(Hash hash)

Description copied from class: ASet

Gets the Ref in the Set for a given hash, or null if not found

Specified by:

getRefByHash in class ASet<K extends ACell>

Parameters:

hash - Hash to check for set membership

Returns:

Ref to value with given Hash, or null

containsAll

public boolean containsAll(ASet<?> b)

Description copied from class: ASet

Tests if this set contains all the elements of another set

Specified by:

containsAll in class ASet<K extends ACell>

Parameters:

b - Set to compare with

Returns:

True if other set is completely contained within this set, false otherwise

slice

public ASet<K> slice(long start,
 long end)

Description copied from class: ASet

Gets a slice of this Set

Specified by:

slice in class ASet<K extends ACell>

Parameters:

start - start index (inclusive)

end - end index (exclusive)

Returns:

Slice of set, or null if invalid slice

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 ACollection<K extends ACell>

Parameters:

bs - A byte array to which to write the encoding

pos - The offset into the byte array

Returns:

New position after writing

copyToArray

protected <R> void copyToArray(R[] arr,
 int offset)

Description copied from class: ACollection

Copies the elements of this collection in order to an array at the specified offset

Specified by:

copyToArray in class ACollection<K extends ACell>

Type Parameters:

R - Type of array elements required

Parameters:

arr -

offset -

getElementRef

public Ref<K> getElementRef(long index)

Description copied from class: ACountable

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

Specified by:

getElementRef in class ACountable<K extends ACell>

Parameters:

index - Index of element to get

Returns:

Element at the specified index

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

equals

public boolean equals(ACell a)

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:

a - Cell to compare with. May be null.

Returns:

True if this cell is equal to the other object

encodeRaw

protected 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

toCanonical

protected AHashSet<K> 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

Specified by:

isCVMValue in class ACell

Returns:

true if the object is a CVM Value, false otherwise

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