Number (Palladio Core)

java.lang.Object
- java.lang.Number
- - org.jscience.mathematics.number.Number<T>

All Implemented Interfaces:

Serializable, Comparable<T>, javolution.lang.Immutable, javolution.lang.Realtime, javolution.lang.ValueType, javolution.xml.XMLSerializable, GroupAdditive<T>, Ring<T>, Structure<T>

Direct Known Subclasses:

Complex, Float64, FloatingPoint, Integer64, LargeInteger, ModuloInteger, Rational, Real
```
public abstract class Number<T extends Number<T>>
extends Number
implements Ring<T>, Comparable<T>, javolution.lang.Realtime, javolution.xml.XMLSerializable
```
This class represents a value-type number.

Version:

3.0, February 13, 2006

Author:

Jean-Marie Dautelle

See Also:

Wikipedia: Number, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Number()

Constructors
Constructor and Description
`Number()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`byte`	`byteValue()` Returns the value of this number as a `byte`.
`abstract int`	`compareTo(T that)` Compares this number with the specified number for order.
`abstract Number<T>`	`copy()` Returns a copy of this number `allocated` by the calling thread (possibly on the stack).
`abstract double`	`doubleValue()` Returns the value of this number as a `double`.
`abstract boolean`	`equals(Object obj)` Indicates if this number is equals to the specified object.
`float`	`floatValue()` Returns the value of this number as a `float`.
`abstract int`	`hashCode()` Returns the hash code for this number (consistent with `equals(Object)`.
`int`	`intValue()` Returns the value of this number as an `int`.
`boolean`	`isGreaterThan(T that)` Indicates if this number is ordered after that number (convenience method).
`abstract boolean`	`isLargerThan(T that)` Compares the magnitude of this number with that number.
`boolean`	`isLessThan(T that)` Indicates if this number is ordered before that number (convenience method).
`abstract long`	`longValue()` Returns the value of this number as a `long`.
`T`	`minus(T that)` Returns the difference between this number and the one specified.
`T`	`pow(int exp)` Returns this number raised at the specified positive exponent.
`short`	`shortValue()` Returns the value of this number as a `short`.
`String`	`toString()` Returns the text representation of this number as a `java.lang.String`.
`abstract javolution.text.Text`	`toText()` Returns the textual representation of this real-time object (equivalent to `toString` except that the returned value can be allocated from the local context space).

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

Methods inherited from interface org.jscience.mathematics.structure.Ring
times

Methods inherited from interface org.jscience.mathematics.structure.GroupAdditive
opposite, plus

- Constructor Detail
  - Number
```
public Number()
```
- Method Detail
  - isLargerThan
```
public abstract boolean isLargerThan(T that)
```
    Compares the magnitude of this number with that number.
    
    Returns:
    
    |this| > |that|
  - longValue
```
public abstract long longValue()
```
    Returns the value of this number as a long.
    
    Specified by:
    
    longValue in class Number
    
    Returns:
    
    the numeric value represented by this object after conversion to type long.
  - doubleValue
```
public abstract double doubleValue()
```
    Returns the value of this number as a double.
    
    Specified by:
    
    doubleValue in class Number
    
    Returns:
    
    the numeric value represented by this object after conversion to type double.
  - compareTo
```
public abstract int compareTo(T that)
```
    Compares this number with the specified number for order. Returns a negative integer, zero, or a positive integer as this number is less than, equal to, or greater than the specified number. Implementation must ensure that this method is consistent with equals (x.compareTo(y)==0) == (x.equals(y)),
    
    Specified by:
    
    compareTo in interface Comparable<T extends Number<T>>
    
    Parameters:
    
    that - the number to be compared.
    
    Returns:
    
    a negative integer, zero, or a positive integer as this number is less than, equal to, or greater than the specified number.
  - isLessThan
```
public final boolean isLessThan(T that)
```
    Indicates if this number is ordered before that number (convenience method).
    
    Parameters:
    
    that - the number to compare with.
    
    Returns:
    
    this.compareTo(that) < 0.
  - isGreaterThan
```
public final boolean isGreaterThan(T that)
```
    Indicates if this number is ordered after that number (convenience method).
    
    Parameters:
    
    that - the number to compare with.
    
    Returns:
    
    this.compareTo(that) > 0.
  - minus
```
public T minus(T that)
```
    Returns the difference between this number and the one specified.
    
    Parameters:
    
    that - the number to be subtracted.
    
    Returns:
    
    this - that.
  - pow
```
public T pow(int exp)
```
    Returns this number raised at the specified positive exponent.
    
    Parameters:
    
    exp - the positive exponent.
    
    Returns:
    
    this^exp
    
    Throws:
    
    IllegalArgumentException - if exp <= 0
  - byteValue
```
public final byte byteValue()
```
    Returns the value of this number as a byte. This may involve rounding or truncation.
    
    Overrides:
    
    byteValue in class Number
    
    Returns:
    
    the numeric value represented by this object after conversion to type byte.
  - shortValue
```
public final short shortValue()
```
    Returns the value of this number as a short. This may involve rounding or truncation.
    
    Overrides:
    
    shortValue in class Number
    
    Returns:
    
    the numeric value represented by this object after conversion to type short.
  - intValue
```
public final int intValue()
```
    Returns the value of this number as an int. This may involve rounding or truncation.
    
    Specified by:
    
    intValue in class Number
    
    Returns:
    
    the numeric value represented by this object after conversion to type int.
  - floatValue
```
public final float floatValue()
```
    Returns the value of this number as a float. This may involve rounding.
    
    Specified by:
    
    floatValue in class Number
    
    Returns:
    
    the numeric value represented by this object after conversion to type float.
  - equals
```
public abstract boolean equals(Object obj)
```
    Indicates if this number is equals to the specified object.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    obj - the object to be compared with.
    
    Returns:
    
    true if this number and the specified argument represent the same number; false otherwise.
  - hashCode
```
public abstract int hashCode()
```
    Returns the hash code for this number (consistent with equals(Object).
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    this number hash code.
  - toText
```
public abstract javolution.text.Text toText()
```
    Returns the textual representation of this real-time object (equivalent to toString except that the returned value can be allocated from the local context space).
    
    Specified by:
    
    toText in interface javolution.lang.Realtime
    
    Returns:
    
    this object's textual representation.
  - copy
```
public abstract Number<T> copy()
```
    Returns a copy of this number allocated by the calling thread (possibly on the stack).
    
    Specified by:
    
    copy in interface javolution.lang.ValueType
    
    Returns:
    
    an identical and independant copy of this number.
  - toString
```
public final String toString()
```
    Returns the text representation of this number as a java.lang.String.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    toText().toString()

Class Number<T extends Number<T>>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.jscience.mathematics.structure.Ring

Methods inherited from interface org.jscience.mathematics.structure.GroupAdditive

Constructor Detail

Number

Method Detail

isLargerThan

longValue

doubleValue

compareTo

isLessThan

isGreaterThan

minus

pow

byteValue

shortValue

intValue

floatValue

equals

hashCode

toText

copy

toString