Num

Documentation of 'org.matheclipse.core.expression.Num' Java class Num

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- org.matheclipse.core.expression.ExprImpl
- - org.matheclipse.core.expression.Num

All Implemented Interfaces:

AbelianGroupElem<IExpr>, Element<IExpr>, MonoidElem<IExpr>, RingElem<IExpr>, java.io.Serializable, java.lang.Comparable<IExpr>, IExpr, INum, INumber, ISignedNumber
```
public class Num
extends ExprImpl
implements INum
```
See Also:

Serialized Form

Field Summary
- Fields inherited from interface org.matheclipse.core.interfaces.IExpr
  ASTID, COMPLEXID, DOUBLECOMPLEXID, DOUBLEID, FRACTIONID, INTEGERID, METHODSYMBOLID, PATTERNID, STRINGID, SYMBOLID

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<T> T`	`accept(IVisitor<T> visitor)` Accept a visitor with return type T
`boolean`	`accept(IVisitorBoolean visitor)` Accept a visitor with return type `boolean`
`int`	`accept(IVisitorInt visitor)` Accept a visitor with return type `int`
`INum`	`add(INum val)`
`IInteger`	`ceil()` Returns the smallest (closest to negative infinity) `IInteger` value that is not less than `this` and is equal to a mathematical integer.
`int`	`compareTo(double that)`
`int`	`compareTo(IExpr obj)` Compares this expression with the specified expression for order.
`int`	`complexSign()` Gets the signum value of a complex number
`double`	`divide(double that)`
`ISignedNumber`	`divideBy(ISignedNumber that)` Divide `this` signed number by `that` signed number.
`double`	`doubleValue()`
`Num`	`eabs()` Get the absolute value for a given number
`boolean`	`equals(java.lang.Object arg0)` Test if this is equal to b.
`boolean`	`equalsInt(int i)` Is this number equal an integer number?
`double`	`exp()`
`IInteger`	`floor()` Returns the largest (closest to positive infinity) `IInteger` value that is not greater than `this` and is equal to a mathematical integer.
`ISignedNumber`	`getIm()` Returns the imaginary part of a complex number
`ISignedNumber`	`getRe()` Returns the real part of a complex number
`double`	`getRealPart()`
`int`	`hashCode()` Hashcode of this Element.
`ISymbol`	`head()` If this object is an instance of `IAST` get the first element (offset 0) of the `IAST` list (i.e.
`int`	`hierarchy()` A unique integer ID for the implementation of this expression
`int`	`intValue()` Returns the value of this number as an `int` (by simply casting to type `int`).
`ISignedNumber`	`inverse()` Returns the multiplicative inverse of this object.
`boolean`	`isGreaterThan(ISignedNumber that)`
`boolean`	`isInfinite()`
`boolean`	`isLessThan(ISignedNumber that)`
`boolean`	`isMinusOne()` Test if this expression equals `-1` in symbolic or numeric mode.
`boolean`	`isNaN()`
`boolean`	`isNegative()` Test if this object is a negative signed number.
`boolean`	`isNumEqualInteger(IInteger ii)` Check if this expression equals an `IInteger` value.
`boolean`	`isNumIntValue()` Check if this expression represents an `int` value.
`boolean`	`isOne()` Test if this expression equals `1` in symbolic or numeric mode.
`boolean`	`isPositive()` Test if this object is a positive signed number.
`boolean`	`isSame(IExpr expression, double epsilon)` Test if this expression equals the given expression.
`boolean`	`isZero()` Test if this expression equals `0` in symbolic or numeric mode.
`double`	`log()`
`long`	`longValue()`
`double`	`minus(double that)`
`INum`	`multiply(INum val)`
`ISignedNumber`	`negate()` Negate this.
`ISignedNumber`	`opposite()`
`double`	`plus(double that)`
`IExpr`	`plus(IExpr that)`
`double`	`pow(double that)`
`double`	`pow(int exp)`
`INum`	`pow(INum val)`
`IInteger`	`round()` Returns the closest `IInteger` to the argument.
`int`	`sign()` Returns the signum function of this number (i.e., -1, 0 or 1 as the value of this number is negative, zero or positive).
`double`	`sqrt()`
`ISignedNumber`	`subtractFrom(ISignedNumber that)` Subtract `that` signed number from `this` signed number
`double`	`times(double that)`
`IExpr`	`times(IExpr that)` Returns the product of this object with the one specified.
`int`	`toInt()` Converts this double value to an `int` value; unlike `INum.intValue()` this method raises `ArithmeticException` if this integer cannot be represented by an `int` type.
`long`	`toLong()` Converts this number to `long`; unlike `#longValue` this method raises `ArithmeticException` if this number cannot be represented by an `long` type.
`java.lang.String`	`toString()`
`static Num`	`valueOf(double doubleValue)`
`static double`	`valueOf(java.lang.String chars)`

