org.jscience.util
Interface Relation

All Superinterfaces:
java.util.Collection, java.lang.Iterable, java.util.Set
All Known Implementing Classes:
BinaryRelation, NAryRelation, UnaryRelation

public interface Relation
extends java.util.Set

A class representing a relation in n dimensions, or R(n). A unary realtion is the typical set.


Method Summary
 boolean add(NAry nAry)
          DOCUMENT ME!
 boolean add(java.lang.Object o)
          DOCUMENT ME!
 boolean add(java.lang.Object[] o)
          DOCUMENT ME!
 boolean addAll(java.util.Collection c)
          DOCUMENT ME!
 boolean addAll(Relation r)
          DOCUMENT ME!
 void clear()
          DOCUMENT ME!
 java.lang.Object clone()
          DOCUMENT ME!
 boolean contains(NAry nAry)
          DOCUMENT ME!
 boolean contains(java.lang.Object o)
          DOCUMENT ME!
 boolean contains(java.lang.Object[] o)
          DOCUMENT ME!
 boolean contains(java.lang.Object object, int i)
          DOCUMENT ME!
 boolean containsAll(java.util.Collection c)
          DOCUMENT ME!
 boolean containsAll(Relation r)
          DOCUMENT ME!
 boolean equals(java.lang.Object o)
          DOCUMENT ME!
 java.util.Set get(int i)
          DOCUMENT ME!
 java.util.Set getAll()
          DOCUMENT ME!
 int getDimension()
          DOCUMENT ME!
 java.util.Set getElements(java.lang.Object object, int i)
          DOCUMENT ME!
 boolean isEmpty()
          DOCUMENT ME!
 boolean isFunction(int i)
          DOCUMENT ME!
 java.util.Iterator iterator()
          DOCUMENT ME!
 boolean remove(NAry nAry)
          DOCUMENT ME!
 boolean remove(java.lang.Object o)
          DOCUMENT ME!
 boolean remove(java.lang.Object[] o)
          DOCUMENT ME!
 boolean removeAll(java.util.Collection c)
          DOCUMENT ME!
 boolean removeAll(Relation r)
          DOCUMENT ME!
 boolean retainAll(java.util.Collection c)
          DOCUMENT ME!
 boolean retainAll(Relation r)
          DOCUMENT ME!
 int size()
          DOCUMENT ME!
 java.lang.Object[] toArray()
          DOCUMENT ME!
 java.lang.Object[] toArray(NAry[] a)
          DOCUMENT ME!
 java.lang.Object[] toArray(java.lang.Object[] a)
          DOCUMENT ME!
 java.lang.String toString()
          DOCUMENT ME!
 
Methods inherited from interface java.util.Set
hashCode
 

Method Detail

getDimension

int getDimension()
DOCUMENT ME!

Returns:
DOCUMENT ME!

add

boolean add(java.lang.Object o)
DOCUMENT ME!

Specified by:
add in interface java.util.Collection
Specified by:
add in interface java.util.Set
Parameters:
o - DOCUMENT ME!
Returns:
DOCUMENT ME!

add

boolean add(NAry nAry)
DOCUMENT ME!

Parameters:
nAry - DOCUMENT ME!
Returns:
DOCUMENT ME!

add

boolean add(java.lang.Object[] o)
DOCUMENT ME!

Parameters:
o - DOCUMENT ME!
Returns:
DOCUMENT ME!

clear

void clear()
DOCUMENT ME!

Specified by:
clear in interface java.util.Collection
Specified by:
clear in interface java.util.Set

clone

java.lang.Object clone()
DOCUMENT ME!

Returns:
DOCUMENT ME!

contains

boolean contains(java.lang.Object o)
DOCUMENT ME!

Specified by:
contains in interface java.util.Collection
Specified by:
contains in interface java.util.Set
Parameters:
o - DOCUMENT ME!
Returns:
DOCUMENT ME!

contains

boolean contains(NAry nAry)
DOCUMENT ME!

Parameters:
nAry - DOCUMENT ME!
Returns:
DOCUMENT ME!

contains

boolean contains(java.lang.Object[] o)
DOCUMENT ME!

Parameters:
o - DOCUMENT ME!
Returns:
DOCUMENT ME!

isEmpty

boolean isEmpty()
DOCUMENT ME!

Specified by:
isEmpty in interface java.util.Collection
Specified by:
isEmpty in interface java.util.Set
Returns:
DOCUMENT ME!

iterator

java.util.Iterator iterator()
DOCUMENT ME!

