org.jenetics.util

Interface MSeq<T>

All Superinterfaces:

Copyable<MSeq<T>>, Iterable<T>, Seq<T>

public interface MSeq<T>
extends Seq<T>, Copyable<MSeq<T>>

Mutable, ordered, fixed sized sequence.

Since:

1.0

Version:

3.0 — $Date: 2014-12-28 $

Author:

Franz Wilhelmstötter

See Also:

ISeq

Field Summary

Fields

Modifier and Type	Field and Description
static MSeq<?>	EMPTY Single instance of an empty MSeq.

Method Summary

Modifier and Type	Method and Description
static <T> MSeq<T>	empty() Return an empty MSeq.
default MSeq<T>	fill(Supplier<? extends T> supplier) Fill the sequence with values generated by the given factory.
ListIterator<T>	listIterator() Returns a list iterator over the elements in this sequence (in proper sequence).
<B> MSeq<B>	map(Function<? super T,? extends B> mapper) Builds a new sequence by applying a function to all elements of this sequence.
static <T> MSeq<T>	of(Iterable<? extends T> values) Create a new MSeq from the given values.
static <T> MSeq<T>	of(Seq<T> values) Create a new MSeq from the values of the given Seq.
static <T> MSeq<T>	of(T... values) Create a new MSeq from the given values.
static <T> MSeq<T>	ofLength(int length) Create a new MSeq with the given length.
void	set(int index, T value) Set the value at the given index.
default MSeq<T>	setAll(Iterable<? extends T> values) Fills the sequence with values of the given iterable.
default MSeq<T>	setAll(Iterator<? extends T> it) Fills the sequence with values of the given iterator.
default MSeq<T>	setAll(T[] values) Fill the sequence with the given values.
default MSeq<T>	shuffle() Randomize the array using the Random object currently registered in the RandomRegistry class.
default MSeq<T>	shuffle(Random random) Randomize the array using the given Random object.
MSeq<T>	subSeq(int start) Returns a view of the portion of this sequence between the specified start, inclusive, and end, exclusive.
MSeq<T>	subSeq(int start, int end) Returns a view of the portion of this sequence between the specified start, inclusive, and end, exclusive.
default void	swap(int i, int j) Swap the elements at the two positions.
default void	swap(int start, int end, MSeq<T> other, int otherStart) Swap a given range with a range of the same size with another array.
ISeq<T>	toISeq() Return a read-only projection of this sequence.
static <T> Collector<T,?,MSeq<T>>	toMSeq() Returns a Collector that accumulates the input elements into a new MSeq.

Methods inherited from interface org.jenetics.util.Seq

asList, contains, equals, equals, forAll, get, hashCode, hashCode, indexOf, indexOf, indexOf, indexWhere, indexWhere, indexWhere, isSorted, isSorted, lastIndexOf, lastIndexOf, lastIndexOf, lastIndexWhere, lastIndexWhere, lastIndexWhere, length, parallelStream, size, spliterator, stream, toArray, toArray, toSeq, toString, toString

Methods inherited from interface java.lang.Iterable

forEach, iterator

Methods inherited from interface org.jenetics.util.Copyable

copy

Field Detail

EMPTY

static final MSeq<?> EMPTY

Single instance of an empty MSeq.

Method Detail

set

void set(int index,
         T value)

Set the value at the given index.

Parameters:

index - the index of the new value.

value - the new value.

Throws:

IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size()).

setAll

default MSeq<T> setAll(Iterator<? extends T> it)

Fills the sequence with values of the given iterator.

Parameters:

it - the iterator of the values to fill this sequence.

Returns:

this sequence.

setAll

default MSeq<T> setAll(Iterable<? extends T> values)

Fills the sequence with values of the given iterable.

Parameters:

values - the values to fill this sequence.

Returns:

this sequence.

setAll

default MSeq<T> setAll(T[] values)

Fill the sequence with the given values.

Parameters:

values - the first initial values of this sequence

Returns:

this sequence.

fill

default MSeq<T> fill(Supplier<? extends T> supplier)

Fill the sequence with values generated by the given factory.

Parameters:

supplier - the value factory.

Returns:

this sequence.

Throws:

NullPointerException - if the given factory is null.

swap

default void swap(int i,
                  int j)

Swap the elements at the two positions.

Parameters:

i - the index of the first element.

j - the index of the second element.

Throws:

IndexOutOfBoundsException - if i < 0 || j >= length().

swap

default void swap(int start,
                  int end,
                  MSeq<T> other,
                  int otherStart)

Swap a given range with a range of the same size with another array.

            start                end
              |                   |
 this:  +---+---+---+---+---+---+---+---+---+---+---+---+
              +---------------+
                          +---------------+
 other: +---+---+---+---+---+---+---+---+---+---+---+---+
                          |
                      otherStart
 

