Module coneforest.psylla

Package coneforest.psylla.core

Class PsyBitArray

java.lang.Object

coneforest.psylla.core.PsyBitArray

All Implemented Interfaces:

PsyAppendable<PsyBoolean>, PsyBitwise<PsyBitArray>, PsyClearable, PsyContainer<PsyBoolean>, PsyFormalArray<PsyBoolean>, PsyIndexed<PsyInteger,PsyBoolean>, PsyIterable<PsyBoolean>, PsyLengthy, PsyLogical<PsyBitArray>, PsyObject, PsySequential<PsyBoolean>, PsyStreamable<PsyBoolean>, Iterable<PsyBoolean>

@Type("bitarray")
public class PsyBitArray
extends Object
implements PsyFormalArray<PsyBoolean>, PsyBitwise<PsyBitArray>

The representation of bitarray.

Field Summary

Fields

Modifier and Type	Field	Description
static final ContextAction	PSY_BITARRAY	Context action of the bitarray operator.

Fields inherited from interface coneforest.psylla.core.PsyAppendable

PSY_APPEND, PSY_APPENDALL

Fields inherited from interface coneforest.psylla.core.PsyBitwise

PSY_BITSHIFT, PSY_CLEARBIT, PSY_FLIPBIT, PSY_SETBIT, PSY_TESTBIT

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

PSY_AND, PSY_NOT, PSY_OR, PSY_XOR

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
PsyBitArray()	Creates a new empty bitarray.
PsyBitArray(BitSet bitarray, int size)

Method Summary

Modifier and Type	Method	Description
void	delete(int index)	Removes the element at the specified position in this array.
PsyBoolean	extract(int indexValue)
PsyBoolean	get(int index)	Returns the element at the specified position in this array.
void	insert(int index, PsyBoolean oBoolean)	Inserts the specified object into this array at the position specified by a given index.
Iterator<PsyBoolean>	iterator()
int	length()	Returns a length of this object.
PsyBitArray	psyAnd(PsyBitArray oBitArray)	Returns a result of logical conjunction of this object and given object.
void	psyAppend(PsyBoolean oBoolean)	Appends a given object to this container.
PsyBitArray	psyBitShift(PsyInteger oShift)	Returns a bitwise whose value is equivalent to this value with bits shifted at the given distance.
void	psyClear()	Clear this object.
PsyBitArray	psyClearBit(PsyInteger oBit)	Returns a bitwise whose value is equivalent to this value with the designated bit cleared.
PsyBitArray	psyClone()	Returns a clone of this object.
PsyBitArray	psyExtractInterval(PsyInteger oStart, PsyInteger oCount)
PsyBitArray	psyFlipBit(PsyInteger oBit)	Returns a bitwise whose value is equivalent to this value with the designated bit flipped.
PsyBitArray	psyGetInterval(PsyInteger oIndex, PsyInteger oCount)
PsyBitArray	psyNot()	Returns a result of logical negation of this object.
PsyBitArray	psyOr(PsyBitArray oBitArray)	Returns a result of logical disjunction of this object and given object.
void	psyPutInterval(PsyInteger oIndex, PsyIterable<? extends PsyBoolean> oIterable)
PsyBitArray	psySetBit(PsyInteger oBit)	Returns a bitwise whose value is equivalent to this value with the designated bit set.
void	psySetLength(PsyInteger oLength)
PsyBitArray	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.
PsyBoolean	psyTestBit(PsyInteger oBit)	Returns a boolean indicating if the designated bit is set.
PsyBitArray	psyXor(PsyBitArray oBitArray)	Returns a result of logical exclusive disjunction of this object and given object.
void	put(int index, PsyBoolean oBoolean)

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, psyReplicate, psyReverse, psyValues, toSyntaxString, toSyntaxStringHelper

Methods inherited from interface coneforest.psylla.core.PsyIndexed

psyGetAll

Methods inherited from interface coneforest.psylla.core.PsyIterable

psyStream, 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_BITARRAY

@OperatorType("bitarray")
public static final ContextAction PSY_BITARRAY

Context action of the bitarray operator.

Constructor Details

PsyBitArray

public PsyBitArray()

Creates a new empty bitarray.

PsyBitArray

public PsyBitArray(BitSet bitarray,
 int size)

Method Details

get

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

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 PsyBitArray psyGetInterval(PsyInteger oIndex,
 PsyInteger oCount)
                           throws PsyRangeCheckException

Specified by:

psyGetInterval in interface PsyFormalArray<PsyBoolean>

Throws:

PsyRangeCheckException

put

public void put(int index,
 PsyBoolean oBoolean)
         throws PsyRangeCheckException

Specified by:

put in interface PsyFormalArray<PsyBoolean>

Throws:

PsyRangeCheckException

psyPutInterval

public void psyPutInterval(PsyInteger oIndex,
 PsyIterable<? extends PsyBoolean> oIterable)
                    throws PsyRangeCheckException

Specified by:

psyPutInterval in interface PsyFormalArray<PsyBoolean>

Throws:

PsyRangeCheckException

psyAppend

public void psyAppend(PsyBoolean oBoolean)

Description copied from interface: PsyAppendable

Appends a given object to this container.

Specified by:

psyAppend in interface PsyAppendable<PsyBoolean>

Parameters:

oBoolean - an object to append.

insert

public void insert(int index,
 PsyBoolean oBoolean)

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<PsyBoolean>

Parameters:

index - a integer index.

oBoolean - a object.

delete

public void delete(int index)
            throws PsyRangeCheckException

Description copied from interface: PsyFormalArray

