net.sourceforge.czt.animation.eval.result

Class RelSet

java.lang.Object

net.sourceforge.czt.base.impl.TermImpl

net.sourceforge.czt.z.impl.ExprImpl

net.sourceforge.czt.animation.eval.result.EvalResult

net.sourceforge.czt.animation.eval.result.EvalSet

net.sourceforge.czt.animation.eval.result.RelSet

All Implemented Interfaces:

Iterable<net.sourceforge.czt.z.ast.Expr>, Collection<net.sourceforge.czt.z.ast.Expr>, Set<net.sourceforge.czt.z.ast.Expr>, net.sourceforge.czt.base.ast.Term, net.sourceforge.czt.z.ast.Expr

public class RelSet
extends EvalSet

A relation or function space, from_ <--> to_. With various constraints (functional, total, onto or injective).

Author:

Petra Malik

Nested Class Summary

Nested classes/interfaces inherited from class net.sourceforge.czt.animation.eval.result.EvalSet

EvalSet.SubsetIterator<E>

Field Summary

Fields inherited from class net.sourceforge.czt.animation.eval.result.EvalSet

INFINITE_SIZE, UNKNOWN_SIZE

Constructor Summary

Constructors

Constructor and Description
RelSet(net.sourceforge.czt.z.ast.Expr from, net.sourceforge.czt.z.ast.Expr to, boolean function, boolean total, boolean onto, boolean injective) Creates a new power set of the given base set.

Method Summary

Modifier and Type	Method and Description
<R> R	accept(net.sourceforge.czt.util.Visitor<R> visitor)
boolean	contains(Object obj)
double	estSize() Estimate the size of the set.
String	funcName() This returns the function operator, in email markup.
static String	funcName(boolean func, boolean inj, boolean tot, boolean onto) This returns the function operator that has the given properties.
String	funcNameUnicode() This returns the function operator, in Unicode markup.
static String	funcNameUnicode(boolean func, boolean inj, boolean tot, boolean onto)
net.sourceforge.czt.z.ast.Expr	getDom()
net.sourceforge.czt.z.ast.Expr	getRan()
boolean	isEmpty()
boolean	isFunction()
boolean	isInjective()
boolean	isOnto()
boolean	isTotal()
Iterator<net.sourceforge.czt.z.ast.Expr>	iterator() Iterate through all members of the set.
ListIterator<net.sourceforge.czt.z.ast.Expr>	listIterator() Iterate forwards/backwards through all members of the set.
BigInteger	maxSize() The maximum size of the set in the default environment.
int	size() TODO: calculate this correctly for functions with small/finite dom&ran.
Iterator<net.sourceforge.czt.z.ast.Expr>	sortedIterator() Iterate through all members of the set in sorted order.
Iterator<net.sourceforge.czt.z.ast.Expr>	subsetIterator(EvalSet otherSet) Iterate through the intersection of this set and the 'other' set.
String	toString() Each subclass should implement a nice toString.

Methods inherited from class net.sourceforge.czt.animation.eval.result.EvalSet

add, addAll, clear, containsAll, equals, estSubsetSize, getAnn, getAnns, getLower, getUpper, hashCode, matchIterator, remove, removeAll, retainAll, toArray, toArray

Methods inherited from class net.sourceforge.czt.animation.eval.result.EvalResult

create, getChildren

Methods inherited from class net.sourceforge.czt.base.impl.TermImpl

annsSize, getFactory, hasAnn, hasAnn, removeAnn, removeAnn

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Set

spliterator

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface net.sourceforge.czt.base.ast.Term

annsSize, hasAnn, hasAnn, removeAnn, removeAnn

Constructor Detail

RelSet

public RelSet(net.sourceforge.czt.z.ast.Expr from,
              net.sourceforge.czt.z.ast.Expr to,
              boolean function,
              boolean total,
              boolean onto,
              boolean injective)

Creates a new power set of the given base set.

Method Detail

getDom

