org.oakgp.rank

Class RankedCandidates

java.lang.Object

org.oakgp.rank.RankedCandidates

All Implemented Interfaces:

Iterable<RankedCandidate>

public final class RankedCandidates
extends Object
implements Iterable<RankedCandidate>

A sorted immutable collection of RankedCandidate objects.

Constructor Summary

Constructors

Constructor and Description
RankedCandidates(RankedCandidate[] candidates) Constructs a new collection of candidates sorted by their natural ordering.
RankedCandidates(RankedCandidate[] candidates, Comparator<RankedCandidate> comparator) Constructs a new collection of candidates sorted according to the given comparator.

Method Summary

Modifier and Type	Method and Description
RankedCandidate	best() Returns the best candidate in this collection.
RankedCandidate	get(int index) Returns the candidate at the specified position in this collection.
Iterator<RankedCandidate>	iterator()
int	size() Returns the number of candidates in this collection.
Stream<RankedCandidate>	stream() Returns a sequential Stream with this collection as its source.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

RankedCandidates

public RankedCandidates(RankedCandidate[] candidates)

Constructs a new collection of candidates sorted by their natural ordering.

See Also:

RankedCandidate.compareTo(RankedCandidate)

RankedCandidates

public RankedCandidates(RankedCandidate[] candidates,
                        Comparator<RankedCandidate> comparator)

Constructs a new collection of candidates sorted according to the given comparator.

Method Detail

get

public RankedCandidate get(int index)

Returns the candidate at the specified position in this collection.

Parameters:

index - index of the candidate to return

Returns:

the candidate at the specified position in this collection

Throws:

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

best

public RankedCandidate best()

Returns the best candidate in this collection.

size

public int size()

Returns the number of candidates in this collection.

stream

public Stream<RankedCandidate> stream()

Returns a sequential Stream with this collection as its source.

iterator

public Iterator<RankedCandidate> iterator()

Specified by:

iterator in interface Iterable<RankedCandidate>