Module coneforest.psylla

Package coneforest.psylla.core

Class PsyBitSet

java.lang.Object

coneforest.psylla.core.PsyBitSet

All Implemented Interfaces:

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

@Type("bitset")
public class PsyBitSet
extends Object
implements PsyFormalSet<PsyInteger>

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

Field Summary

Fields

Modifier and Type	Field	Description
static final ContextAction	PSY_BITSET	Context action of the bitset operator.

Fields inherited from interface coneforest.psylla.core.PsyAppendable

PSY_APPEND, PSY_APPENDALL, PSY_REPLICATE

Fields inherited from interface coneforest.psylla.core.PsyClearable

PSY_CLEAR

Fields inherited from interface coneforest.psylla.core.PsyFormalSet

PSY_CONTAINS, PSY_INTERSECTS, PSY_REMOVE, PSY_REMOVEALL, PSY_RETAINALL

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_TOSTRING, PSY_TOSTRINGBUFFER, 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
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
boolean	equals(Object obj)
int	hashCode()
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(PsyObject oElement)	Returns a boolean object indicating whether a given object belongs to this set.
PsyBoolean	psyIntersects(PsyFormalSet<? extends PsyInteger> 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.
PsyFormalStream<PsyInteger>	psyStream()
String	toSyntaxString()	Returns the syntactic representation of this object.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface coneforest.psylla.core.PsyContainer

psyNewEmpty

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

Methods inherited from interface coneforest.psylla.core.PsyStreamable

psyForAll

Field Details

PSY_BITSET

@OperatorType("bitset")
public static final ContextAction PSY_BITSET

Context action of the bitset operator.

Constructor Details

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 Details

psyClone

public PsyBitSet psyClone()

Description copied from interface: PsyObject

Returns a clone of this object.

Specified by:

psyClone in interface PsyFormalSet<PsyInteger>

Specified by:

psyClone in interface PsyObject

Returns:

a clone of this object

toSyntaxString

public String toSyntaxString()

Description copied from interface: PsyObject

Returns the syntactic representation of this object.

Specified by:

toSyntaxString in interface PsyFormalSet<PsyInteger>

Specified by:

toSyntaxString in interface PsyObject

Returns:

the syntactic representation of this object

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 - when TODO.

PsyRangeCheckException - when TODO.

psyAppendAll

public void psyAppendAll(PsyIterable<? extends PsyInteger> oIterable)
                  throws PsyLimitCheckException,
PsyRangeCheckException

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:

PsyLimitCheckException - when TODO.

PsyRangeCheckException - when TODO.

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 of this object

psyContains

public PsyBoolean psyContains(PsyObject 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:

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

psyIntersects

public PsyBoolean psyIntersects(PsyFormalSet<? extends PsyInteger> 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:

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

psyStream

public PsyFormalStream<PsyInteger> psyStream()

Specified by:

psyStream in interface PsyIterable<PsyInteger>

Specified by:

psyStream in interface PsyStreamable<PsyInteger>

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Specified by:

equals in interface PsyFormalSet<PsyInteger>

Overrides:

equals in class Object