public net.sourceforge.czt.z.ast.Expr getDom()

getRan

public net.sourceforge.czt.z.ast.Expr getRan()

isFunction

public boolean isFunction()

isTotal

public boolean isTotal()

isOnto

public boolean isOnto()

isInjective

public boolean isInjective()

isEmpty

public boolean isEmpty()

size

public int size()

TODO: calculate this correctly for functions with small/finite dom&ran.

maxSize

public BigInteger maxSize()

Description copied from class: EvalSet

The maximum size of the set in the default environment.

EvalSet provides a default implementation that always returns null.

Overrides:

maxSize in class EvalSet

Returns:

Upper bound on the size of the set, or null if not known.

estSize

public double estSize()

Description copied from class: EvalSet

Estimate the size of the set.

EvalSet provides a default implementation that is the same as maxSize(), but converted to a double. So maxSize()==null gives EvalSet.INFINITE_SIZE here.

Overrides:

estSize in class EvalSet

contains

public boolean contains(Object obj)

Throws:

EvalException - if the given object is not an EvalSet.

iterator

public Iterator<net.sourceforge.czt.z.ast.Expr> iterator()

Description copied from class: EvalSet

Iterate through all members of the set. It guarantees that there will be no duplicates.

Specified by:

iterator in interface Iterable<net.sourceforge.czt.z.ast.Expr>

Specified by:

iterator in interface Collection<net.sourceforge.czt.z.ast.Expr>

Specified by:

iterator in interface Set<net.sourceforge.czt.z.ast.Expr>

Specified by:

iterator in class EvalSet

Returns:

an expression iterator.

Throws:

UnsupportedOperationException - whenever this method is called.

listIterator

public ListIterator<net.sourceforge.czt.z.ast.Expr> listIterator()

Description copied from class: EvalSet

Iterate forwards/backwards through all members of the set. It guarantees that there will be no duplicates.

Specified by:

listIterator in class EvalSet

Returns:

a ListIterator object.

Throws:

UnsupportedOperationException - whenever this method is called.

sortedIterator

public Iterator<net.sourceforge.czt.z.ast.Expr> sortedIterator()

Description copied from class: EvalSet

Iterate through all members of the set in sorted order. It guarantees that there will be no duplicates. It will usually fully evaluate the set before the first element is returned. If you want lazy evaluation, you should use the normal iterator() method instead of this.

Specified by:

sortedIterator in class EvalSet

Throws:

UnsupportedOperationException - whenever this method is called.

subsetIterator

public Iterator<net.sourceforge.czt.z.ast.Expr> subsetIterator(EvalSet otherSet)

Description copied from class: EvalSet

Iterate through the intersection of this set and the 'other' set. This is intended purely to reduce the number of elements visited, so implementations are free to ignore otherSet if they wish. If otherSet==null, then it places no constraints on the iteration, and this method is equivalent to iterator(). The result will contain no duplicates.

EvalSet provides a default implementation that it iterates through the smaller of the two sets and checks membership in the other. TODO: add unit tests for this.

Overrides:

subsetIterator in class EvalSet

Returns:

an Iterator object.

Throws:

UnsupportedOperationException - whenever this method is called.

funcName

public static String funcName(boolean func,
                              boolean inj,
                              boolean tot,
                              boolean onto)

This returns the function operator that has the given properties. The resulting string is in email markup.

funcNameUnicode

public static String funcNameUnicode(boolean func,
                                     boolean inj,
                                     boolean tot,
                                     boolean onto)

funcName

public String funcName()

This returns the function operator, in email markup.

funcNameUnicode

public String funcNameUnicode()

This returns the function operator, in Unicode markup.

toString

public String toString()

Description copied from class: EvalSet

Each subclass should implement a nice toString.

Specified by:

toString in class EvalSet

accept

public <R> R accept(net.sourceforge.czt.util.Visitor<R> visitor)

Specified by:

accept in interface net.sourceforge.czt.base.ast.Term

Overrides:

accept in class EvalSet