la.util

Class Series

java.lang.Object

la.util.Series

Direct Known Subclasses:

Graph.SubGraphs, Series.Discrete, Series.Lines, Series.Separator, SeriesModel.Analysis

public abstract class Series
extends java.lang.Object

Series, of Values, is like the standard Java Enumeration and Iterator but with simpler semantics. The most important methods are elt(), hasSome() and advance(). A Series has state, and is eventually used up. Also see Value.Scannable – something that implements Scannable can produce a Series, repeatedly.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Series.Discrete Series producing Discrete Values.
static class	Series.Int Series producing Int Values.
static class	Series.Lines Series of lines (Value.Chars, strings) from an input stream of byte such as a FileInputStream, say.
static class	Series.Range Series of Ints from 'fst' inclusive, to 'ovr' exclusive, with an optional 'step' (default is 1) which may be negative.
static class	Series.Separator A Series of "comma"-separated variables (CSV) as Chars (strings) out of a String, s.

Field Summary

Fields

Modifier and Type	Field and Description
static Series	EMPTY The EMPTY Series always hasNone().

Constructor Summary

Constructors

Constructor and Description
Series()

Method Summary

Modifier and Type	Method and Description
abstract void	advance() Advance past the current element -- there might or might not be any more; also see hasSome().
void	advance(int n) Advance past 'n' elements (an error if impossible).
void	advanceTo(int n) Advance to position 'n' (an error if impossible).
Series	append(Series s2) Series of elements from 'this' until exhausted, then from 's2'.
Value.List	asList() Return a List of elements in 'this' Series; beware, do not share the Series because a Series has side-effects but a List does not.
abstract Value	elt() Return the current element, if there is one, but do not advance().
void	error(java.lang.String msg) Throw a RuntimeException.
void	exhaust() Advance until hasNone, presumably for side-effects.
static Series.Int	fromInts(int[] ns)
static Series	fromVector(Vector v)
boolean	hasNone() For convenience -- return not hasSome().
abstract boolean	hasSome() Is there at least a current element, (elt())? Also see hasNone().
static void	main(java.lang.String[] args)
Series	merge(boolean keepShared, Series s2) Merge the outputs of 'this' and 's2' in ascending order.
Series	merge(Series s2) merge(true,s2), i.e., keep elements shared by 'this' and 's2'.
abstract int	position() What position in the Series are we at (starting at zero)? If hasNone(), the series was finite and position() is now its length.
static Series	singleton(Value v) The Series of just one element.
java.lang.String	toString() Return a short String description of 'this' Series, say for use in debugging.
static Series	values(Value[] arr) Series of elements from an array of Values, one at a time.
double	wt() Return the weight of the current element; this default gives 1.0.

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY

public static Series EMPTY

The EMPTY Series always hasNone().

Constructor Detail

Series

public Series()

Method Detail

hasSome

public abstract boolean hasSome()

Is there at least a current element, (elt())? Also see hasNone().

hasNone

public boolean hasNone()

For convenience -- return not hasSome().

position

public abstract int position()

What position in the Series are we at (starting at zero)? If hasNone(), the series was finite and position() is now its length.

elt

public abstract Value elt()

Return the current element, if there is one, but do not advance(). Should throw an Exception if hasNone().

wt

public double wt()

Return the weight of the current element; this default gives 1.0. Also see Vector.wt(int).

advance

public abstract void advance()

Advance past the current element -- there might or might not be any more; also see hasSome().

advance

public void advance(int n)

Advance past 'n' elements (an error if impossible).

advanceTo

public void advanceTo(int n)

Advance to position 'n' (an error if impossible).

exhaust

public void exhaust()

Advance until hasNone, presumably for side-effects.

asList

public Value.List asList()

Return a List of elements in 'this' Series; beware, do not share the Series because a Series has side-effects but a List does not.

toString

public java.lang.String toString()

Return a short String description of 'this' Series, say for use in debugging.

Overrides:

toString in class java.lang.Object

fromInts

public static Series.Int fromInts(int[] ns)

fromVector

public static Series fromVector(Vector v)

append

public Series append(Series s2)

Series of elements from 'this' until exhausted, then from 's2'.

merge

public Series merge(Series s2)

merge(true,s2), i.e., keep elements shared by 'this' and 's2'.

merge

public Series merge(boolean keepShared,
                    Series s2)

Merge the outputs of 'this' and 's2' in ascending order. Both 'this' and s2 must be ascending. If 'not keepShared', and 'this' and 's1' return equal elements, then advance() advances them both.

singleton

public static Series singleton(Value v)

The Series of just one element. Also see values(arr)

values

public static Series values(Value[] arr)

Series of elements from an array of Values, one at a time. Also see Vector.toSeries().

error

public void error(java.lang.String msg)

Throw a RuntimeException. The exception includes the current position(), the toString() of 'this' Series and 'msg'.

main

public static void main(java.lang.String[] args)