Parameters:

start - the start index of this range, inclusively.

end - the end index of this range, exclusively.

other - the other array to swap the elements with.

otherStart - the start index of the other array.

Throws:

IndexOutOfBoundsException - if start > end or if start < 0 || end >= this.length() || otherStart < 0 || otherStart + (end - start) >= other.length()

shuffle

default MSeq<T> shuffle()

Randomize the array using the Random object currently registered in the RandomRegistry class. The used shuffling algorithm is from D. Knuth TAOCP, Seminumerical Algorithms, Third edition, page 142, Algorithm S (Selection sampling technique).

Returns:

this shuffled sequence

shuffle

default MSeq<T> shuffle(Random random)

Randomize the array using the given Random object. The used shuffling algorithm is from D. Knuth TAOCP, Seminumerical Algorithms, Third edition, page 142, Algorithm S (Selection sampling technique).

Parameters:

random - the Random object to use for randomize.

Returns:

this shuffled sequence

Throws:

NullPointerException - if the random object is null.

listIterator

ListIterator<T> listIterator()

Returns a list iterator over the elements in this sequence (in proper sequence).

Returns:

a list iterator over the elements in this list (in proper sequence)

subSeq

MSeq<T> subSeq(int start,
               int end)

Description copied from interface: Seq

Returns a view of the portion of this sequence between the specified start, inclusive, and end, exclusive. (If start and end are equal, the returned sequence has the length zero.) The returned sequence is backed by this sequence, so non-structural changes in the returned sequence are reflected in this array, and vice-versa.

This method eliminates the need for explicit range operations (of the populationSort that commonly exist for arrays). Any operation that expects an array can be used as a range operation by passing an sub sequence view instead of an whole sequence.

Specified by:

subSeq in interface Seq<T>

Parameters:

start - low end point (inclusive) of the sub sequence.

end - high end point (exclusive) of the sub sequence.

Returns:

a view of the specified range within this sequence.

subSeq

MSeq<T> subSeq(int start)

Description copied from interface: Seq

Returns a view of the portion of this sequence between the specified start, inclusive, and end, exclusive. (If start and end are equal, the returned sequence has the length zero.) The returned sequence is backed by this sequence, so non-structural changes in the returned sequence are reflected in this sequence, and vice-versa.

This method eliminates the need for explicit range operations (of the populationSort that commonly exist for arrays). Any operation that expects an sequence can be used as a range operation by passing an sub sequence view instead of an whole sequence.

Specified by:

subSeq in interface Seq<T>

Parameters:

start - low end point (inclusive) of the sub array.

Returns:

a view of the specified range within this array.

map

<B> MSeq<B> map(Function<? super T,? extends B> mapper)

Description copied from interface: Seq

Builds a new sequence by applying a function to all elements of this sequence.

Specified by:

map in interface Seq<T>

Type Parameters:

B - the element type of the returned collection.

Parameters:

mapper - the function to apply to each element.

Returns:

a new sequence of type That resulting from applying the given function f to each element of this sequence and collecting the results.

toISeq

ISeq<T> toISeq()

Return a read-only projection of this sequence. Changes to the original sequence will not influence the returned ISeq.

Returns:

a read-only projection of this sequence

toMSeq

static <T> Collector<T,?,MSeq<T>> toMSeq()

Returns a Collector that accumulates the input elements into a new MSeq.

Type Parameters:

T - the type of the input elements

Returns:

a Collector which collects all the input elements into a MSeq, in encounter order

empty

static <T> MSeq<T> empty()

Return an empty MSeq.

Type Parameters:

T - the element type of the new MSeq.

Returns:

an empty MSeq.

ofLength

static <T> MSeq<T> ofLength(int length)

Create a new MSeq with the given length.

Type Parameters:

T - the element type of the new MSeq.

Parameters:

length - the length of the created MSeq.

Returns:

the new mutable sequence.

of

@SafeVarargs
static <T> MSeq<T> of(T... values)

Create a new MSeq from the given values.

Specified by:

of in interface Seq<T>

Type Parameters:

T - the element type

Parameters:

values - the array values.

Returns:

a new Meq with the given values.

Throws:

NullPointerException - if the values array is null.

of

static <T> MSeq<T> of(Iterable<? extends T> values)

Create a new MSeq from the given values.

Specified by:

of in interface Seq<T>

Type Parameters:

T - the element type

Parameters:

values - the array values.

Returns:

a new MSeq with the given values.

Throws:

NullPointerException - if the values array is null.

of

static <T> MSeq<T> of(Seq<T> values)

Create a new MSeq from the values of the given Seq.

Type Parameters:

T - the element type

Parameters:

values - the array values.

Returns:

an new MSeq with the given values

Throws:

NullPointerException - if the values array is null.