Package coneforest.psylla.core

Class PsyBitSet

java.lang.Object

coneforest.psylla.core.PsyBitSet

All Implemented Interfaces:

PsyAppendable<PsyInteger>, PsyClearable, PsyContainer<PsyInteger>, PsyConvertableToName, PsyConvertableToString, PsyFormalSet<PsyInteger>, PsyIterable<PsyInteger>, PsyLengthy, PsyObject, PsySequential<PsyInteger>, PsyStreamable<PsyInteger>, Iterable<PsyInteger>

public class PsyBitSet
extends Object
implements PsyFormalSet<PsyInteger>

A representation of bitset, a set of nonnegative integer objects.

Field Summary

Fields

Modifier and Type	Field	Description
static PsyOperator[]	OPERATORS

Constructor Summary

Constructors

Constructor	Description
PsyBitSet()	Instantiate an empty bitset object.
PsyBitSet(BitSet bitset)	Instantiate a bitset object from a given BitSet object.

Method Summary

Modifier and Type	Method	Description
BitSet	getBitSet()
Iterator<PsyInteger>	iterator()
int	length()	Returns a length of this object.
void	psyAppend(PsyInteger oIndex)	Appends a given object to this container.
void	psyAppendAll(PsyIterable<? extends PsyInteger> oIterable)	Appends all the objects from a given iterable enumeration to this set.
void	psyClear()	Removes all the elements from this set.
PsyBitSet	psyClone()	Returns a clone of this object.
PsyBoolean	psyContains(PsyInteger oElement)	Returns a boolean object indicating whether a given object belongs to this set.
PsyBoolean	psyEq(PsyObject o)
PsyBoolean	psyIntersects(PsyFormalSet oSet)	Returns a boolean object indicating whether a given formalset set intersects with this set.
void	psyRemove(PsyInteger oIndex)	Removes an object from this set.
void	psyRemoveAll(PsyIterable<? extends PsyInteger> oIterable)	Removes all the objects in a given iterable enumeration from this set.
PsyStream	psyStream()
String	toSyntaxString()

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

psyNewEmpty, toSyntaxStringHelper

Methods inherited from interface coneforest.psylla.core.PsyFormalSet

psyReplicate, psyRetainAll, toSyntaxStringHelper

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, psyHashCode, psyInstanceOf, psyNe, psySyntax, psyToName, psyToString, psyType, typeName

Methods inherited from interface coneforest.psylla.core.PsyStreamable

psyForAll

Field Detail

OPERATORS

public static final PsyOperator[] OPERATORS

Constructor Detail

PsyBitSet

public PsyBitSet()

Instantiate an empty bitset object.

PsyBitSet

public PsyBitSet(BitSet bitset)

Instantiate a bitset object from a given BitSet object.

Parameters:

bitset - a bit set.

Method Detail

psyClone

public PsyBitSet psyClone()

Description copied from interface: PsyObject

Returns a clone of this object.

Specified by:

psyClone in interface PsyObject

Returns:

a clone of this object.

toSyntaxString

public String toSyntaxString()

Specified by:

toSyntaxString in interface PsyFormalSet<PsyInteger>

Specified by:

toSyntaxString in interface PsyObject

getBitSet

public BitSet getBitSet()

psyAppend

public void psyAppend(PsyInteger oIndex)
               throws PsyLimitCheckException,
                      PsyRangeCheckException

Description copied from interface: PsyAppendable

Appends a given object to this container.

Specified by:

psyAppend in interface PsyAppendable<PsyInteger>

Parameters:

oIndex - an object to append.

Throws:

PsyLimitCheckException

PsyRangeCheckException

psyAppendAll

public void psyAppendAll(PsyIterable<? extends PsyInteger> oIterable)
                  throws PsyErrorException

Description copied from interface: PsyFormalSet

Appends all the objects from a given iterable enumeration to this set. When a given enumeration is the same as this set, first clone the enumeration, and then appends all the elements from the clone.

Specified by:

psyAppendAll in interface PsyAppendable<PsyInteger>

Specified by:

psyAppendAll in interface PsyFormalSet<PsyInteger>

Parameters:

oIterable - an iterable enumeration.

Throws:

PsyErrorException - when an error occurs.

psyRemove

public void psyRemove(PsyInteger oIndex)

Description copied from interface: PsyFormalSet

Removes an object from this set. If a given object is not present in this set, error does not occur.

Specified by:

psyRemove in interface PsyFormalSet<PsyInteger>

Parameters:

oIndex - an object.

psyRemoveAll

public void psyRemoveAll(PsyIterable<? extends PsyInteger> oIterable)

Description copied from interface: PsyFormalSet

Removes all the objects in a given iterable enumeration from this set. If some object is not present in this set, error does not occur.

Specified by:

psyRemoveAll in interface PsyFormalSet<PsyInteger>

Parameters:

oIterable - an iterable enumeration.

iterator

public Iterator<PsyInteger> iterator()

Specified by:

iterator in interface Iterable<PsyInteger>

psyClear

public void psyClear()

Description copied from interface: PsyFormalSet

Removes all the elements from this set.

Specified by:

psyClear in interface PsyClearable

Specified by:

psyClear in interface PsyFormalSet<PsyInteger>

length

public int length()

Description copied from interface: PsyLengthy

Returns a length of this object.

Specified by:

length in interface PsyLengthy

Returns:

a length.

psyContains

public PsyBoolean psyContains(PsyInteger oElement)

Description copied from interface: PsyFormalSet

Returns a boolean object indicating whether a given object belongs to this set.

Specified by:

psyContains in interface PsyFormalSet<PsyInteger>

Parameters:

oElement - an object.

Returns:

PsyBoolean.TRUE, if an object belongs to this set, and PsyBoolean.FALSE otherwise.

psyIntersects

public PsyBoolean psyIntersects(PsyFormalSet oSet)

Description copied from interface: PsyFormalSet

Returns a boolean object indicating whether a given formalset set intersects with this set.

Specified by:

psyIntersects in interface PsyFormalSet<PsyInteger>

Parameters:

oSet - a formalset set.

Returns:

PsyBoolean.TRUE, if a given formalset set intersects with this set, and PsyBoolean.FALSE otherwise.

psyEq

public PsyBoolean psyEq(PsyObject o)

Specified by:

psyEq in interface PsyObject

psyStream

public PsyStream psyStream()

Specified by:

psyStream in interface PsyIterable<PsyInteger>

Specified by:

psyStream in interface PsyStreamable<PsyInteger>