org.osgl.util

Interface C.Range<ELEMENT>

Type Parameters:

ELEMENT - the element type

All Superinterfaces:

C.Featured, C.Sequence<ELEMENT>, C.Traversable<ELEMENT>, Iterable<ELEMENT>

All Known Implementing Classes:

IntRange, LazyRange

Enclosing class:

C

public static interface C.Range<ELEMENT>
extends C.Sequence<ELEMENT>

Define a Range data structure which contains a discrete sequence of elements start from from() until to(). The from element should be contained in the range, while the to element should be exclusive from the range. While the from and to defines the boundary of an range, the step() defines how to step from one element to another in the range.

Nested Class Summary

Nested classes/interfaces inherited from interface org.osgl.util.C.Featured

C.Featured.Factory

Method Summary

Modifier and Type	Method and Description
C.Range<ELEMENT>	accept(Osgl.Function<? super ELEMENT,?> visitor) Iterate this Traversable with a visitor function.
C.Range<ELEMENT>	acceptLeft(Osgl.Function<? super ELEMENT,?> visitor) Iterate through this sequence from head to tail with the visitor function specified
C.Range<ELEMENT>	acceptRight(Osgl.Function<? super ELEMENT,?> visitor) iterate through the range from tail to head
boolean	contains(ELEMENT element) Check if an element is contained in this range
boolean	containsAll(C.Range<ELEMENT> r2) Check if this range contains all elements of another range of the same type (identified by order() and step()).
C.Range<ELEMENT>	each(Osgl.Function<? super ELEMENT,?> visitor) Alias of C.Traversable.accept(Osgl.Function)
Osgl.Option<ELEMENT>	findLast(Osgl.Function<? super ELEMENT,Boolean> predicate)
C.Range<ELEMENT>	forEach(Osgl.Function<? super ELEMENT,?> visitor) Alias of C.Traversable.accept(Osgl.Function)
ELEMENT	from() Returns the from value (inclusive) in the range
ELEMENT	last()
C.Range<ELEMENT>	merge(C.Range<ELEMENT> r2) Returns an new range this range and another range r2 merged together.
Comparator<ELEMENT>	order() Returns a $.Func2 function that takes two elements in the range domain and returns an integer to determine the order of the two elements.
Osgl.Option<ELEMENT>	reduceRight(Osgl.Func2<ELEMENT,ELEMENT,ELEMENT> accumulator)
<R> R	reduceRight(R identity, Osgl.Func2<R,ELEMENT,R> accumulator)
C.Range<ELEMENT>	reverse()
Iterator<ELEMENT>	reverseIterator()
Osgl.Func2<ELEMENT,Integer,ELEMENT>	step() Returns a $.Func2 function that applied to an element in this Range and an integer n indicate the number of steps.
C.Range<ELEMENT>	tail(int n)
ELEMENT	to() Returns the to value (exclusive) of the range

Methods inherited from interface org.osgl.util.C.Sequence

append, append, append, append, append, count, drop, dropWhile, eager, filter, findFirst, first, flatMap, head, head, lazy, map, parallel, prepend, prepend, prepend, prepend, prepend, reduce, reduce, reduceLeft, reduceLeft, sequential, tail, take, takeWhile, zip, zipAll, zipWithIndex

Methods inherited from interface org.osgl.util.C.Traversable

allMatch, anyMatch, findOne, isEmpty, noneMatch, size

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Methods inherited from interface org.osgl.util.C.Featured

features, is

Method Detail

from

ELEMENT from()

Returns the from value (inclusive) in the range

Returns:

from

Since:

0.2

to

ELEMENT to()

Returns the to value (exclusive) of the range

Returns:

to

Since:

0.2

contains

boolean contains(ELEMENT element)

Check if an element is contained in this range

Parameters:

element - the element to be checked

Returns:

true if the element specified is contained in the range

Since:

0.2

containsAll

boolean containsAll(C.Range<ELEMENT> r2)

Check if this range contains all elements of another range of the same type (identified by order() and step()).

Parameters:

r2 - the range to be tested

Returns:

true if this range contains all elements of r2

Since:

0.2

order

Comparator<ELEMENT> order()

