net.sourceforge.czt.animation.eval.result

Class RangeSet

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.RangeSet

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 RangeSet
extends EvalSet

A simple implementation of lo..hi. However, one or both of the bounds may be missing, in which case they are negative/positive infinity.

Author:

marku

Nested Class Summary

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

EvalSet.SubsetIterator<E>

Field Summary

Fields

Modifier and Type	Field and Description
protected net.sourceforge.czt.z.util.Factory	factory_
static RangeSet	integers The set of all integers.
protected BigInteger	lower_ The exact value of the lower bound, or null if not known.
protected String	name_ The name of this RangeSet ("" if not known)
protected BigInteger	upper_ The exact value of the upper bound, or null if not known.

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

INFINITE_SIZE, UNKNOWN_SIZE

Constructor Summary

Constructors

Constructor and Description
RangeSet(BigInteger lo, BigInteger up)
RangeSet(BigInteger lo, BigInteger up, String name)

Method Summary

Modifier and Type	Method and Description
boolean	contains(Object e)
boolean	equals(Object other) This implementation of equals handles two RangeSets efficiently.
BigInteger	getLower() The lower bound on numeric elements, if any, else null.
static int	getNumIterSize()
BigInteger	getUpper() The upper bound on numeric elements, if any, else null.
RangeSet	intersect(BigInteger lo, BigInteger up) Calculates the exact intersection of this range with (lo..up).
RangeSet	intersect(RangeSet other) Calculates the exact intersection of two ranges.
boolean	isEmpty() true iff this range is empty.
boolean	isFinite() true iff there is a lower bound and an upper bound.
Iterator<net.sourceforge.czt.z.ast.Expr>	iterator() Iterate through all members of the set.
static String	LimitString(BigInteger limit) Returns a possibly-null limit as a string.
ListIterator<net.sourceforge.czt.z.ast.Expr>	listIterator() Iterates from low to high if there is a lower bound, otherwise it iterates from high to low.
static BigInteger	maxNeg(BigInteger i1, BigInteger i2) Calculates the maximum of two optional numbers, with null interpreted as being negative infinity.
static BigInteger	maxPos(BigInteger i1, BigInteger i2) Calculates the maximum of two optional numbers, with null interpreted as being positive infinity.
BigInteger	maxSize() Returns the exact size of the set, or null if it is infinite.
static BigInteger	minNeg(BigInteger i1, BigInteger i2) Calculates the minimum of two optional numbers, with null interpreted as being negative infinity.
static BigInteger	minPos(BigInteger i1, BigInteger i2) Calculates the minimum of two optional numbers, with null interpreted as being positive infinity.
static void	setNumIterSize(int size) Set the maximum number of integer values we should iterate through before throwing an EvalException.
static void	setNumIterSize(String value)
int	size() Returns the exact size of the set, or MAX_VALUE if the set is infinite or has cardinality greater than MAX_VALUE.
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.
RangeSet	union(BigInteger lo, BigInteger up) Calculates the 'generous union' of this range with (lo..up).
RangeSet	union(RangeSet other) Calculates the 'generous union' of two ranges.

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

accept, add, addAll, clear, containsAll, estSize, estSubsetSize, getAnn, getAnns, 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

Field Detail

lower_

protected BigInteger lower_

The exact value of the lower bound, or null if not known.

upper_

protected BigInteger upper_

The exact value of the upper bound, or null if not known.

name_

protected String name_

The name of this RangeSet ("" if not known)

factory_

protected net.sourceforge.czt.z.util.Factory factory_

integers

public static final RangeSet integers

The set of all integers.

Constructor Detail

RangeSet

public RangeSet(BigInteger lo,
                BigInteger up)

RangeSet

public RangeSet(BigInteger lo,
                BigInteger up,
                String name)

Method Detail

getNumIterSize

public static int getNumIterSize()

Returns:

The maximum number of integers we should iterate through.

