Comparators (yFiles-for-JavaFX-Complete-3.0 API)

java.lang.Object
- com.yworks.yfiles.algorithms.Comparators

```
public final class Comparators
extends Object
```
This class provides access to some Comparator instances that are commonly used in yFiles.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static int`	`compare(double d1, double d2)` Compares the specified floating point numbers.
`static Comparator<Object>`	`createComparableComparator()` Returns a `Comparator` that compares to Objects of type Comparable.
`static Comparator<Object>`	`createComparableDataComparator(IDataProvider dp)` Returns a `Comparator` that compares objects of arbitrary type.
`static Comparator<Object>`	`createDoubleDataComparator(IDataProvider dp)` Returns a `Comparator` that compares objects of arbitrary type.
`static Comparator<Object>`	`createDoubleDataSourceComparator(IDataProvider dp)` Returns a `Comparator` that compares objects of type `Edge`.
`static Comparator<Object>`	`createDoubleDataTargetComparator(IDataProvider dp)` Returns a `Comparator` that compares objects of type `Edge`.
`static Comparator<Object>`	`createIntDataComparator(IDataProvider dp)` Returns a `Comparator` that compares objects of arbitrary type.
`static Comparator<Object>`	`createIntDataSourceComparator(IDataProvider dp)` Returns a `Comparator` that compares objects of type `Edge`.
`static Comparator<Object>`	`createIntDataTargetComparator(IDataProvider dp)` Returns a `Comparator` that compares objects of type `Edge`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - compare
```
public static final int compare(double d1,
                                double d2)
```
    Compares the specified floating point numbers.
    Returns a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second.
    
    Warning: This method does not handle NaN! If you need NaN-safe comparison, use Double.compare(double, double) instead.
    
    Parameters:
    
    d1 - the first number to compare.
    
    d2 - the second number to compare.
    
    Returns:
    
    a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second.
    
    See Also:
    
    Comparator.compare(Object, Object)
  - createComparableComparator
```
public static final Comparator<Object> createComparableComparator()
```
    Returns a Comparator that compares to Objects of type Comparable.
  - createComparableDataComparator
```
public static final Comparator<Object> createComparableDataComparator(IDataProvider dp)
```
    Returns a Comparator that compares objects of arbitrary type.
    Two objects are compared by comparing the Comparable instances the given data provider returns for each of these objects.
    
    Parameters:
    
    dp - a data provider that must return a Comparable for each object that is being compared by this comparator.
    
    Returns:
    
    a Comparator that compares arbitrary objects.
  - createDoubleDataComparator
```
public static final Comparator<Object> createDoubleDataComparator(IDataProvider dp)
```
    Returns a Comparator that compares objects of arbitrary type.
    Two objects are compared by comparing the double value the given data provider returns for each of these objects.
    
    Parameters:
    
    dp - a data provider that must return a double value for each object that is being compared by this comparator.
    
    Returns:
    
    a Comparator that compares arbitrary objects.
  - createDoubleDataSourceComparator
```
public static final Comparator<Object> createDoubleDataSourceComparator(IDataProvider dp)
```
    Returns a Comparator that compares objects of type Edge.
    Two edges are compared by comparing their source nodes. Each source node e.source() in turn is compared by the double value provided by the given data provider: dp.getDouble(e.source()).
    
    Parameters:
    
    dp - a data provider that must return a double value for the source node of each edge being compared.
    
    Returns:
    
    a Comparator that compares edges.
  - createDoubleDataTargetComparator
```
public static final Comparator<Object> createDoubleDataTargetComparator(IDataProvider dp)
```
    Returns a Comparator that compares objects of type Edge.
    Two edges are compared by comparing their target nodes. Each target node e.target() in turn is compared by the double value provided by the given data provider: dp.getDouble(e.target()).
    
    Parameters:
    
    dp - a data provider that must return a double value for the target node of each edge being compared.
    
    Returns:
    
    a Comparator that compares edges.
  - createIntDataComparator
```
public static final Comparator<Object> createIntDataComparator(IDataProvider dp)
```
    Returns a Comparator that compares objects of arbitrary type.
    Two objects are compared by comparing the int value the given data provider returns for each of these objects.
    
    Parameters:
    
    dp - a data provider that must return an int value for each object that is being compared by this comparator.
    
    Returns:
    
    a Comparator that compares arbitrary objects.
  - createIntDataSourceComparator
```
public static final Comparator<Object> createIntDataSourceComparator(IDataProvider dp)
```
    Returns a Comparator that compares objects of type Edge.
    Two edges are compared by comparing their source nodes. Each source node e.source() in turn is compared by the int value provided by the given data provider: dp.getInt(e.source()).
    
    Parameters:
    
    dp - a data provider that must return an int value for the source node of each edge being compared.
    
    Returns:
    
    a Comparator that compares edges.
  - createIntDataTargetComparator
```
public static final Comparator<Object> createIntDataTargetComparator(IDataProvider dp)
```
    Returns a Comparator that compares objects of type Edge.
    Two edges are compared by comparing their target nodes. Each target node e.target() in turn is compared by the int value provided by the given data provider: dp.getInt(e.target()).
    
    Parameters:
    
    dp - a data provider that must return an int value for the target node of each edge being compared.
    
    Returns:
    
    a Comparator that compares edges.

Class Comparators

Method Summary

Methods inherited from class java.lang.Object

Method Detail

compare

createComparableComparator

createComparableDataComparator

createDoubleDataComparator

createDoubleDataSourceComparator

createDoubleDataTargetComparator

createIntDataComparator

createIntDataSourceComparator

createIntDataTargetComparator