Methods inherited from class org.matheclipse.core.expression.ExprImpl
abs, and, apply, apply, asType, copy, divide, egcd, evaluate, factory, fullFormString, gcd, getAt, internalFormString, isAnd, isArcCos, isArcCosh, isArcSin, isArcSinh, isArcTan, isArcTanh, isAST, isAST, isAST, isAST, isAST, isAST, isASTSizeGE, isAtom, isComplex, isComplexInfinity, isComplexNumeric, isCondition, isConstant, isCos, isCosh, isDirectedInfinity, isFalse, isFlatAST, isFraction, isFree, isFree, isFunction, isGEOrdered, isGTOrdered, isInfinity, isInteger, isLEOrdered, isList, isListOfLists, isLog, isLTOrdered, isMatrix, isMember, isMember, isModule, isNegativeInfinity, isNot, isNumber, isNumeric, isNumericFunction, isONE, isOr, isOrderlessAST, isPattern, isPatternExpr, isPatternSequence, isPlus, isPower, isRational, isRealFunction, isRuleAST, isSame, isSequence, isSignedNumber, isSin, isSinh, isSlot, isSlotSequence, isSymbol, isTan, isTanh, isTimes, isTrue, isUnit, isValue, isVector, isZERO, leaves, minus, mod, multiply, negative, or, power, power, remainder, replaceAll, replaceAll, replacePart, replaceRepeated, replaceRepeated, replaceRepeated, replaceSlots, signum, subtract, sum, topHead, toScript, toScriptFactory, variables2Slots

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

Methods inherited from interface org.matheclipse.core.interfaces.IExpr
and, apply, apply, asType, evaluate, fullFormString, getAt, internalFormString, isAnd, isArcCos, isArcCosh, isArcSin, isArcSinh, isArcTan, isArcTanh, isAST, isAST, isAST, isAST, isAST, isAST, isASTSizeGE, isAtom, isComplex, isComplexInfinity, isComplexNumeric, isCondition, isConstant, isCos, isCosh, isDirectedInfinity, isFalse, isFlatAST, isFraction, isFree, isFree, isFunction, isGEOrdered, isGTOrdered, isInfinity, isInteger, isLEOrdered, isList, isListOfLists, isLog, isLTOrdered, isMatrix, isMember, isMember, isModule, isNegativeInfinity, isNot, isNumber, isNumeric, isNumericFunction, isOr, isOrderlessAST, isPattern, isPatternExpr, isPatternSequence, isPlus, isPower, isRational, isRealFunction, isRuleAST, isSame, isSequence, isSignedNumber, isSin, isSinh, isSlot, isSlotSequence, isSymbol, isTan, isTanh, isTimes, isTrue, isValue, isVector, leaves, minus, mod, multiply, negative, or, power, power, replaceAll, replaceAll, replacePart, replaceRepeated, replaceRepeated, replaceSlots, signum, topHead, variables2Slots

Methods inherited from interface edu.jas.structure.RingElem
egcd, gcd

Methods inherited from interface edu.jas.structure.AbelianGroupElem
abs, isZERO, subtract, sum

Methods inherited from interface edu.jas.structure.MonoidElem
divide, isONE, isUnit, remainder

Methods inherited from interface edu.jas.structure.Element
copy, factory, toScript, toScriptFactory

- Method Detail
  - hierarchy
```
public int hierarchy()
```
    Description copied from interface: IExpr
    
    A unique integer ID for the implementation of this expression
    
    Specified by:
    
    hierarchy in interface IExpr
    
    Returns:
    
    a unique integer id for the implementation of this expression
  - isNumEqualInteger
```
public boolean isNumEqualInteger(IInteger ii)
                          throws java.lang.ArithmeticException
```
    Check if this expression equals an IInteger value. The value of an INum or the value of an IInteger object can be an IInteger value.
    
    Specified by:
    
    isNumEqualInteger in interface IExpr
    
    Overrides:
    
    isNumEqualInteger in class ExprImpl
    
    Returns:
    
    Throws:
    
    java.lang.ArithmeticException
  - isNumIntValue
