org.protelis.lang.datatype.impl

Class ArrayTupleImpl

java.lang.Object

org.protelis.lang.datatype.impl.ArrayTupleImpl

All Implemented Interfaces:

Serializable, Comparable<Tuple>, Iterable<Object>, Tuple

public class ArrayTupleImpl
extends Object
implements Tuple

Implementation of a Tuple using an array data structure.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private Object[]	arrayContents
private static Comparator<Object>	COMPARE_TO
private int	hash
private static long	serialVersionUID
private String	string

Constructor Summary

Constructors

Modifier	Constructor and Description
	ArrayTupleImpl(Object... base)
private	ArrayTupleImpl(Object[] base, boolean copy)
	ArrayTupleImpl(Object value, int length) Create an ArrayTupleImpl with all elements initialized to a given value.

Method Summary

Modifier and Type	Method and Description
Tuple	append(Object element) Add an element to the end of a tuple.
private static int	compareLexicographically(Object a, Object b)
int	compareTo(Tuple o)
boolean	contains(Object element) Tests whether the tuple has an element equal to its argument.
boolean	equals(Object o)
Tuple	filter(ExecutionContext ctx, FunctionDefinition fun) Given a tuple and a predicate, returns a new tuple containing only the elements that match the predicate.
Tuple	filter(Predicate<Object> fun) Given a tuple and a Predicate, returns a new tuple containing only the elements that match the predicate.
Object	get(double i) Compatibility method to speed up calls made using doubles.
Object	get(Double i) Compatibility method to speed up calls made using doubles.
Object	get(int i) Retrieve the object at one of a tuple's indices.
int	hashCode()
int	indexof(Object element) Searches for an element in a tuple, returning its index if found.
Tuple	insert(int i, Object element) Add an element to an arbitrary location within a tuple, moving all elements after it down.
Tuple	intersection(Tuple t) Set arithmetic: compute intersection of set of tuple elements with set of elements of another tuple.
boolean	isEmpty()
Iterator<Object>	iterator()
Tuple	map(ExecutionContext ctx, FunctionDefinition fun) Maps a tuple to another same-length tuple by applying a function to each element.
Tuple	map(Function<Object,Object> fun) Maps a tuple to another same-length tuple by applying a function to each element.
Object	max(Object def)
Tuple	mergeAfter(Tuple tuple) Append elements of another tuple to the end of this tuple.
Object	min(Object def)
Tuple	prepend(Object element) Add an element to the start of a tuple.
Object	reduce(ExecutionContext ctx, Object defVal, FunctionDefinition fun) Performs a reduction operation, that maps a tuple to a single value.
Object	reduce(Object defVal, BinaryOperator<Object> fun) Performs a reduction operation, that maps a tuple to a single value.
Tuple	set(int i, Object element) Replace an element in a tuple.
int	size()
Tuple	sort()
Tuple	subtract(Tuple t) Set arithmetic: compute which elements in this tuple are not in another tuple.
ArrayTupleImpl	subTuple(int i, int j) Produces a new Tuple containing the elements between the start and end indices.
ArrayTupleImpl	subTupleEnd(int i) Produces a new Tuple containing all elements from i onward.
ArrayTupleImpl	subTupleStart(int i) Produces a new Tuple containing the first i elements.
String	toString()
ArrayTupleImpl	union(Tuple t) Set arithmetic: compute union of set of tuple elements with set of elements of another tuple.
Tuple	unwrap(int i) For all elements that are tuples, substitute the ith sub-element.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

arrayContents

private final Object[] arrayContents

hash

private int hash

string

private String string

COMPARE_TO

private static final Comparator<Object> COMPARE_TO

Constructor Detail

ArrayTupleImpl

public ArrayTupleImpl(Object... base)

Parameters:

base - the elements

ArrayTupleImpl

private ArrayTupleImpl(Object[] base,
                       boolean copy)

ArrayTupleImpl

public ArrayTupleImpl(Object value,
                      int length)

Create an ArrayTupleImpl with all elements initialized to a given value.

Parameters:

value - The value to initialize to

length - The length of the tuple

Method Detail

iterator

public Iterator<Object> iterator()

Specified by:

iterator in interface Iterable<Object>

get

public Object get(int i)

Description copied from interface: Tuple

Retrieve the object at one of a tuple's indices.

Specified by:

get in interface Tuple

Parameters:

i - Zero-based index of the object to be retrieved

Returns:

The object at index i

get

public Object get(double i)

Compatibility method to speed up calls made using doubles.

Parameters:

i - the element position (will be floored to int)

Returns:

the i-th element

get

public Object get(Double i)

Compatibility method to speed up calls made using doubles.

Parameters:

i - the element position (will be floored to int)

Returns:

the i-th element

size

public int size()

Specified by:

size in interface Tuple

Returns:

Number of elements in the tuple

subTupleEnd

public ArrayTupleImpl subTupleEnd(int i)

Description copied from interface: Tuple

Produces a new Tuple containing all elements from i onward. Equivalent to subTuple(i,Tuple.size()).

Specified by:

subTupleEnd in interface Tuple

Parameters:

i - First element to take for new tuple

Returns:

a new tuple containing elements i through size-1

subTupleStart

public ArrayTupleImpl subTupleStart(int i)

Description copied from interface: Tuple

Produces a new Tuple containing the first i elements. Equivalent to subTuple(0,i).

Specified by:

subTupleStart in interface Tuple

Parameters:

i - Number of elements to take

Returns:

a new tuple containing elements 0 through i-1

compareTo

public int compareTo(Tuple o)

Specified by:

compareTo in interface Comparable<Tuple>

append

public Tuple append(Object element)

Description copied from interface: Tuple

Add an element to the end of a tuple. Equivalent to insert(size, element).

Specified by:

append in interface Tuple

Parameters:

element - Element to be added

Returns:

A new tuple with equal to the current plus the new element added to the end

insert

public Tuple insert(int i,
                    Object element)

Description copied from interface: Tuple

Add an element to an arbitrary location within a tuple, moving all elements after it down.

Specified by:

insert in interface Tuple

Parameters:

i - Zero-based index at which the element is to be added

element - Element to be added

Returns:

A new tuple with equal to the current plus the new element added at the given index

set

public Tuple set(int i,
                 Object element)

Description copied from interface: Tuple

Replace an element in a tuple.

Specified by:

set in interface Tuple

Parameters:

i - Zero-based index at which the element is to be replaced

element - Element to replace the current element

Returns:

A new tuple with the element at the ith index replaced by "element"

subTuple

public ArrayTupleImpl subTuple(int i,
                               int j)

Description copied from interface: Tuple

Produces a new Tuple containing the elements between the start and end indices. The start index is inclusive, the end index exclusive.

Specified by:

subTuple in interface Tuple

Parameters:

i - start index

j - end index

Returns:

a new tuple containing elements i through j-1

mergeAfter

public Tuple mergeAfter(Tuple tuple)

Description copied from interface: Tuple

Append elements of another tuple to the end of this tuple.

Specified by:

mergeAfter in interface Tuple

Parameters:

tuple - tuple to be added

Returns:

a new tuple

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Tuple

Returns:

Returns true iff the size of the tuple is zero

contains

public boolean contains(Object element)

Description copied from interface: Tuple

Tests whether the tuple has an element equal to its argument.

Specified by:

contains in interface Tuple

Parameters:

element - Element to test whether it is equal to any element in the tuple

Returns:

true if the tuple contains an element equal to "element"

indexof

public int indexof(Object element)

Description copied from interface: Tuple

Searches for an element in a tuple, returning its index if found.

Specified by:

indexof in interface Tuple

Parameters:

element - The object to be searched for

Returns:

The first index where the search object is found, or -1 if not found

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

unwrap

public Tuple unwrap(int i)

Description copied from interface: Tuple

For all elements that are tuples, substitute the ith sub-element. For example: [[1,2],3,[4,5],6].unwrap(1) produces [2,3,5,6].

Specified by:

unwrap in interface Tuple

Parameters:

i - index of sub-element to substitute

Returns:

a new tuple with substituted elements

union

public ArrayTupleImpl union(Tuple t)

Description copied from interface: Tuple

Set arithmetic: compute union of set of tuple elements with set of elements of another tuple.

Specified by:

union in interface Tuple

Parameters:

t - tuple to take union with

Returns:

a new tuple containing elements appearing in either tuple, in arbitrary order

intersection

public Tuple intersection(Tuple t)

Description copied from interface: Tuple

Set arithmetic: compute intersection of set of tuple elements with set of elements of another tuple.

Specified by:

intersection in interface Tuple

Parameters:

t - tuple to take intersection with

Returns:

a new tuple containing elements appearing in both tuples, in arbitrary order

subtract

public Tuple subtract(Tuple t)

Description copied from interface: Tuple

Set arithmetic: compute which elements in this tuple are not in another tuple.

Specified by:

subtract in interface Tuple

Parameters:

t - tuple to subtract

Returns:

a new tuple containing elements not in t, in arbitrary order

reduce

public Object reduce(ExecutionContext ctx,
                     Object defVal,
                     FunctionDefinition fun)

Description copied from interface: Tuple

Performs a reduction operation, that maps a tuple to a single value.

Specified by:

reduce in interface Tuple

Parameters:

ctx - the current execution context

defVal - the value that will be returned if the tuple is empty

fun - the BinaryOperator that will be applied to each couple of values

Returns:

a single value of this tuple, or the default value if empty

reduce

public Object reduce(Object defVal,
                     BinaryOperator<Object> fun)

Description copied from interface: Tuple

Performs a reduction operation, that maps a tuple to a single value.

Specified by:

reduce in interface Tuple

Parameters:

defVal - the value that will be returned if the tuple is empty

fun - the BinaryOperator that will be applied to each couple of values

Returns:

a single value of this tuple, or the default value if empty

map

public Tuple map(ExecutionContext ctx,
                 FunctionDefinition fun)

Description copied from interface: Tuple

Maps a tuple to another same-length tuple by applying a function to each element.

Specified by:

map in interface Tuple

Parameters:

ctx - the current execution context

fun - the function to apply

Returns:

a new tuple containing the values

map

public Tuple map(Function<Object,Object> fun)

Description copied from interface: Tuple

Maps a tuple to another same-length tuple by applying a function to each element.

Specified by:

map in interface Tuple

Parameters:

fun - the function to apply

Returns:

a new tuple containing the values

filter

public Tuple filter(ExecutionContext ctx,
                    FunctionDefinition fun)

Description copied from interface: Tuple

Given a tuple and a predicate, returns a new tuple containing only the elements that match the predicate.

Specified by:

filter in interface Tuple

Parameters:

ctx - the current execution context

fun - the predicate

Returns:

a new tuple containing only the elements that match the predicate

filter

public Tuple filter(Predicate<Object> fun)

Description copied from interface: Tuple

Given a tuple and a Predicate, returns a new tuple containing only the elements that match the predicate.

Specified by:

filter in interface Tuple

Parameters:

fun - the Predicate

Returns:

a new tuple containing only the elements that match the Predicate

prepend

public Tuple prepend(Object element)

Description copied from interface: Tuple

Add an element to the start of a tuple. Equivalent to insert(0, element).

Specified by:

prepend in interface Tuple

Parameters:

element - Element to be added

Returns:

A new tuple with equal to the current plus the new element added to the start

sort

public Tuple sort()

Specified by:

sort in interface Tuple

Returns:

a sorted version of this tuple

compareLexicographically

private static int compareLexicographically(Object a,
                                            Object b)

min

public Object min(Object def)

Specified by:

min in interface Tuple

Parameters:

def - the return in case min is not defined

Returns:

the smallest element of this tuple, if defined, or default otherwise

max

public Object max(Object def)

Specified by:

max in interface Tuple

Parameters:

def - the return in case max is not defined

Returns:

the biggest element of this tuple, if defined, or default otherwise