org.abora.white.collection.steppers
Class AscendingArrayStepper

java.lang.Object
  |
  +--org.abora.white.xpp.basic.Heaper
        |
        +--org.abora.white.collection.steppers.Stepper
              |
              +--org.abora.white.collection.steppers.TableStepper
                    |
                    +--org.abora.white.collection.steppers.ArrayStepper
                          |
                          +--org.abora.white.collection.steppers.AscendingArrayStepper

public class AscendingArrayStepper

extends ArrayStepper

Field Summary

protected int

lastValueInternal

Fields inherited from class org.abora.white.collection.steppers.ArrayStepper

arrayInternal, indexInternal

Fields inherited from class org.abora.white.collection.steppers.Stepper

TheEmptyStepper

Constructor Summary

protected	AscendingArrayStepper(ActualArray array)
protected	AscendingArrayStepper(ActualArray array, IntegerValue index)
protected	AscendingArrayStepper(ActualArray array, IntegerValue start, IntegerValue stop)

Method Summary

Stepper	copy() Return a new stepper which steps independently of me, but whose current value is the same as mine, and which must produce a future history of values which satisfies the same obligation that my contract obligates me to produce now.
Heaper	fetch() If I am exhausted (i.e., if (!! this->hasValue())), then return NULL.
boolean	hasValue() Iff I have a current value (i.e.
static TableStepper	make(ActualArray array)
static TableStepper	make(ActualArray array, IntegerValue index)
static TableStepper	make(ActualArray array, IntegerValue start, IntegerValue stop)
void	printOn(java.io.PrintWriter oo) This should rarely be overridden.
void	step() Essential.

Methods inherited from class org.abora.white.collection.steppers.ArrayStepper

array, get, index, position, setIndex

Methods inherited from class org.abora.white.collection.steppers.TableStepper

ascending, descending, info, key, stepManyPairs, stepManyPairs

Methods inherited from class org.abora.white.collection.steppers.Stepper

actualHashForEqual, atEnd, emptyStepper, isEqual, itemStepper, stepMany, stepMany, theOne

Methods inherited from class org.abora.white.xpp.basic.Heaper

destroy, destruct, equals, hashForEqual, printContentsOn, sendSelfTo, toString

Methods inherited from class java.lang.Object

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

Field Detail

lastValueInternal

protected int lastValueInternal

Constructor Detail

AscendingArrayStepper

protected AscendingArrayStepper(ActualArray array)

AscendingArrayStepper

protected AscendingArrayStepper(ActualArray array,
                                IntegerValue index)

AscendingArrayStepper

protected AscendingArrayStepper(ActualArray array,
                                IntegerValue start,
                                IntegerValue stop)

Method Detail

copy

public Stepper copy()

Description copied from class: Stepper

Return a new stepper which steps independently of me, but whose current value is the same as mine, and which must produce a future history of values which satisfies the same obligation that my contract obligates me to produce now. Typically, this will mean that he must produce the same future history that I'm going to produce. However, let's say that I am enumerating the elements of a partial order in some full order which is consistent with the partial order. If a copy of me is made after I'm part way through, then me and my copy may produce any future history compatable both with the partial order and the elements I've already produced by the time of the copy. Of course, a subclass or a Stepper creating message (like IntegerRegion::stepper()) may specify the more stringent requirement (that a copy must produce the same sequence). To prevent aliasing, Steppers should typically be passed by copy. See class comment.

Specified by:

copy in class ArrayStepper

fetch

public Heaper fetch()

Description copied from class: Stepper

If I am exhausted (i.e., if (!! this->hasValue())), then return NULL. Else return current element. I return wimpily since most items returned are held by collections. If I create a new object, I should cache it.

Specified by:

fetch in class ArrayStepper

hasValue

public boolean hasValue()

Description copied from class: Stepper

Iff I have a current value (i.e. this message returns true), then I am not exhasted. 'fetch' and 'get' will both return this value, and I can be 'step'ped to my next state. As I am stepped, eventually I may become exhausted (the reverse of all the above), which is a permanent condition. Note that not all steppers have to be exhaustable. A Stepper which enumerates all primes is perfectly reasonable. Assuming otherwise will create infinite loops. See class comment.

Specified by:

hasValue in class ArrayStepper

step

public void step()

Description copied from class: Stepper

Essential. If I am currently exhausted (see Stepper::hasValue()), then it is an error to step me. The result of doing so isn't currently specified (we probably should specify it to BLAST, but I know that the implementation doesn't currently live up to that spec). If I am not exhausted, then this advances me to my next state. If my current value (see Stepper::get()) was my final value, then I am now exhausted, otherwise my new current value is the next value.

Specified by:

step in class ArrayStepper

printOn

public void printOn(java.io.PrintWriter oo)

Description copied from class: Heaper

This should rarely be overridden. In Tofu, it prints ClassName(...), where ... is either produced by printInsideOn or is ??? if printInsideOn it not overridden.

Overrides:

printOn in class Heaper

make

public static TableStepper make(ActualArray array)

make

public static TableStepper make(ActualArray array,
                                IntegerValue index)

make

public static TableStepper make(ActualArray array,
                                IntegerValue start,
                                IntegerValue stop)