FindPeaks.accessory.classes

Class ArrayIndexComparator

java.lang.Object

FindPeaks.accessory.classes.ArrayIndexComparator

All Implemented Interfaces:

java.util.Comparator<java.lang.Integer>

public class ArrayIndexComparator
extends java.lang.Object
implements java.util.Comparator<java.lang.Integer>

Modified comparator for Index array: compares the underlying values (i.e. arr[ind] rather than the integer values We need this in the class FindPeaksTools to find the indexes of the largest values

Author:

thomasbraschler

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.Double[]	array Array with the values for which we would like to get the ordered indices

Constructor Summary

Constructors

Constructor and Description
ArrayIndexComparator(double[] vals) Load this class with the double array for which we'd like to do comparison

Method Summary

Modifier and Type	Method and Description
int	compare(java.lang.Integer index1, java.lang.Integer index2) Value-based index comparision: An index value is "larger" than another index value if it points to a larger array element
java.lang.Integer[]	createIndexArray() Convenience function.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Comparator

comparing, comparing, comparingDouble, comparingInt, comparingLong, equals, naturalOrder, nullsFirst, nullsLast, reversed, reverseOrder, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Field Detail

array

protected java.lang.Double[] array

Array with the values for which we would like to get the ordered indices

Constructor Detail

ArrayIndexComparator

public ArrayIndexComparator(double[] vals)

Load this class with the double array for which we'd like to do comparison

Parameters:

vals - The values for wich we would like to get the indices indicating their orgering

Method Detail

createIndexArray

public java.lang.Integer[] createIndexArray()

Convenience function. We want to get the indices sorted along the values, and so we need to start out with the indices array (i.e. 0,1,2,3 ...). For reasons of Java typing, we need this not as primitive int[] array, but as a class array using the Integer class

Returns:

Returns an ascending array of indices (0 to length array-1)

compare

public int compare(java.lang.Integer index1,
                   java.lang.Integer index2)

Value-based index comparision: An index value is "larger" than another index value if it points to a larger array element

Specified by:

compare in interface java.util.Comparator<java.lang.Integer>