Module coneforest.psylla

Package coneforest.psylla.core

Class PsyArray

java.lang.Object

coneforest.psylla.core.PsyArray

All Implemented Interfaces:

PsyAppendable<PsyObject>, PsyClearable, PsyContainer<PsyObject>, PsyFormalArray<PsyObject>, PsyIndexed<PsyInteger,PsyObject>, PsyIterable<PsyObject>, PsyLengthy, PsyObject, PsySequential<PsyObject>, PsyStreamable<PsyObject>, Iterable<PsyObject>

Direct Known Subclasses:

PsyProc

@Type("array")
public class PsyArray
extends Object
implements PsyFormalArray<PsyObject>

The representation of array.

Field Summary

Fields

Modifier and Type	Field	Description
static final ContextAction	PSY_ARRAY	Context action of the array operator.
static final ContextAction	PSY_ARRAYTOMARK	Context action of the arraytomark operator.
static final ContextAction	PSY_BINARYSEARCH	Context action of the binarysearch operator.
static final ContextAction	PSY_SORT	Context action of the sort operator.

Fields inherited from interface coneforest.psylla.core.PsyAppendable

PSY_APPEND, PSY_APPENDALL

Fields inherited from interface coneforest.psylla.core.PsyClearable

PSY_CLEAR

Fields inherited from interface coneforest.psylla.core.PsyFormalArray

PSY_EXTRACTINTERVAL, PSY_GETINTERVAL, PSY_INSERT, PSY_INSERTALL, PSY_POSTCHOP, PSY_PRECHOP, PSY_PREPEND, PSY_PREPENDALL, PSY_PUTINTERVAL, PSY_REVERSE, PSY_SETLENGTH

Fields inherited from interface coneforest.psylla.core.PsyIndexed

PSY_DELETE, PSY_ENTRIES, PSY_EXTRACT, PSY_GET, PSY_GETALL, PSY_KEYS, PSY_KNOWN, PSY_PUT, PSY_SLICE, PSY_VALUES

Fields inherited from interface coneforest.psylla.core.PsyLengthy

PSY_ISEMPTY, PSY_LENGTH

Fields inherited from interface coneforest.psylla.core.PsyObject

PSY_CLONE, PSY_EQ, PSY_HASHCODE, PSY_INSTANCEOF, PSY_NE, PSY_TONAME, PSY_TOSTRING, PSY_TYPE

Fields inherited from interface coneforest.psylla.core.PsySequential

PSY_FORALL

Fields inherited from interface coneforest.psylla.core.PsyStreamable

PSY_STREAM

Constructor Summary

Constructors

Constructor	Description
PsyArray()	Constructs a new empty array.
PsyArray(ArrayList<PsyObject> array)	Constructs a new array wrapped around the given array list.

Method Summary

Modifier and Type	Method	Description
void	delete(int indexValue)	Removes the element at the specified position in this array.
PsyObject	extract(int indexValue)
PsyObject	get(int index)	Returns the element at the specified position in this array.
void	insert(int indexValue, PsyObject o)	Inserts the specified object into this array at the position specified by a given index.
Iterator<PsyObject>	iterator()
int	length()	Returns a length of this object.
void	psyAppend(PsyObject o)	Appends a given object to this container.
PsyInteger	psyBinarySearch(PsyObject o, PsyProc oComparator, PsyContext oContext)	Searches this array for the specified value using the binary search algorithm.
void	psyClear()	Clear this object.
PsyArray	psyClone()	Returns a clone of this object.
PsyArray	psyExtractInterval(PsyInteger oStart, PsyInteger oCount)
PsyArray	psyGetInterval(PsyInteger oStart, PsyInteger oCount)
void	psySetLength(PsyInteger oLength)
PsyArray	psySlice(PsyIterable<PsyInteger> oIndices)	Returns a container of the same type as this object consisting of keys or indices from given iterable and of associated values.
void	psySort(PsyProc oComparator, PsyContext oContext)	Sorts this list according to the order induced by the specified comparator.
PsyStream	psyStream()
void	put(int indexValue, PsyObject o)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface coneforest.psylla.core.PsyAppendable

psyAppendAll

Methods inherited from interface coneforest.psylla.core.PsyContainer

psyNewEmpty

Methods inherited from interface coneforest.psylla.core.PsyFormalArray

psyDelete, psyEntries, psyExtract, psyGet, psyInsert, psyInsertAll, psyKeys, psyKnown, psyPostChop, psyPreChop, psyPrepend, psyPrependAll, psyPut, psyPutInterval, psyReplicate, psyReverse, psyValues, toSyntaxString, toSyntaxStringHelper

Methods inherited from interface coneforest.psylla.core.PsyIndexed

psyGetAll

Methods inherited from interface coneforest.psylla.core.PsyIterable

psyToArray, psyUnite

Methods inherited from interface coneforest.psylla.core.PsyLengthy

isEmpty, psyIsEmpty, psyLength

Methods inherited from interface coneforest.psylla.core.PsyObject

convert, execute, invoke, psyEq, psyHashCode, psyInstanceOf, psyNe, psySyntax, psyToName, psyToString, psyType, typeName

Methods inherited from interface coneforest.psylla.core.PsyStreamable

psyForAll

Field Details

PSY_ARRAY

@OperatorType("array")
public static final ContextAction PSY_ARRAY

Context action of the array operator.

PSY_ARRAYTOMARK