```
public boolean isNumIntValue()
```
    Check if this expression represents an int value. The value of an INum object can be an int value.
    
    Specified by:
    
    isNumIntValue in interface IExpr
    
    Specified by:
    
    isNumIntValue in interface INum
    
    Overrides:
    
    isNumIntValue in class ExprImpl
    
    Returns:
  - isNegative
```
public boolean isNegative()
```
    Test if this object is a negative signed number.
    
    Specified by:
    
    isNegative in interface IExpr
    
    Specified by:
    
    isNegative in interface ISignedNumber
    
    Overrides:
    
    isNegative in class ExprImpl
    
    Returns:
    
    true, if this < 0; false in all other case.
  - isPositive
```
public boolean isPositive()
```
    Test if this object is a positive signed number.
    
    Specified by:
    
    isPositive in interface IExpr
    
    Specified by:
    
    isPositive in interface ISignedNumber
    
    Overrides:
    
    isPositive in class ExprImpl
    
    Returns:
    
    true, if this > 0; false in all other case.
  - equalsInt
```
public boolean equalsInt(int i)
```
    Description copied from interface: INumber
    
    Is this number equal an integer number?
    
    Specified by:
    
    equalsInt in interface INumber
    
    Returns:
  - add
```
public INum add(INum val)
```
    Specified by:
    
    add in interface INum
  - multiply
```
public INum multiply(INum val)
```
    Specified by:
    
    multiply in interface INum
  - pow
```
public INum pow(INum val)
```
    Specified by:
    
    pow in interface INum
  - valueOf
```
public static double valueOf(java.lang.String chars)
```
    Parameters:
    
    chars -
    
    Returns:
  - valueOf
```
public static Num valueOf(double doubleValue)
```
    Parameters:
    
    doubleValue -
    
    Returns:
  - eabs
```
public Num eabs()
```
    Description copied from interface: INumber
    
    Get the absolute value for a given number
    
    Specified by:
    
    eabs in interface INumber
    
    Returns:
  - plus
```
public double plus(double that)
```
    Parameters:
    
    that -
    
    Returns:
  - plus
```
public IExpr plus(IExpr that)
```
    Specified by:
    
    plus in interface IExpr
    
    Overrides:
    
    plus in class ExprImpl
  - divideBy
```
public ISignedNumber divideBy(ISignedNumber that)
```
    Description copied from interface: ISignedNumber
    
    Divide this signed number by that signed number.
    
    Specified by:
    
    divideBy in interface ISignedNumber
    
    Parameters:
    
    that - a signed number
    
    Returns:
  - subtractFrom
```
public ISignedNumber subtractFrom(ISignedNumber that)
```
    Description copied from interface: ISignedNumber
    
    Subtract that signed number from this signed number
    
    Specified by:
    
    subtractFrom in interface ISignedNumber
    
    Parameters:
    
    that - a signed number
    
    Returns:
  - compareTo
```
public int compareTo(double that)
```
    Parameters:
    
    that -
    
    Returns:
  - divide
```
public double divide(double that)
```
    Parameters:
    
    that -
    
    Returns:
  - doubleValue
```
public double doubleValue()
```
    Specified by:
    
    doubleValue in interface ISignedNumber
    
    Returns:
  - equals
```
public boolean equals(java.lang.Object arg0)
```
    Description copied from interface: Element
    
    Test if this is equal to b.
    
    Specified by:
    
    equals in interface Element<IExpr>
    
    Overrides:
    
    equals in class java.lang.Object
    
    Returns:
    
    true if this is equal to b, else false.
  - isSame
```
public boolean isSame(IExpr expression,
                      double epsilon)
```
    Description copied from interface: IExpr
    
    Test if this expression equals the given expression. If the compared expressions are of the same numeric type, they are equal to a given EPSILON
    
    Specified by:
    
    isSame in interface IExpr
    
    Overrides:
    
    isSame in class ExprImpl
  - exp
```
public double exp()
```
  - hashCode
```
public final int hashCode()
```
    Description copied from interface: Element
    
    Hashcode of this Element.
    
    Specified by:
    
    hashCode in interface Element<IExpr>
    
    Overrides:
    
    hashCode in class java.lang.Object
    
    Returns:
    
    the hashCode.
  - intValue
```
public int intValue()
```
    Description copied from interface: INum
    
    Returns the value of this number as an int (by simply casting to type int).
    
    Specified by:
    
    intValue in interface INum
    
    Returns:
  - toInt