Removes the element at the specified position in this array.

Specified by:

delete in interface PsyFormalArray<PsyBoolean>

Parameters:

index - the index of the element to be removed.

Throws:

PsyRangeCheckException - if the index is out of range.

extract

public PsyBoolean extract(int indexValue)
                   throws PsyRangeCheckException

Specified by:

extract in interface PsyFormalArray<PsyBoolean>

Throws:

PsyRangeCheckException

psyExtractInterval

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

Specified by:

psyExtractInterval in interface PsyFormalArray<PsyBoolean>

Throws:

PsyRangeCheckException

psyNot

public PsyBitArray psyNot()

Description copied from interface: PsyLogical

Returns a result of logical negation of this object.

Specified by:

psyNot in interface PsyLogical<PsyBitArray>

Returns:

a result.

psyOr

public PsyBitArray psyOr(PsyBitArray oBitArray)

Description copied from interface: PsyLogical

Returns a result of logical disjunction of this object and given object.

Specified by:

psyOr in interface PsyLogical<PsyBitArray>

Parameters:

oBitArray - given object.

Returns:

a result.

psyAnd

public PsyBitArray psyAnd(PsyBitArray oBitArray)

Description copied from interface: PsyLogical

Returns a result of logical conjunction of this object and given object.

Specified by:

psyAnd in interface PsyLogical<PsyBitArray>

Parameters:

oBitArray - given object.

Returns:

a result.

psyXor

public PsyBitArray psyXor(PsyBitArray oBitArray)

Description copied from interface: PsyLogical

Returns a result of logical exclusive disjunction of this object and given object.

Specified by:

psyXor in interface PsyLogical<PsyBitArray>

Parameters:

oBitArray - given object.

Returns:

a result.

psyBitShift

public PsyBitArray psyBitShift(PsyInteger oShift)

Description copied from interface: PsyBitwise

Returns a bitwise whose value is equivalent to this value with bits shifted at the given distance. If the distance is negative, the left shift is preformed. If the distance is positive, the right shift is preformed. If the distance is zero, returns this.

Specified by:

psyBitShift in interface PsyBitwise<PsyBitArray>

Parameters:

oShift - the shift distance.

Returns:

a bitwise whose value is equivalent to this value with bits shifted at the given distance.

psyTestBit

public PsyBoolean psyTestBit(PsyInteger oBit)
                      throws PsyRangeCheckException

Description copied from interface: PsyBitwise

Returns a boolean indicating if the designated bit is set.

Specified by:

psyTestBit in interface PsyBitwise<PsyBitArray>

Parameters:

oBit - the index of bit to test.

Returns:

a boolean indicating if the designated bit set.

Throws:

PsyRangeCheckException - if the index is out of range.

psySetBit

public PsyBitArray psySetBit(PsyInteger oBit)
                      throws PsyRangeCheckException

Description copied from interface: PsyBitwise

Returns a bitwise whose value is equivalent to this value with the designated bit set.

Specified by:

psySetBit in interface PsyBitwise<PsyBitArray>

Parameters:

oBit - the index of bit to set.

Returns:

a bitwise whose value is equivalent to this value with the designated bit set.

Throws:

PsyRangeCheckException - if the index is out of range.

psyFlipBit

public PsyBitArray psyFlipBit(PsyInteger oBit)
                       throws PsyRangeCheckException

Description copied from interface: PsyBitwise

Returns a bitwise whose value is equivalent to this value with the designated bit flipped.

Specified by:

psyFlipBit in interface PsyBitwise<PsyBitArray>

Parameters:

oBit - the index of bit to flip.

Returns:

a bitwise whose value is equivalent to this value with the designated bit flipped.

Throws:

PsyRangeCheckException - if the index is out of range.

psyClearBit

public PsyBitArray psyClearBit(PsyInteger oBit)
                        throws PsyRangeCheckException

Description copied from interface: PsyBitwise

Returns a bitwise whose value is equivalent to this value with the designated bit cleared.

Specified by:

psyClearBit in interface PsyBitwise<PsyBitArray>

Parameters:

oBit - the index of bit to clear.

Returns:

a bitwise whose value is equivalent to this value with the designated bit cleared.

Throws:

PsyRangeCheckException - if the index is out of range.

iterator

public Iterator<PsyBoolean> iterator()

Specified by:

iterator in interface Iterable<PsyBoolean>

length

public int length()

Description copied from interface: PsyLengthy

Returns a length of this object.

Specified by:

length in interface PsyLengthy

Returns:

a length.

psySlice

public PsyBitArray psySlice(PsyIterable<PsyInteger> oIndices)
                     throws PsyRangeCheckException

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<PsyBoolean>

Specified by:

psySlice in interface PsyIndexed<PsyInteger,PsyBoolean>

Parameters:

oIndices - an enumeration of keys.

Returns:

a container.

Throws:

PsyRangeCheckException - when the index is out of range.

psySetLength

public void psySetLength(PsyInteger oLength)
                  throws PsyLimitCheckException,
PsyRangeCheckException

Specified by:

psySetLength in interface PsyFormalArray<PsyBoolean>

Throws:

PsyLimitCheckException

PsyRangeCheckException

psyClone

public PsyBitArray psyClone()

Description copied from interface: PsyObject

Returns a clone of this object.

Specified by:

psyClone in interface PsyFormalArray<PsyBoolean>

Specified by:

psyClone in interface PsyObject

Returns:

a clone of this object.

psyClear

public void psyClear()

Description copied from interface: PsyClearable

Clear this object.

Specified by:

psyClear in interface PsyClearable