Returns a $.Func2 function that takes two elements in the range domain and returns an integer to determine the order of the two elements. See Comparator.compare(Object, Object) for semantic of the function.

If any one of the element applied is null the function should throw out NullPointerException

Returns:

a function implement the ordering logic

Since:

0.2

step

Osgl.Func2<ELEMENT,Integer,ELEMENT> step()

Returns a $.Func2 function that applied to an element in this Range and an integer n indicate the number of steps. The result of the function is an element in the range or the range domain after moving n steps based on the element.

If the element apply is null, the function should throw out NullPointerException; if the resulting element is not defined in the range domain, the function should throw out NoSuchElementException

Returns:

a function implement the stepping logic

Since:

0.2

merge

C.Range<ELEMENT> merge(C.Range<ELEMENT> r2)

Returns an new range this range and another range r2 merged together. The two ranges must have the equal step() and order() operator to be merged, otherwise, InvalidArgException will be thrown out

The two ranges must be either overlapped or immediately connected to each other as per step() definition. Otherwise an InvalidArgException will be throw out:

• if one range contains another range entirely, then the larger range is returned
• if the two ranges overlapped or immediately connected to each other, then an range contains all elements of the two ranges will be returned
• an InvalidArgException will be thrown out if the two ranges does not connected to each other

Parameters:

r2 - the range to be merged with this range

Returns:

an new range contains all elements in this range and r2

Throws:

InvalidArgException - if the two ranges does not have the same step() operator or does not connect to each other

Since:

0.2

last

ELEMENT last()

tail

C.Range<ELEMENT> tail(int n)

reverse

C.Range<ELEMENT> reverse()

reverseIterator

Iterator<ELEMENT> reverseIterator()

reduceRight

<R> R reduceRight(R identity,
                  Osgl.Func2<R,ELEMENT,R> accumulator)

reduceRight

Osgl.Option<ELEMENT> reduceRight(Osgl.Func2<ELEMENT,ELEMENT,ELEMENT> accumulator)

findLast

Osgl.Option<ELEMENT> findLast(Osgl.Function<? super ELEMENT,Boolean> predicate)

accept

C.Range<ELEMENT> accept(Osgl.Function<? super ELEMENT,?> visitor)

Iterate this Traversable with a visitor function. This method does not specify the approach to iterate through this structure. The implementation might choose iterate from left to right, or vice versa. It might even choose to split the structure into multiple parts, and iterate through them in parallel

Specified by:

accept in interface C.Sequence<ELEMENT>

Specified by:

accept in interface C.Traversable<ELEMENT>

Parameters:

visitor - a function that apply to element in this Traversable. The return value of the function is ignored

Returns:

this Range instance

Since:

0.2

each

C.Range<ELEMENT> each(Osgl.Function<? super ELEMENT,?> visitor)

Description copied from interface: C.Traversable

Alias of C.Traversable.accept(Osgl.Function)

Specified by:

each in interface C.Sequence<ELEMENT>

Specified by:

each in interface C.Traversable<ELEMENT>

Parameters:

visitor - the visitor to tranverse the elements

Returns:

this Traversable instance

forEach

C.Range<ELEMENT> forEach(Osgl.Function<? super ELEMENT,?> visitor)

Description copied from interface: C.Traversable

Alias of C.Traversable.accept(Osgl.Function)

Specified by:

forEach in interface C.Sequence<ELEMENT>

Specified by:

forEach in interface C.Traversable<ELEMENT>

Parameters:

visitor - the visitor function

Returns:

this Traversable instance

acceptLeft

C.Range<ELEMENT> acceptLeft(Osgl.Function<? super ELEMENT,?> visitor)

Iterate through this sequence from head to tail with the visitor function specified

Specified by:

acceptLeft in interface C.Sequence<ELEMENT>

Parameters:

visitor - the function to visit elements in this sequence

Returns:

this Range instance

Since:

0.2

See Also:

C.Traversable.accept(Osgl.Function), C.ReversibleSequence.acceptRight(Osgl.Function)

acceptRight

C.Range<ELEMENT> acceptRight(Osgl.Function<? super ELEMENT,?> visitor)

iterate through the range from tail to head

Parameters:

visitor - a function to visit elements in the range

Returns:

this Range instance

Since:

0.2