setNumIterSize

public static void setNumIterSize(int size)

Set the maximum number of integer values we should iterate through before throwing an EvalException.

Parameters:

size - The maximum number of integers

setNumIterSize

public static void setNumIterSize(String value)

isFinite

public boolean isFinite()

true iff there is a lower bound and an upper bound.

isEmpty

public boolean isEmpty()

true iff this range is empty. That is, if lower and upper bounds are both known (not infinite) and upper < lower.

size

public int size()

Returns the exact size of the set, or MAX_VALUE if the set is infinite or has cardinality greater than MAX_VALUE.

maxSize

public BigInteger maxSize()

Returns the exact size of the set, or null if it is infinite.

Overrides:

maxSize in class EvalSet

Returns:

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

contains

public boolean contains(Object e)

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.

listIterator

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

Iterates from low to high if there is a lower bound, otherwise it iterates from high to low. If there are no bounds, it will return an iterator that throws an EvalException on the first call to next().

Specified by:

listIterator in class EvalSet

Returns:

a ListIterator object.

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

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.

getLower

public BigInteger getLower()

Description copied from class: EvalSet

The lower bound on numeric elements, if any, else null.

FlatEvalSet provides a default implementation that always returns null.

Overrides:

getLower in class EvalSet

getUpper

public BigInteger getUpper()

Description copied from class: EvalSet

The upper bound on numeric elements, if any, else null.

EvalSet provides a default implementation that always returns null.

Overrides:

getUpper in class EvalSet

equals

public boolean equals(Object other)

This implementation of equals handles two RangeSets efficiently. In other cases, it uses the equals method from FlatEvalSet. This equals method is really only meant to be used after the sets have been evaluated. It is not clear what it does or should do before that.

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 EvalSet

minNeg

public static BigInteger minNeg(BigInteger i1,
                                BigInteger i2)

Calculates the minimum of two optional numbers, with null interpreted as being negative infinity.

Parameters:

i1 - null means negative infinity

i2 - null means negative infinity

Returns:

minPos

public static BigInteger minPos(BigInteger i1,
                                BigInteger i2)

Calculates the minimum of two optional numbers, with null interpreted as being positive infinity.

Parameters:

i1 - null means positive infinity

i2 - null means positive infinity

Returns:

maxNeg

public static BigInteger maxNeg(BigInteger i1,
                                BigInteger i2)

Calculates the maximum of two optional numbers, with null interpreted as being negative infinity.

Parameters:

i1 - null means negative infinity

i2 - null means negative infinity

Returns:

maxPos

public static BigInteger maxPos(BigInteger i1,
                                BigInteger i2)

Calculates the maximum of two optional numbers, with null interpreted as being positive infinity.

Parameters:

i1 - null means positive infinity

i2 - null means positive infinity

Returns:

union

public RangeSet union(RangeSet other)

Calculates the 'generous union' of two ranges. Generous union means that the resulting range will include all numbers between the minimum of the two lower bounds and the maximum of the two upper bounds. For example, the generous union of 0..3 and 10..12 is 0..12, which includes numbers that are not in either set. So the generous union will always be a superset of the real union (or equal to it). If other==null, then this is returned.

union

public RangeSet union(BigInteger lo,
                      BigInteger up)

Calculates the 'generous union' of this range with (lo..up). Note that lo==null means negative infinity and up=null means positive infinity.

intersect

public RangeSet intersect(RangeSet other)

Calculates the exact intersection of two ranges. If other==null, then this is returned.

intersect

public RangeSet intersect(BigInteger lo,
                          BigInteger up)

Calculates the exact intersection of this range with (lo..up). Note that lo==null means negative infinity and up=null means positive infinity.

LimitString

public static String LimitString(BigInteger limit)

Returns a possibly-null limit as a string.

toString

public String toString()

Description copied from class: EvalSet

Each subclass should implement a nice toString.

Specified by:

toString in class EvalSet