Weight (Protempa Framework 4.1 API)

java.lang.Object
- org.protempa.graph.Weight

All Implemented Interfaces:

Serializable, Comparable<Weight>
```
public final class Weight
extends Object
implements Comparable<Weight>, Serializable
```
Like a Long except that there are special values representing positive infinity, negative infinity, positive epsilon (smallest positive value), and negative epsilon (smallest negative value).

Author:

Andrew Post

See Also:

Serialized Form

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Weight`	`add(Weight w)` Creates a new weight with value equal to the sum of both weights.
`int`	`compareTo(Weight anotherWeight)` Compares two `Weight` objects numerically.
`int`	`compareToLong(long val)`
`boolean`	`equals(Object o)`
`boolean`	`greaterThan(long val)` Checks to see if this weight is greater than the given long value.
`int`	`hashCode()`
`Weight`	`invertSign()` Creates a new weight with the opposite sign.
`boolean`	`isEqual(long val)` Checks if this weight has the same value as the given long.
`boolean`	`isInfinity()` Checks if this weight has value of positive or negative infinity.
`boolean`	`isNegativeInfinity()` Checks if this weight has value of negative infinity.
`boolean`	`isPositiveInfinity()` Checks if this weight has value of positive infinity.
`boolean`	`lessThan(long val)` Checks to see if this weight is less than the given long value.
`static Weight`	`max(Weight w1, Weight w2)` Gets the larger of the two given weights.
`static Weight`	`min(Weight w1, Weight w2)` Gets the smaller of the two given weights.
`Weight`	`subtract(Weight w)` Creates a new weight the value equal to the difference between the two weights.
`String`	`toString()`
`long`	`value()` Gets the value of this weight.

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

- Method Detail
  - value
```
public long value()
```
    Gets the value of this weight.
    
    Returns:
    
    a long representing the value of this weight. If this weight has a value of positive infinity, Long.MAX_VALUE is returned. If this weight has a value of negative infinity, Long.MIN_VALUE is returned.
  - greaterThan
```
public boolean greaterThan(long val)
```
    Checks to see if this weight is greater than the given long value.
    
    Parameters:
    
    val - a long value.
    
    Returns:
    
    true if this weight is greater than the given long value, false otherwise.
  - compareToLong
```
public int compareToLong(long val)
```
  - lessThan
```
public boolean lessThan(long val)
```
    Checks to see if this weight is less than the given long value.
    
    Parameters:
    
    val - a long value.
    
    Returns:
    
    true if this weight is less than the given long value, false otherwise.
  - isEqual
```
public boolean isEqual(long val)
```
    Checks if this weight has the same value as the given long.
    
    Parameters:
    
    val - a long.
    
    Returns:
    
    true if this weight has the same value, false otherwise. Always returns false if the value of this weight is infinity.
  - add
```
public Weight add(Weight w)
```
    Creates a new weight with value equal to the sum of both weights. Note that +inf and -inf cannot be added. If you try, an IllegalArgumentException will be thrown.
    
    Parameters:
    
    w - a weight.
    
    Returns:
    
    a new weight.
  - subtract
```
public Weight subtract(Weight w)
```
    Creates a new weight the value equal to the difference between the two weights. Note that infinity cannot be subtracted from infinity. If you try, an IllegalArgumentException will be thrown.
    
    Parameters:
    
    w - a weight.
    
    Returns:
    
    a new weight.
  - max
```
public static Weight max(Weight w1,
                         Weight w2)
```
    Gets the larger of the two given weights.
    
    Parameters:
    
    w1 - a weight. Cannot be null.
    
    w2 - a weight. Cannot be null.
    
    Returns:
    
    a weight.
  - min
```
public static Weight min(Weight w1,
                         Weight w2)
```
    Gets the smaller of the two given weights.
    
    Parameters:
    
    w1 - a weight. Cannot be null.
    
    w2 - a weight. Cannot be null.
    
    Returns:
    
    a weight.
  - isPositiveInfinity
```
public boolean isPositiveInfinity()
```
    Checks if this weight has value of positive infinity.
    
    Returns:
    
    true if it does, false if it doesn't.
  - isNegativeInfinity
```
public boolean isNegativeInfinity()
```
    Checks if this weight has value of negative infinity.
    
    Returns:
    
    true if it does, false if it doesn't.
  - isInfinity
```
public boolean isInfinity()
```
    Checks if this weight has value of positive or negative infinity.
    
    Returns:
    
    true if it does, false if it doesn't.
  - invertSign
```
public Weight invertSign()
```
    Creates a new weight with the opposite sign.
    
    Returns:
    
    a new Weight.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - compareTo
```
public int compareTo(Weight anotherWeight)
```
    Compares two Weight objects numerically.
    
    Specified by:
    
    compareTo in interface Comparable<Weight>
    
    Parameters:
    
    anotherWeight - the Weight to be compared.
    
    Returns:
    
    the value 0 if this Weight is equal to the argument Weight; a value less than 0 if this Weight is numerically less than the argument Weight; and a value greater than 0 if this Weight is numerically greater than the argument Weight (signed comparison).
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class Weight

Method Summary

Methods inherited from class java.lang.Object

Method Detail

value

greaterThan

compareToLong

lessThan

isEqual

add

subtract

max

min

isPositiveInfinity

isNegativeInfinity

isInfinity

invertSign

toString

compareTo

equals

hashCode