EvalSet (CZT ZLive 1.6-SNAPSHOT API)

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

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

Direct Known Subclasses:

DefaultEvalSet, DiscreteSet, FuzzySet, RangeSet, RelSet
```
public abstract class EvalSet
extends EvalResult
implements Set<net.sourceforge.czt.z.ast.Expr>
```
Author:

Mark Utting This defines the interface to all different kinds of ZLive set objects. Note that these set objects may be created in a 'fuzzy' (partially-known) state, where the free variables of the set are not known yet, so the contents of the set are uncertain. In this state, many of the iterator and size methods may return null or throw an exception. TODO: return more information about each iterator, such as whether or not it is NoDuplicates, Bidirectional, Sorted etc.
EvalSet provides default implementations of several of the Set methods.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class EvalSet.SubsetIterator<E>
Filters the master iterator, returning only those elements that are members of the slave set.

Nested Classes
Modifier and Type	Class and Description
`static class`	`EvalSet.SubsetIterator<E>` Filters the master iterator, returning only those elements that are members of the slave set.

Field Summary

Fields
Modifier and Type	Field and Description
`static double`	`INFINITE_SIZE` Default estimate for the approximate size of an infinite set.
`static double`	`UNKNOWN_SIZE` Default estimate for the approximate size of an unknown set.

Constructor Summary

Constructors
Constructor and Description

EvalSet()

Constructors
Constructor and Description
`EvalSet()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`<R> R`	`accept(net.sourceforge.czt.util.Visitor<R> visitor)`
`boolean`	`add(net.sourceforge.czt.z.ast.Expr o)` Throws UnsupportedOperationException.
`boolean`	`addAll(Collection<? extends net.sourceforge.czt.z.ast.Expr> c)` Throws UnsupportedOperationException.
`void`	`clear()` Throws UnsupportedOperationException.
`boolean`	`containsAll(Collection<?> c)`
`boolean`	`equals(Object s2)` Tests for the equality of any two sets.
`double`	`estSize()` Estimate the size of the set.
`double`	`estSubsetSize(Envir env, net.sourceforge.czt.z.ast.ZName elem)` Estimate the size of {x:this \| x=elem} in a given environment.
`<T> T`	`getAnn(Class<T> aClass)` A copy of the TermImpl implementation.
`net.sourceforge.czt.base.ast.ListTerm<Object>`	`getAnns()` A copy of the TermImpl implementation.
`BigInteger`	`getLower()` The lower bound on numeric elements, if any, else null.
`BigInteger`	`getUpper()` The upper bound on numeric elements, if any, else null.
`int`	`hashCode()` This hashCode implementation returns a constant! The semantics of EvalSet is that its value depends only upon its members, but we do not want to have to evaluate all the members before calculating the hashCode, and it is not very useful (or desirable) to evaluate just a few members.
`abstract Iterator<net.sourceforge.czt.z.ast.Expr>`	`iterator()` Iterate through all members of the set.
`abstract ListIterator<net.sourceforge.czt.z.ast.Expr>`	`listIterator()` Iterate forwards/backwards through all members of the set.
`Iterator<net.sourceforge.czt.z.ast.Expr>`	`matchIterator(Map<Object,net.sourceforge.czt.z.ast.Expr> args)` Iterate through the subset of this set that unifies with the given substructures in args.
`BigInteger`	`maxSize()` The maximum size of the set in the default environment.
`boolean`	`remove(Object o)` Throws UnsupportedOperationException.
`boolean`	`removeAll(Collection<?> c)` Throws UnsupportedOperationException.
`boolean`	`retainAll(Collection<?> c)` Throws UnsupportedOperationException.
`abstract 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.
`Object[]`	`toArray()` Returns an array containing all of the elements in this set.
`<T> T[]`	`toArray(T[] a)` Returns an array containing all of the elements in this set.
`abstract String`	`toString()` Each subclass should implement a nice toString.

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
contains, isEmpty, size, 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

- Field Detail
  - UNKNOWN_SIZE
```
public static final double UNKNOWN_SIZE
```
    Default estimate for the approximate size of an unknown set.
    
    See Also:
    
    Constant Field Values
  - INFINITE_SIZE