@OperatorType("arraytomark")
public static final ContextAction PSY_ARRAYTOMARK

Context action of the arraytomark operator.

PSY_BINARYSEARCH

@OperatorType("binarysearch")
public static final ContextAction PSY_BINARYSEARCH

Context action of the binarysearch operator.

PSY_SORT

@OperatorType("sort")
public static final ContextAction PSY_SORT

Context action of the sort operator.

Constructor Details

PsyArray

public PsyArray()

Constructs a new empty array.

PsyArray

public PsyArray(ArrayList<PsyObject> array)

Constructs a new array wrapped around the given array list.

Parameters:

array - a given array list.

Method Details

length

public int length()

Description copied from interface: PsyLengthy

Returns a length of this object.

Specified by:

length in interface PsyLengthy

Returns:

a length.

iterator

public Iterator<PsyObject> iterator()

Specified by:

iterator in interface Iterable<PsyObject>

psyClone

public PsyArray psyClone()

Description copied from interface: PsyObject

Returns a clone of this object.

Specified by:

psyClone in interface PsyFormalArray<PsyObject>

Specified by:

psyClone in interface PsyObject

Returns:

a clone of this object.

get

public PsyObject get(int index)
              throws PsyRangeCheckException

Description copied from interface: PsyFormalArray

Returns the element at the specified position in this array.

Specified by:

get in interface PsyFormalArray<PsyObject>

Parameters:

index - the index of the element.

Returns:

the element at the specified position in this list.

Throws:

PsyRangeCheckException - if the index is out of range.

psyGetInterval

public PsyArray psyGetInterval(PsyInteger oStart,
 PsyInteger oCount)
                        throws PsyRangeCheckException

Specified by:

psyGetInterval in interface PsyFormalArray<PsyObject>

Throws:

PsyRangeCheckException

psyAppend

public void psyAppend(PsyObject o)
               throws PsyLimitCheckException

Description copied from interface: PsyAppendable

Appends a given object to this container.

Specified by:

psyAppend in interface PsyAppendable<PsyObject>

Parameters:

o - an object to append.

Throws:

PsyLimitCheckException - when TODO.

insert

public void insert(int indexValue,
 PsyObject o)
            throws PsyRangeCheckException

Description copied from interface: PsyFormalArray

Inserts the specified object into this array at the position specified by a given index.

Specified by:

insert in interface PsyFormalArray<PsyObject>

Parameters:

indexValue - a integer index.

o - a object.

Throws:

PsyRangeCheckException - when TODO.

put

public void put(int indexValue,
 PsyObject o)
         throws PsyRangeCheckException

Specified by:

put in interface PsyFormalArray<PsyObject>

Throws:

PsyRangeCheckException

delete

public void delete(int indexValue)
            throws PsyRangeCheckException

Description copied from interface: PsyFormalArray

Removes the element at the specified position in this array.

Specified by:

delete in interface PsyFormalArray<PsyObject>

Parameters:

indexValue - the index of the element to be removed.

Throws:

PsyRangeCheckException - if the index is out of range.

extract

public PsyObject extract(int indexValue)
                  throws PsyRangeCheckException

Specified by:

extract in interface PsyFormalArray<PsyObject>

Throws:

PsyRangeCheckException

psyExtractInterval

public PsyArray psyExtractInterval(PsyInteger oStart,
 PsyInteger oCount)
                            throws PsyRangeCheckException

Specified by:

psyExtractInterval in interface PsyFormalArray<PsyObject>

Throws:

PsyRangeCheckException

psySlice

public PsyArray psySlice(PsyIterable<PsyInteger> oIndices)
                  throws PsyRangeCheckException,
PsyLimitCheckException

Description copied from interface: PsyIndexed

Returns a container of the same type as this object consisting of keys or indices from given iterable and of associated values.

Specified by:

psySlice in interface PsyFormalArray<PsyObject>

Specified by:

psySlice in interface PsyIndexed<PsyInteger,PsyObject>

Parameters:

oIndices - an enumeration of keys.

Returns:

a container.

Throws:

PsyRangeCheckException - when the index is out of range.

PsyLimitCheckException - when TODO

psyClear

public void psyClear()

Description copied from interface: PsyClearable

Clear this object.

Specified by:

psyClear in interface PsyClearable

psySetLength

public void psySetLength(PsyInteger oLength)
                  throws PsyRangeCheckException,
PsyLimitCheckException

Specified by:

psySetLength in interface PsyFormalArray<PsyObject>

Throws:

PsyRangeCheckException

PsyLimitCheckException

psySort

public void psySort(PsyProc oComparator,
 PsyContext oContext)

Sorts this list according to the order induced by the specified comparator. The sort is stable: this method must not reorder equal elements.

Parameters:

oComparator - the proc comparator used to compare array elements.

oContext - the execution context.

psyBinarySearch

public PsyInteger psyBinarySearch(PsyObject o,
 PsyProc oComparator,
 PsyContext oContext)

Searches this array for the specified value using the binary search algorithm. The array must be sorted into ascending order according to the specified comparator. TODO

Parameters:

o - the value to be searched for.

oComparator - the comparator by which the array is ordered.

oContext - the execution context.

Returns:

TODO

psyStream

public PsyStream psyStream()

Specified by:

psyStream in interface PsyIterable<PsyObject>

Specified by:

psyStream in interface PsyStreamable<PsyObject>