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.

Implementation note: This implementation is not thread safe. All ISeq and MSeq instances created by toISeq() and subSeq(int), respectively, must be protected by the same lock, when they are accessed (get/set) by different threads.

Since:

1.0

Version:

3.4

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
MSeq<T>	append(Iterable<? extends T> values) Return a new Seq with the given values appended.
default MSeq<T>	append(T... values) Return a new Seq with the given values appended.
default List<T>	asList() Returns a fixed-size list backed by the specified sequence.
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.
default 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(Supplier<? extends T> supplier, int length) Creates a new sequence, which is filled with objects created be the given supplier.
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.
MSeq<T>	prepend(Iterable<? extends T> values) Return a new Seq with the given values prepended.
default MSeq<T>	prepend(T... values) Return a new Seq with the given values prepended.
default MSeq<T>	reverse() Reverses the order of the elements this sequence (in place).
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.
default MSeq<T>	sort() Sorts this sequence according to the natural order of the elements.
default MSeq<T>	sort(Comparator<? super T> comparator) Sorts this sequence according to the order induced by the specified Comparator.
default MSeq<T>	sort(int start) Sorts this sequence according to the natural order of the elements.
default MSeq<T>	sort(int start, Comparator<? super T> comparator) Sorts this sequence according to the order induced by the specified Comparator.
default MSeq<T>	sort(int start, int end) Sorts this sequence according to the natural order of the elements.
MSeq<T>	sort(int start, int end, Comparator<? super T> comparator) Sorts this sequence according to the order induced by the specified Comparator.
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

asISeq, asMSeq, contains, equals, equals, forAll, get, hashCode, hashCode, indexOf, indexOf, indexOf, indexWhere, indexWhere, indexWhere, isEmpty, isSorted, isSorted, iterator, lastIndexOf, lastIndexOf, lastIndexOf, lastIndexWhere, lastIndexWhere, lastIndexWhere, length, parallelStream, size, spliterator, stream, toArray, toArray, toSeq, toString, toString

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface org.jenetics.util.Copyable

copy

Field Detail

EMPTY

static final MSeq<?> EMPTY

Single instance of an empty MSeq.

Method Detail

asList

default List<T> asList()

Description copied from interface: Seq

Returns a fixed-size list backed by the specified sequence. (Changes to the returned list "write through" to the array.) The returned list is fixed size, serializable and implements RandomAccess.

Specified by:

asList in interface Seq<T>

Returns:

a list view of this sequence

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.

sort

MSeq<T> sort(int start,
             int end,
             Comparator<? super T> comparator)

Sorts this sequence according to the order induced by the specified Comparator.

All elements in this sequence must be mutually comparable using the specified comparator (that is, c.compare(e1, e2) must not throw a ClassCastException for any elements e1 and e2 in the sequence).

If the specified comparator is null then all elements in this list must implement the Comparable interface and the elements' Comparable natural ordering should be used.

Parameters:

start - the start index where to start sorting (inclusively)

end - the end index where to stop sorting (exclusively)

comparator - the Comparator used to compare sequence elements. A null value indicates that the elements' Comparable natural ordering should be used

Returns:

this sequence

Throws:

ClassCastException - if the sequence contains elements that are not mutually comparable using the specified comparator

sort

default MSeq<T> sort(int start,
                     int end)

Sorts this sequence according to the natural order of the elements.

Parameters:

start - the start index where to start sorting (inclusively)

end - the end index where to stop sorting (exclusively)

Returns:

this sequence

Throws:

ClassCastException - if the sequence contains elements that are not mutually comparable using the specified comparator

sort

default MSeq<T> sort(int start,
                     Comparator<? super T> comparator)

Sorts this sequence according to the order induced by the specified Comparator.

All elements in this sequence must be mutually comparable using the specified comparator (that is, c.compare(e1, e2) must not throw a ClassCastException for any elements e1 and e2 in the sequence).

If the specified comparator is null then all elements in this list must implement the Comparable interface and the elements' Comparable natural ordering should be used.

Parameters:

start - the start index where to start sorting (inclusively)

comparator - the Comparator used to compare sequence elements. A null value indicates that the elements' Comparable natural ordering should be used

Returns:

this sequence

Throws:

ClassCastException - if the sequence contains elements that are not mutually comparable using the specified comparator

sort

default MSeq<T> sort(int start)

Sorts this sequence according to the natural order of the elements.

Parameters:

start - the start index where to start sorting (inclusively)

Returns:

this sequence

Throws:

ClassCastException - if the sequence contains elements that are not mutually comparable using the specified comparator

sort

default MSeq<T> sort(Comparator<? super T> comparator)

Sorts this sequence according to the order induced by the specified Comparator.

All elements in this sequence must be mutually comparable using the specified comparator (that is, c.compare(e1, e2) must not throw a ClassCastException for any elements e1 and e2 in the sequence).

If the specified comparator is null then all elements in this list must implement the Comparable interface and the elements' Comparable natural ordering should be used.

Parameters:

comparator - the Comparator used to compare sequence elements. A null value indicates that the elements' Comparable natural ordering should be used

Returns:

this sequence

Throws:

ClassCastException - if the sequence contains elements that are not mutually comparable using the specified comparator

sort

default MSeq<T> sort()

Sorts this sequence according to the natural order of the elements.

Returns:

this sequence

Throws:

ClassCastException - if the sequence contains elements that are not mutually comparable using the specified comparator

reverse

default MSeq<T> reverse()

Reverses the order of the elements this sequence (in place).

Returns:

this sequence with reverse order or the elements

listIterator

default ListIterator<T> listIterator()

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

Specified by:

listIterator in interface Seq<T>

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.

append

default MSeq<T> append(T... values)

Description copied from interface: Seq

Return a new Seq with the given values appended.

Specified by:

append in interface Seq<T>

Parameters:

values - the values to append

Returns:

a new Seq with the elements of this sequence and the given values appended.

append

MSeq<T> append(Iterable<? extends T> values)

Description copied from interface: Seq

Return a new Seq with the given values appended.

Specified by:

append in interface Seq<T>

Parameters:

values - the values to append

Returns:

a new Seq with the elements of this sequence and the given values appended.

prepend

default MSeq<T> prepend(T... values)

Description copied from interface: Seq

Return a new Seq with the given values prepended.

Specified by:

prepend in interface Seq<T>

Parameters:

values - the values to append

Returns:

a new Seq with the elements of this sequence and the given values prepended.

prepend

MSeq<T> prepend(Iterable<? extends T> values)

Description copied from interface: Seq

Return a new Seq with the given values prepended.

Specified by:

prepend in interface Seq<T>

Parameters:

values - the values to append

Returns:

a new Seq with the elements of this sequence and the given values prepended.

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

empty

static <T> MSeq<T> empty()

Return an empty MSeq.

Specified by:

empty in interface Seq<T>

Type Parameters:

T - the element type of the returned MSeq.

Returns:

an empty MSeq.

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

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.

Throws:

NegativeArraySizeException - if the given length is negative

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 object is null.

of

static <T> MSeq<T> of(Supplier<? extends T> supplier,
                      int length)

Creates a new sequence, which is filled with objects created be the given supplier.

Specified by:

of in interface Seq<T>

Type Parameters:

T - the element type of the sequence

Parameters:

supplier - the Supplier which creates the elements, the returned sequence is filled with

length - the length of the returned sequence

Returns:

a new sequence filled with elements given by the supplier

Throws:

NegativeArraySizeException - if the given length is negative

NullPointerException - if the given supplier is null

Since:

3.3

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.