org.broadinstitute.hellbender.utils

Class IndexRange

java.lang.Object

org.broadinstitute.hellbender.utils.IndexRange

public final class IndexRange
extends java.lang.Object

Represents 0-based integer index range.

It represents an integer index range as the pair values:

from

- index of the first element in range (i.e. inclusive).

to

- index of the element following the last element in range (i.e. exclusive).

This class is intended to specify a valid index range in arrays or ordered collections.

All instances are constraint so that neither from nor to can be negative nor from can be larger than to.

You can use isValidFor(length) to verify that a range instance represents a valid range for an 0-based indexed object with length elements.

Constructor Summary

Constructors

Constructor and Description
IndexRange(int fromIndex, int toIndex) Creates a new range given its from and to indices.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object other)
java.util.List<java.lang.Integer>	filter(java.util.function.IntPredicate predicate) Find the elements of this range for which an int -> boolean predicate is true
void	forEach(java.util.function.IntConsumer lambda) Iterate through all indexes in the range in ascending order to be processed by the provided integer consumer lambda function.
int	getEnd()
int	getStart()
int	hashCode()
boolean	isValidLength(int length) Checks whether this range is valid for a collection or array of a given size.
double[]	mapToDouble(java.util.function.IntToDoubleFunction lambda) Apply an int -> double function to this range, producing a double[]
int[]	mapToInteger(java.util.function.IntUnaryOperator lambda) Apply an int -> int function to this range, producing an int[]
void	shift(int shift)
void	shiftEnd(int shift)
void	shiftEndLeft(int shift)
void	shiftLeft(int shift)
void	shiftStart(int shift)
void	shiftStartLeft(int shift)
int	size() Returns number indexes expanded by this range.
double	sum(java.util.function.IntToDoubleFunction lambda) Sums the values of an int -> double function applied to this range
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

IndexRange

public IndexRange(int fromIndex,
                  int toIndex)

Creates a new range given its from and to indices.

Parameters:

fromIndex - the from index value.

toIndex - the to index value.

Throws:

java.lang.IllegalArgumentException - if fromIndex is larger than toIndex or either is negative.

Method Detail

shift

public void shift(int shift)

shiftLeft

public void shiftLeft(int shift)

shiftStart

public void shiftStart(int shift)

shiftStartLeft

public void shiftStartLeft(int shift)

shiftEnd

public void shiftEnd(int shift)

shiftEndLeft

public void shiftEndLeft(int shift)

getStart

public int getStart()

getEnd

public int getEnd()

isValidLength

public boolean isValidLength(int length)

Checks whether this range is valid for a collection or array of a given size.

It assume that 0 is the first valid index for target indexed object which is true for Java Arrays and mainstream collections.

If the input length is less than 0, thus incorrect, this method is guaranteed to return false. No exception is thrown.

Parameters:

length - the targeted collection or array length.

Returns:

true if this range is valid for that length, false otherwise.

size

public int size()

Returns number indexes expanded by this range.

Returns:

0 or greater.

forEach

public void forEach(java.util.function.IntConsumer lambda)

Iterate through all indexes in the range in ascending order to be processed by the provided integer consumer lambda function.

Exceptions thrown by the execution of the index consumer lambda will be propagated to the caller immediately thus stopping early and preventing further indexes to be processed.

Parameters:

lambda - the index consumer lambda.

Throws:

java.lang.IllegalArgumentException - if lambda is null.

java.lang.RuntimeException - if thrown by lambda for some index.

java.lang.Error - if thrown by lambda for some index.

mapToDouble

public double[] mapToDouble(java.util.function.IntToDoubleFunction lambda)

Apply an int -> double function to this range, producing a double[]

Parameters:

lambda - the int -> double function

sum

public double sum(java.util.function.IntToDoubleFunction lambda)

Sums the values of an int -> double function applied to this range

Parameters:

lambda - the int -> double function

mapToInteger

public int[] mapToInteger(java.util.function.IntUnaryOperator lambda)

Apply an int -> int function to this range, producing an int[]

Parameters:

lambda - the int -> int function

filter

public java.util.List<java.lang.Integer> filter(java.util.function.IntPredicate predicate)

Find the elements of this range for which an int -> boolean predicate is true

Parameters:

predicate - the int -> boolean predicate

Returns:

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object