```
public int toInt()
          throws java.lang.ArithmeticException
```
    Converts this double value to an int value; unlike INum.intValue() this method raises ArithmeticException if this integer cannot be represented by an int type.
    
    Specified by:
    
    toInt in interface INum
    
    Specified by:
    
    toInt in interface ISignedNumber
    
    Returns:
    
    the numeric value represented by this integer after conversion to type int.
    
    Throws:
    
    java.lang.ArithmeticException - if conversion to int is not possible.
  - toLong
```
public long toLong()
            throws java.lang.ArithmeticException
```
    Converts this number to long; unlike #longValue this method raises ArithmeticException if this number cannot be represented by an long type.
    
    Specified by:
    
    toLong in interface ISignedNumber
    
    Returns:
    
    the numeric value represented by this integer after conversion to type long.
    
    Throws:
    
    java.lang.ArithmeticException - if conversion to int is not possible.
  - isInfinite
```
public boolean isInfinite()
```
    Returns:
  - isNaN
```
public boolean isNaN()
```
    Returns:
  - log
```
public double log()
```
    Returns:
  - longValue
```
public long longValue()
```
    Returns:
  - times
```
public double times(double that)
```
    Parameters:
    
    that -
    
    Returns:
  - times
```
public IExpr times(IExpr that)
```
    Description copied from interface: IExpr
    
    Returns the product of this object with the one specified.
    
    Specified by:
    
    times in interface IExpr
    
    Overrides:
    
    times in class ExprImpl
    
    Parameters:
    
    that - the object multiplier.
    
    Returns:
    
    this · that.
  - negate
```
public ISignedNumber negate()
```
    Description copied from interface: AbelianGroupElem
    
    Negate this.
    
    Specified by:
    
    negate in interface AbelianGroupElem<IExpr>
    
    Specified by:
    
    negate in interface ISignedNumber
    
    Overrides:
    
    negate in class ExprImpl
    
    Returns:
  - opposite
```
public ISignedNumber opposite()
```
    Specified by:
    
    opposite in interface INumber
    
    Specified by:
    
    opposite in interface ISignedNumber
    
    Overrides:
    
    opposite in class ExprImpl
    
    Returns:
  - pow
```
public double pow(double that)
```
    Parameters:
    
    that -
    
    Returns:
  - pow
```
public double pow(int exp)
```
    Parameters:
    
    exp -
    
    Returns:
  - inverse
```
public ISignedNumber inverse()
```
    Description copied from interface: IExpr
    
    Returns the multiplicative inverse of this object. It is the object such as this.times(this.inverse()) == ONE , with ONE being the multiplicative identity.
    
    Specified by:
    
    inverse in interface MonoidElem<IExpr>
    
    Specified by:
    
    inverse in interface IExpr
    
    Specified by:
    
    inverse in interface ISignedNumber
    
    Overrides:
    
    inverse in class ExprImpl
    
    Returns:
    
    ONE / this.
  - sqrt
```
public double sqrt()
```
    Returns:
  - minus
```
public double minus(double that)
```
    Parameters:
    
    that -
    
    Returns:
  - getRealPart
```
public double getRealPart()
```
    Specified by:
    
    getRealPart in interface INum
    
    Returns:
  - isZero
```
public boolean isZero()
```
    Description copied from interface: IExpr
    
    Test if this expression equals 0 in symbolic or numeric mode.
    
    Specified by:
    
    isZero in interface IExpr
    
    Specified by:
    
    isZero in interface ISignedNumber
    
    Overrides:
    
    isZero in class ExprImpl
  - isOne
```
public boolean isOne()
```
    Description copied from interface: IExpr
    
    Test if this expression equals 1 in symbolic or numeric mode.
    
    Specified by:
    
    isOne in interface IExpr
    
    Overrides:
    
    isOne in class ExprImpl
  - isMinusOne
```
public boolean isMinusOne()
```
    Description copied from interface: IExpr
    
    Test if this expression equals -1 in symbolic or numeric mode.
    
    Specified by:
    
    isMinusOne in interface IExpr
    
    Overrides:
    
    isMinusOne in class ExprImpl
  - round
```
public IInteger round()
```
    Description copied from interface: ISignedNumber
    
    Returns the closest IInteger to the argument. The result is rounded to an integer by adding 1/2 and taking the floor of the result.
    This method raises ArithmeticException if a numeric value cannot be represented by an long type.
    
    Specified by:
    
    round in interface ISignedNumber
    
    Returns:
    
    the closest integer to the argument.
  - sign