```
public static final double INFINITE_SIZE
```
    Default estimate for the approximate size of an infinite set. We make this slightly less than Double.INFINITY, so that we can reduce it by halving or taking the log etc. This allows us to compare the size of large/'infinite' sets in a simplistic way.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - EvalSet
```
public EvalSet()
```
- Method Detail
  - getLower
```
public BigInteger getLower()
```
    The lower bound on numeric elements, if any, else null.
    FlatEvalSet provides a default implementation that always returns null.
  - getUpper
```
public BigInteger getUpper()
```
    The upper bound on numeric elements, if any, else null.
    EvalSet provides a default implementation that always returns null.
  - maxSize
```
public BigInteger maxSize()
```
    The maximum size of the set in the default environment.
    EvalSet provides a default implementation that always returns null.
    
    Returns:
    
    Upper bound on the size of the set, or null if not known.
  - estSize
```
public double estSize()
```
    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.
  - estSubsetSize
```
public double estSubsetSize(Envir env,
                            net.sourceforge.czt.z.ast.ZName elem)
```
    Estimate the size of {x:this | x=elem} in a given environment. This allows the bounds of elem to be used to reduce the size of set.
    EvalSet provides a default implementation that just calls estSize().
  - iterator
```
public abstract Iterator<net.sourceforge.czt.z.ast.Expr> iterator()
```
    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>
    
    Returns:
    
    an expression iterator.
  - listIterator
```
public abstract ListIterator<net.sourceforge.czt.z.ast.Expr> listIterator()
```
    Iterate forwards/backwards through all members of the set. It guarantees that there will be no duplicates.
    
    Returns:
    
    a ListIterator object.
  - sortedIterator
```
public abstract Iterator<net.sourceforge.czt.z.ast.Expr> sortedIterator()
```
    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.
  - subsetIterator
```
public Iterator<net.sourceforge.czt.z.ast.Expr> subsetIterator(EvalSet otherSet)
```
    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.
    
    Returns:
    
    an Iterator object.
  - matchIterator
```
public Iterator<net.sourceforge.czt.z.ast.Expr> matchIterator(Map<Object,net.sourceforge.czt.z.ast.Expr> args)
```
    Iterate through the subset of this set that unifies with the given substructures in args. For example, if this set is a set of triples, then args might map 1 to 42 and 3 to 50, which would mean that search can be restricted to those triples that match (42, ?, 50).
    This method is intended purely to reduce the number of elements visited, so implementations are free to ignore otherSet if they wish. The result will contain no duplicates.
    EvalSet provides a default implementation that calls iterator().
    
    Returns:
    
    an Iterator object.
  - containsAll
```
public boolean containsAll(Collection<?> c)
```
    Specified by:
    
    containsAll in interface Collection<net.sourceforge.czt.z.ast.Expr>
    
    Specified by:
    
    containsAll in interface Set<net.sourceforge.czt.z.ast.Expr>
  - equals
```
public boolean equals(Object s2)
```
    Tests for the equality of any two sets. Here, the equality is based upon both the sets having the same elements, not taking into consideration the duplication of elements. This is implemented using the ExprComparator class. TODO: Allow finite.equals(infinite) to be calculated as false, etc.
    
    Specified by:
    
    equals in interface Collection<net.sourceforge.czt.z.ast.Expr>
    
    Specified by:
    
    equals in interface Set<net.sourceforge.czt.z.ast.Expr>
    
    Overrides:
    
    equals in class net.sourceforge.czt.z.impl.ExprImpl
  - hashCode
```
public int hashCode()
```
    This hashCode implementation returns a constant! The semantics of EvalSet is that its value depends only upon its members, but we do not want to have to evaluate all the members before calculating the hashCode, and it is not very useful (or desirable) to evaluate just a few members. So try to avoid creating large hashsets of EvalSet objects!
    
    Specified by:
    
    hashCode in interface Collection<net.sourceforge.czt.z.ast.Expr>
    
    Specified by:
    
    hashCode in interface Set<net.sourceforge.czt.z.ast.Expr>
    
    Overrides:
    
    hashCode in class net.sourceforge.czt.z.impl.ExprImpl
  - add
