org.simbrain.network.util

Enum OrientationComparator

java.lang.Object

java.lang.Enum<OrientationComparator>

org.simbrain.network.util.OrientationComparator

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<OrientationComparator>, java.util.Comparator<Neuron>

public enum OrientationComparator
extends java.lang.Enum<OrientationComparator>
implements java.util.Comparator<Neuron>

Comparators for using in sorting various kinds of org.simbrain.network lists.

Author:

Zach Tosi, jyoshimi

Enum Constant Summary

Enum Constants

Enum Constant and Description
X_ORDER
X_REVERSE
Y_ORDER
Y_REVERSE

Method Summary

Modifier and Type	Method and Description
abstract int	compare(Neuron neuron1, Neuron neuron2)
static double	findMaxX(java.util.List<Neuron> neurons)
static double	findMaxY(java.util.List<Neuron> neurons)
static double	findMidpointX(java.util.List<Neuron> neurons)
static double	findMidpointY(java.util.List<Neuron> neurons)
static double	findMinX(java.util.List<Neuron> neurons)
static double	findMinY(java.util.List<Neuron> neurons)
static OrientationComparator	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static OrientationComparator[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

equals, getClass, notify, notifyAll, 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

Enum Constant Detail

X_ORDER

public static final OrientationComparator X_ORDER

Y_ORDER

public static final OrientationComparator Y_ORDER

X_REVERSE

public static final OrientationComparator X_REVERSE

Y_REVERSE

public static final OrientationComparator Y_REVERSE

Method Detail

values

public static OrientationComparator[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (OrientationComparator c : OrientationComparator.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static OrientationComparator valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

compare

public abstract int compare(Neuron neuron1,
                            Neuron neuron2)

Specified by:

compare in interface java.util.Comparator<Neuron>

Parameters:

neuron1 -

neuron2 -

Returns:

findMinX

public static double findMinX(java.util.List<Neuron> neurons)

Parameters:

neurons -

Returns:

findMaxX

public static double findMaxX(java.util.List<Neuron> neurons)

findMinY

public static double findMinY(java.util.List<Neuron> neurons)

findMaxY

public static double findMaxY(java.util.List<Neuron> neurons)

findMidpointX

public static double findMidpointX(java.util.List<Neuron> neurons)

findMidpointY

public static double findMidpointY(java.util.List<Neuron> neurons)