Specified by:
iterator in interface java.util.Collection
Specified by:
iterator in interface java.lang.Iterable
Specified by:
iterator in interface java.util.Set
Returns:
DOCUMENT ME!

remove

boolean remove(java.lang.Object o)
DOCUMENT ME!

Specified by:
remove in interface java.util.Collection
Specified by:
remove in interface java.util.Set
Parameters:
o - DOCUMENT ME!
Returns:
DOCUMENT ME!

remove

boolean remove(NAry nAry)
DOCUMENT ME!

Parameters:
nAry - DOCUMENT ME!
Returns:
DOCUMENT ME!

remove

boolean remove(java.lang.Object[] o)
DOCUMENT ME!

Parameters:
o - DOCUMENT ME!
Returns:
DOCUMENT ME!

size

int size()
DOCUMENT ME!

Specified by:
size in interface java.util.Collection
Specified by:
size in interface java.util.Set
Returns:
DOCUMENT ME!

addAll

boolean addAll(Relation r)
DOCUMENT ME!

Parameters:
r - DOCUMENT ME!
Returns:
DOCUMENT ME!

addAll

boolean addAll(java.util.Collection c)
DOCUMENT ME!

Specified by:
addAll in interface java.util.Collection
Specified by:
addAll in interface java.util.Set
Parameters:
c - DOCUMENT ME!
Returns:
DOCUMENT ME!

containsAll

boolean containsAll(Relation r)
DOCUMENT ME!

Parameters:
r - DOCUMENT ME!
Returns:
DOCUMENT ME!

containsAll

boolean containsAll(java.util.Collection c)
DOCUMENT ME!

Specified by:
containsAll in interface java.util.Collection
Specified by:
containsAll in interface java.util.Set
Parameters:
c - DOCUMENT ME!
Returns:
DOCUMENT ME!

removeAll

boolean removeAll(Relation r)
DOCUMENT ME!

Parameters:
r - DOCUMENT ME!
Returns:
DOCUMENT ME!

removeAll

boolean removeAll(java.util.Collection c)
DOCUMENT ME!

Specified by:
removeAll in interface java.util.Collection
Specified by:
removeAll in interface java.util.Set
Parameters:
c - DOCUMENT ME!
Returns:
DOCUMENT ME!

retainAll

boolean retainAll(Relation r)
DOCUMENT ME!

Parameters:
r - DOCUMENT ME!
Returns:
DOCUMENT ME!

retainAll

boolean retainAll(java.util.Collection c)
DOCUMENT ME!

Specified by:
retainAll in interface java.util.Collection
Specified by:
retainAll in interface java.util.Set
Parameters:
c - DOCUMENT ME!
Returns:
DOCUMENT ME!

toArray

java.lang.Object[] toArray()
DOCUMENT ME!

Specified by:
toArray in interface java.util.Collection
Specified by:
toArray in interface java.util.Set
Returns:
DOCUMENT ME!

toArray

java.lang.Object[] toArray(NAry[] a)
DOCUMENT ME!

Parameters:
a - DOCUMENT ME!
Returns:
DOCUMENT ME!

toArray

java.lang.Object[] toArray(java.lang.Object[] a)
DOCUMENT ME!

Specified by:
toArray in interface java.util.Collection
Specified by:
toArray in interface java.util.Set
Parameters:
a - DOCUMENT ME!
Returns:
DOCUMENT ME!

toString

java.lang.String toString()
DOCUMENT ME!

Overrides:
toString in class java.lang.Object
Returns:
DOCUMENT ME!

equals

boolean equals(java.lang.Object o)
DOCUMENT ME!

Specified by:
equals in interface java.util.Collection
Specified by:
equals in interface java.util.Set
Overrides:
equals in class java.lang.Object
Parameters:
o - DOCUMENT ME!
Returns:
DOCUMENT ME!

contains

boolean contains(java.lang.Object object,
                 int i)
DOCUMENT ME!

Parameters:
object - DOCUMENT ME!
i - DOCUMENT ME!
Returns:
DOCUMENT ME!

getAll

java.util.Set getAll()
DOCUMENT ME!

Returns:
DOCUMENT ME!

get

java.util.Set get(int i)
DOCUMENT ME!

Parameters:
i - DOCUMENT ME!
Returns:
DOCUMENT ME!

getElements

java.util.Set getElements(java.lang.Object object,
                          int i)
DOCUMENT ME!

Parameters:
object - DOCUMENT ME!
i - DOCUMENT ME!
Returns:
DOCUMENT ME!

isFunction

boolean isFunction(int i)
DOCUMENT ME!

Parameters:
i - DOCUMENT ME!
Returns:
DOCUMENT ME!