```
public int sign()
```
    Description copied from interface: ISignedNumber
    
    Returns the signum function of this number (i.e., -1, 0 or 1 as the value of this number is negative, zero or positive).
    
    Specified by:
    
    sign in interface ISignedNumber
    
    Returns:
    
    -1 if this is a negative number;
    0 if this is a zero;
    -1 if this is a negative number;
  - complexSign
```
public int complexSign()
```
    Gets the signum value of a complex number
    
    Specified by:
    
    complexSign in interface INumber
    
    Returns:
    
    0 for this == 0; +1 for real(this) > 0 or ( real(this)==0 && imaginary(this) > 0 ); -1 for real(this) < 0 || ( real(this) == 0 && imaginary(this) < 0 )
  ceil public IInteger ceil() Returns the smallest (closest to negative infinity) IInteger value that is not less than this and is equal to a mathematical integer. This method raises ArithmeticException if a numeric value cannot be represented by an long type. Specified by: ceil in interface ISignedNumber Returns: the smallest (closest to negative infinity) IInteger value that is not less than this and is equal to a mathematical integer. floor public IInteger floor() Returns the largest (closest to positive infinity) IInteger value that is not greater than this and is equal to a mathematical integer. This method raises ArithmeticException if a numeric value cannot be represented by an long type. Specified by: floor in interface ISignedNumber Returns: the largest (closest to positive infinity) IInteger value that is not greater than this and is equal to a mathematical integer. compareTo public int compareTo(IExpr obj) Compares this expression with the specified expression for order. Returns a negative integer, zero, or a positive integer as this expression is canonical less than, equal to, or greater than the specified expression. Specified by: compareTo in interface Element<IExpr> Specified by: compareTo in interface java.lang.Comparable<IExpr> Specified by: compareTo in interface IExpr Returns: 0 if this is equal to b, -1 if this is less then b, else +1. isLessThan public boolean isLessThan(ISignedNumber that) Specified by: isLessThan in interface ISignedNumber isGreaterThan public boolean isGreaterThan(ISignedNumber that) Specified by: isGreaterThan in interface ISignedNumber head public ISymbol head() Description copied from interface: IExpr If this object is an instance of IAST get the first element (offset 0) of the IAST list (i.e. get(0) ). Specified by: head in interface IExpr Specified by: head in class ExprImpl Returns: the head of the expression, which must not be null. toString public java.lang.String toString() Overrides: toString in class java.lang.Object accept public <T> T accept(IVisitor<T> visitor) Accept a visitor with return type T Specified by: accept in interface IExpr accept public boolean accept(IVisitorBoolean visitor) Accept a visitor with return type boolean Specified by: accept in interface IExpr accept public int accept(IVisitorInt visitor) Accept a visitor with return type int Specified by: accept in interface IExpr Returns: getIm public ISignedNumber getIm() Returns the imaginary part of a complex number Specified by: getIm in interface INumber Returns: real part getRe public ISignedNumber getRe() Returns the real part of a complex number Specified by: getRe in interface INumber Returns: real part







Skip navigation links




Overview
Package
Class





Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






DMelt 3.0 © DataMelt by jWork.ORG

Class Num

Field Summary

Fields inherited from interface org.matheclipse.core.interfaces.IExpr

Method Summary

Methods inherited from class org.matheclipse.core.expression.ExprImpl

Methods inherited from class java.lang.Object

Methods inherited from interface org.matheclipse.core.interfaces.IExpr

Methods inherited from interface edu.jas.structure.RingElem

Methods inherited from interface edu.jas.structure.AbelianGroupElem

Methods inherited from interface edu.jas.structure.MonoidElem

Methods inherited from interface edu.jas.structure.Element

Method Detail

hierarchy

isNumEqualInteger

isNumIntValue

isNegative

isPositive

equalsInt

add

multiply

pow

valueOf

valueOf

eabs

plus

plus

divideBy

subtractFrom

compareTo

divide

doubleValue

equals

isSame

exp

hashCode

intValue

toInt

toLong

isInfinite

isNaN

log

longValue

times

times

negate

opposite

pow

pow

inverse

sqrt

minus

getRealPart

isZero

isOne

isMinusOne

round

sign

complexSign

ceil

floor

compareTo

isLessThan

isGreaterThan

head

toString

accept

accept

accept

getIm

getRe