org.matheclipse.core.expression

Class ComplexNum

java.lang.Object

org.matheclipse.core.expression.ExprImpl

org.matheclipse.core.expression.ComplexNum

All Implemented Interfaces:

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

public class ComplexNum
extends ExprImpl
implements IComplexNum

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static ComplexNum	I The square root of -1.
static ComplexNum	NaN A complex number representing "NaN + NaNi"
static ComplexNum	ONE A complex number representing "1.0 + 0.0i"
static ComplexNum	ZERO A complex number representing "0.0 + 0.0i"

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
<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
Complex	add(Complex that)
ComplexNum	add(ComplexNum that)
IComplexNum	add(IComplexNum val)
int	compareTo(Complex that)
int	compareTo(IExpr obj) Compares this expression with the specified expression for order.
int	complexSign() Gets the signum value of a complex number
IComplexNum	conjugate()
double	dabs() Return the absolute value of this complex number.
Complex	divide(Complex that)
ComplexNum	divide(ComplexNum that)
Num	eabs() Get the absolute value for a given number
boolean	equals(java.lang.Object obj) Test if this is equal to b.
boolean	equalsInt(int i) Is this number equal an integer number?
IExpr	evaluate(EvalEngine engine) Evaluate an expression
Complex	getCMComplex()
Complex	getComplex()
ISignedNumber	getIm() Returns the imaginary part of a complex number
double	getImaginary()
double	getImaginaryPart()
ISignedNumber	getRe() Returns the real part of a complex number
double	getReal()
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
IExpr	inverse() Returns the multiplicative inverse of this object.
boolean	isInfinite()
boolean	isNaN()
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.
ComplexNum	multiply(ComplexNum that)
IComplexNum	multiply(IComplexNum val)
ComplexNum	negate() Negate this.
INumber	opposite()
IExpr	plus(IExpr that)
IComplexNum	pow(IComplexNum val)
Complex	subtract(Complex that)
ComplexNum	subtract(ComplexNum that)
IExpr	times(IExpr that) Returns the product of this object with the one specified.
java.lang.String	toString()
static ComplexNum	valueOf(double real)
static ComplexNum	valueOf(double real, double imaginary)
static ComplexNum	valueOf(INum d)

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

abs, and, apply, apply, asType, copy, divide, egcd, 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, isMinusOne, isModule, isNegative, isNegativeInfinity, isNot, isNumber, isNumEqualInteger, isNumeric, isNumericFunction, isNumIntValue, isOne, isONE, isOr, isOrderlessAST, isPattern, isPatternExpr, isPatternSequence, isPlus, isPositive, 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, 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, isMinusOne, isModule, isNegative, isNegativeInfinity, isNot, isNumber, isNumEqualInteger, isNumeric, isNumericFunction, isNumIntValue, isOne, isOr, isOrderlessAST, isPattern, isPatternExpr, isPatternSequence, isPlus, isPositive, 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

Field Detail

I

public static final ComplexNum I

The square root of -1. A number representing "0.0 + 1.0i"

NaN

public static final ComplexNum NaN

A complex number representing "NaN + NaNi"

ONE

public static final ComplexNum ONE

A complex number representing "1.0 + 0.0i"

ZERO

public static final ComplexNum ZERO

A complex number representing "0.0 + 0.0i"

Method Detail

valueOf

public static ComplexNum valueOf(INum d)

valueOf

public static ComplexNum valueOf(double real)

valueOf

public static ComplexNum valueOf(double real,
                                 double imaginary)

getImaginaryPart

public double getImaginaryPart()

Specified by:

getImaginaryPart in interface IComplexNum

Returns:

getRealPart

public double getRealPart()

Specified by:

getRealPart in interface IComplexNum

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

Overrides:

isZero in class ExprImpl

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

add

public IComplexNum add(IComplexNum val)

Specified by:

add in interface IComplexNum

add

public ComplexNum add(ComplexNum that)

multiply

public IComplexNum multiply(IComplexNum val)

Specified by:

multiply in interface IComplexNum

pow

public IComplexNum pow(IComplexNum val)

Specified by:

pow in interface IComplexNum

add

public Complex add(Complex that)

Parameters:

that -

Returns:

conjugate

public IComplexNum conjugate()

Specified by:

conjugate in interface IComplexNum

Returns:

divide

public Complex divide(Complex that)

Parameters:

that -

Returns:

divide

public ComplexNum divide(ComplexNum that)
                  throws java.lang.ArithmeticException

Throws:

java.lang.ArithmeticException

equals

public boolean equals(java.lang.Object obj)

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

Parameters:

that -

tolerance -

Returns:

evaluate

public IExpr evaluate(EvalEngine engine)

Evaluate an expression

Specified by:

evaluate in interface IExpr

Overrides:

evaluate in class ExprImpl

Parameters:

engine - the evaluation engine

Returns:

the evaluated Object or null if the evaluation is not possible (i.e. the evaluation doesn't change the object).

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

dabs

public double dabs()

Return the absolute value of this complex number.

Returns NaN if either real or imaginary part is NaN and Double.POSITIVE_INFINITY if neither part is NaN, but at least one part takes an infinite value.

Specified by:

dabs in interface IComplexNum

Returns:

the absolute value

eabs

public Num eabs()

Description copied from interface: INumber

Get the absolute value for a given number

Specified by:

eabs in interface INumber

Returns:

getImaginary

public double getImaginary()

Returns:

getReal

public double getReal()

Returns:

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.

isInfinite

public boolean isInfinite()

Returns:

isNaN

public boolean isNaN()

Returns:

multiply

public ComplexNum multiply(ComplexNum that)

Parameters:

that -

Returns:

negate

public ComplexNum negate()

Description copied from interface: AbelianGroupElem

Negate this.

Specified by:

negate in interface AbelianGroupElem<IExpr>

Overrides:

negate in class ExprImpl

Returns:

opposite

public INumber opposite()

Specified by:

opposite in interface INumber

Overrides:

opposite in class ExprImpl

Returns:

plus

public IExpr plus(IExpr that)

Specified by:

plus in interface IExpr

Overrides:

plus in class ExprImpl

Parameters:

that -

Returns:

inverse

public IExpr 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

Overrides:

inverse in class ExprImpl

Parameters:

isPreserved -

Returns:

subtract

public Complex subtract(Complex that)

Parameters:

that -

Returns:

subtract

public ComplexNum subtract(ComplexNum that)

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 -

Returns:

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

complexSign

public int complexSign()

Description copied from interface: INumber

Gets the signum value of a complex number

Specified by:

complexSign in interface INumber

Returns:

compareTo

public int compareTo(Complex that)

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.

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.

getComplex

public Complex getComplex()

getCMComplex

public Complex getCMComplex()

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:

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:

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