org.matheclipse.core.interfaces

Interface ISignedNumber

All Superinterfaces:

AbelianGroupElem<IExpr>, java.lang.Comparable<IExpr>, Element<IExpr>, IExpr, INumber, MonoidElem<IExpr>, RingElem<IExpr>, java.io.Serializable

All Known Subinterfaces:

IFraction, IInteger, INum, IRational

All Known Implementing Classes:

FractionSym, IntegerSym, Num

public interface ISignedNumber
extends INumber

interface for "ractional" numbers (i.e. IInteger or IFraction)

Field Summary

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

ASTID, COMPLEXID, DOUBLECOMPLEXID, DOUBLEID, FRACTIONID, INTEGERID, METHODSYMBOLID, PATTERNID, STRINGID, SYMBOLID

Method Summary

Modifier and Type	Method and Description
IInteger	ceil() Returns the smallest (closest to negative infinity) IInteger value that is not less than this and is equal to a mathematical integer.
ISignedNumber	divideBy(ISignedNumber that) Divide this signed number by that signed number.
double	doubleValue()
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	inverse() Returns the multiplicative inverse of this object.
boolean	isGreaterThan(ISignedNumber that)
boolean	isLessThan(ISignedNumber that)
boolean	isNegative() Test if this number is negative.
boolean	isPositive() Test if this number is positive.
boolean	isZero() Test if this expression equals 0 in symbolic or numeric mode.
ISignedNumber	negate() Returns (-1) * this
ISignedNumber	opposite()
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).
ISignedNumber	subtractFrom(ISignedNumber that) Subtract that signed number from this signed number
int	toInt() Converts this number to int; unlike #intValue this method raises ArithmeticException if this number 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.

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

complexSign, eabs, equalsInt, getIm, getRe

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

accept, accept, accept, and, apply, apply, asType, compareTo, evaluate, fullFormString, getAt, head, hierarchy, 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, isMinusOne, isModule, isNegativeInfinity, isNot, isNumber, isNumEqualInteger, isNumeric, isNumericFunction, isNumIntValue, isOne, isOr, isOrderlessAST, isPattern, isPatternExpr, isPatternSequence, isPlus, isPower, isRational, isRealFunction, isRuleAST, isSame, isSame, isSequence, isSignedNumber, isSin, isSinh, isSlot, isSlotSequence, isSymbol, isTan, isTanh, isTimes, isTrue, isValue, isVector, leaves, minus, mod, multiply, negative, or, plus, power, power, replaceAll, replaceAll, replacePart, replaceRepeated, replaceRepeated, replaceSlots, signum, times, 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, equals, factory, hashCode, toScript, toScriptFactory

Method Detail

isNegative

boolean isNegative()

Test if this number is negative.

Specified by:

isNegative in interface IExpr

Returns:

true, if this < 0

isPositive

boolean isPositive()

Test if this number is positive.

Specified by:

isPositive in interface IExpr

Returns:

true, if this > 0

isZero

boolean isZero()

Test if this expression equals 0 in symbolic or numeric mode.

Specified by:

isZero in interface IExpr

isLessThan

boolean isLessThan(ISignedNumber that)

isGreaterThan

boolean isGreaterThan(ISignedNumber that)

negate

ISignedNumber negate()

Returns (-1) * this

Specified by:

negate in interface AbelianGroupElem<IExpr>

Returns:

divideBy

ISignedNumber divideBy(ISignedNumber that)

Divide this signed number by that signed number.

Parameters:

that - a signed number

Returns:

subtractFrom

ISignedNumber subtractFrom(ISignedNumber that)

Subtract that signed number from this signed number

Parameters:

that - a signed number

Returns:

sign

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).

Returns:

-1 if this is a negative number;
0 if this is a zero;
-1 if this is a negative number;

toInt

int toInt()
   throws java.lang.ArithmeticException

Converts this number to int; unlike #intValue this method raises ArithmeticException if this number cannot be represented by an int type.

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

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.

Returns:

the numeric value represented by this integer after conversion to type long.

Throws:

java.lang.ArithmeticException - if conversion to int is not possible.

ceil

IInteger ceil()
       throws java.lang.ArithmeticException

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.

Returns:

the smallest (closest to negative infinity) IInteger value that is not less than this and is equal to a mathematical integer.

Throws:

java.lang.ArithmeticException

floor

IInteger floor()
        throws java.lang.ArithmeticException

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.

Returns:

the largest (closest to positive infinity) IInteger value that is not greater than this and is equal to a mathematical integer.

Throws:

java.lang.ArithmeticException

round

IInteger round()

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.

Returns:

the closest integer to the argument.

inverse

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 IExpr

Specified by:

inverse in interface MonoidElem<IExpr>

Returns:

ONE / this.

opposite

ISignedNumber opposite()

Specified by:

opposite in interface INumber

doubleValue

double doubleValue()