```
public boolean add(net.sourceforge.czt.z.ast.Expr o)
```
    Throws UnsupportedOperationException.
    
    Specified by:
    
    add in interface Collection<net.sourceforge.czt.z.ast.Expr>
    
    Specified by:
    
    add in interface Set<net.sourceforge.czt.z.ast.Expr>
  - addAll
```
public boolean addAll(Collection<? extends net.sourceforge.czt.z.ast.Expr> c)
```
    Throws UnsupportedOperationException.
    
    Specified by:
    
    addAll in interface Collection<net.sourceforge.czt.z.ast.Expr>
    
    Specified by:
    
    addAll in interface Set<net.sourceforge.czt.z.ast.Expr>
  - clear
```
public void clear()
```
    Throws UnsupportedOperationException.
    
    Specified by:
    
    clear in interface Collection<net.sourceforge.czt.z.ast.Expr>
    
    Specified by:
    
    clear in interface Set<net.sourceforge.czt.z.ast.Expr>
  - remove
```
public boolean remove(Object o)
```
    Throws UnsupportedOperationException.
    
    Specified by:
    
    remove in interface Collection<net.sourceforge.czt.z.ast.Expr>
    
    Specified by:
    
    remove in interface Set<net.sourceforge.czt.z.ast.Expr>
  - removeAll
```
public boolean removeAll(Collection<?> c)
```
    Throws UnsupportedOperationException.
    
    Specified by:
    
    removeAll in interface Collection<net.sourceforge.czt.z.ast.Expr>
    
    Specified by:
    
    removeAll in interface Set<net.sourceforge.czt.z.ast.Expr>
  - retainAll
```
public boolean retainAll(Collection<?> c)
```
    Throws UnsupportedOperationException.
    
    Specified by:
    
    retainAll in interface Collection<net.sourceforge.czt.z.ast.Expr>
    
    Specified by:
    
    retainAll in interface Set<net.sourceforge.czt.z.ast.Expr>
  - toArray
```
public Object[] toArray()
```
    Returns an array containing all of the elements in this set.
    
    Specified by:
    
    toArray in interface Collection<net.sourceforge.czt.z.ast.Expr>
    
    Specified by:
    
    toArray in interface Set<net.sourceforge.czt.z.ast.Expr>
  - toArray
```
public <T> T[] toArray(T[] a)
```
    Returns an array containing all of the elements in this set. The the runtime type of the returned array is that of the specified array.
    
    Specified by:
    
    toArray in interface Collection<net.sourceforge.czt.z.ast.Expr>
    
    Specified by:
    
    toArray in interface Set<net.sourceforge.czt.z.ast.Expr>
  - getAnns
```
public net.sourceforge.czt.base.ast.ListTerm<Object> getAnns()
```
    A copy of the TermImpl implementation.
    
    Specified by:
    
    getAnns in interface net.sourceforge.czt.base.ast.Term
    
    Overrides:
    
    getAnns in class net.sourceforge.czt.base.impl.TermImpl
  - getAnn
```
public <T> T getAnn(Class<T> aClass)
```
    A copy of the TermImpl implementation.
    
    Specified by:
    
    getAnn in interface net.sourceforge.czt.base.ast.Term
    
    Overrides:
    
    getAnn in class net.sourceforge.czt.base.impl.TermImpl
  - 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 net.sourceforge.czt.z.impl.ExprImpl
  - toString
```
public abstract String toString()
```
    Each subclass should implement a nice toString.
    
    Overrides:
    
    toString in class net.sourceforge.czt.base.impl.TermImpl

Class EvalSet

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Set

Methods inherited from interface java.util.Collection

Methods inherited from interface java.lang.Iterable

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

Field Detail

UNKNOWN_SIZE

INFINITE_SIZE

Constructor Detail

EvalSet

Method Detail

getLower

getUpper

maxSize

estSize

estSubsetSize

iterator

listIterator

sortedIterator

subsetIterator

matchIterator

containsAll

equals

hashCode

add

addAll

clear

remove

removeAll

retainAll

toArray

toArray

getAnns

getAnn

accept

toString