net.sf.oriented.omi

Interface SetOf<ITEM,SET extends SetOf<ITEM,SET>>

Type Parameters:

ITEM -

SET -

All Superinterfaces:

Iterable<ITEM>, Verify

All Known Subinterfaces:

MatroidAsSet, OMasSignedSet, SetOfSignedSet, SetOfUnsignedSet, UnsignedSet

public interface SetOf<ITEM,SET extends SetOf<ITEM,SET>>
extends Verify, Iterable<ITEM>

Immutable mathematical sets. Supports the standard mathematical operations of: union(SetOf); intersection(SetOf); set difference - minus(SetOf); isSubsetOf(SetOf); isEmpty(); membership contains(Object). Also supports operation which relate to java sets such as Iterable.iterator(), asCollection(). The two operations to produce sets of subsets produce java sets, these are powerSet() and subsetsOfSize(int). sameSetAs(SetOf) implements mathematical set equality, and Object.equals(Object) may be mathematical set equality or not. This is indicated by equalsIsSameSetAs()

Author:

jeremycarroll

Method Summary

Methods

Modifier and Type	Method and Description
JavaSet<? extends ITEM>	asCollection()
boolean	contains(ITEM a)
boolean	equalsIsSameSetAs() This indicates whether in the implementing class the notion of equality is set equality or not.
int	hashCode() Returns the hash code value for this set.
SET	intersection(SET b)
boolean	isEmpty()
boolean	isSubsetOf(SET b)
boolean	isSupersetOf(SET b)
SET	minus(ITEM b)
SET	minus(SET b)
JavaSet<? extends SET>	powerSet()
SET	respectingEquals() Return a set s such that: s.sameSetSetAs(this) && s.equalsIsSameSetAs().
boolean	sameSetAs(SET other) This is mathematically set equality, except for empty sets - which respect type as well.
int	size()
JavaSet<? extends SET>	subsetsOfSize(int i)
ITEM[]	toArray() An array of the members of this set.
SET	union(ITEM b) Set union with the singleton set containing b
SET	union(SET b) Set union.
void	verify() Check invariants of the object, in particular check that Object.hashCode() satisfies its contract.

Methods inherited from interface java.lang.Iterable

iterator

Method Detail

union

SET union(SET b)

Set union.

Parameters:

b - A second set

Returns:

The union of this and b

toArray

ITEM[] toArray()

An array of the members of this set.

sameSetAs

boolean sameSetAs(SET other)

This is mathematically set equality, except for empty sets - which respect type as well. (This is not very well-defined).

Parameters:

other -

Returns:

true if the two sets have the same members.

equalsIsSameSetAs

boolean equalsIsSameSetAs()

This indicates whether in the implementing class the notion of equality is set equality or not. For example, some classes that implement this interface may also implement OM which defines equality as Oriented Matroid equality which is not the same as set equality.

Returns:

true if Object.equals(Object) and sameSetAs(SetOf) return identical results.

hashCode

int hashCode()

Returns the hash code value for this set. If equalsIsSameSetAs() is true, then the hash code of a set is defined to be the sum of the hash codes of the elements in the set, see Set.hashCode(). If equalsIsSameSetAs() is false, then the hash code of a set is not restricted except to the general contract, see Object.hashCode().

Overrides:

hashCode in class Object

Returns:

the hash code value for this set

See Also:

Object.equals(Object), Set.equals(Object)

respectingEquals

SET respectingEquals()

Return a set s such that: s.sameSetSetAs(this) && s.equalsIsSameSetAs(). If equalsIsSameSetAs() is true, then this method should usually return this. If equalsIsSameSetAs() is false, then a different SET containing the same members is returned.

Returns:

a set with the same members.

union

SET union(ITEM b)

Set union with the singleton set containing b

Parameters:

b - The new member to be added

Returns:

The union

intersection

SET intersection(SET b)

minus

SET minus(SET b)

minus

SET minus(ITEM b)

contains

boolean contains(ITEM a)

size

int size()

isSubsetOf

boolean isSubsetOf(SET b)

isSupersetOf

boolean isSupersetOf(SET b)

isEmpty

boolean isEmpty()

asCollection

JavaSet<? extends ITEM> asCollection()

powerSet

JavaSet<? extends SET> powerSet()

subsetsOfSize

JavaSet<? extends SET> subsetsOfSize(int i)

verify

void verify()
            throws AxiomViolation

Check invariants of the object, in particular check that Object.hashCode() satisfies its contract.

Specified by:

verify in interface Verify

Throws:

AxiomViolation - if the set violates its contract.