org.matheclipse.core.expression

Class ComplexSym

java.lang.Object

org.matheclipse.core.expression.ExprImpl

org.matheclipse.core.expression.ComplexSym

All Implemented Interfaces:

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

public class ComplexSym
extends ExprImpl
implements IComplex

A concrete complex implementation

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static ComplexSym	ZERO Holds the factory constructing complex instances.

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
ComplexSym	add(ComplexSym parm1)
IComplex	add(IComplex parm1)
int	compareTo(IExpr obj) Compares this expression with the specified expression for order.
int	complexSign() Gets the signum value of a complex number
IComplex	conjugate()
IExpr	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
java.lang.String	fullFormString() Return the FullForm of this expression
ISignedNumber	getIm() Returns the imaginary part of a complex number
BigFraction	getImaginaryPart() Returns the imaginary part of a complex number
ISignedNumber	getRe() Returns the real part of a complex number
BigFraction	getRealPart() Returns the real part of a complex number
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
java.lang.String	internalFormString(boolean symbolsAsFactoryMethod, int depth) Return the internal Java form of this expression.
IExpr	inverse() Returns the multiplicative inverse of this object.
boolean	isZero() Test if this expression equals 0 in symbolic or numeric mode.
static void	main(java.lang.String[] args)
IComplex	multiply(IComplex parm1)
INumber	normalize() Return the normalized form of this number (i.e.
INumber	numericNumber() Create a numeric number from this exact "symbolic" number.
INumber	opposite()
IExpr	plus(IExpr that)
IComplex	pow(int parm1)
IExpr	times(IExpr that) Returns the product of this object with the one specified.
java.lang.String	toString()
static ComplexSym	valueOf(BigFraction real)
static ComplexSym	valueOf(BigFraction real, BigFraction imaginary)
static ComplexSym	valueOf(java.math.BigInteger real)
static ComplexSym	valueOf(java.math.BigInteger real, java.math.BigInteger imaginary)
static ComplexSym	valueOf(IFraction real)
static ComplexSym	valueOf(IFraction real, IFraction imaginary)
static ComplexSym	valueOf(IInteger real)
static ComplexSym	valueOf(IInteger real, IInteger imaginary)
static ComplexSym	valueOf(long real_numerator, long real_denominator, long imag_numerator, long imag_denominator)

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

abs, and, apply, apply, asType, copy, divide, egcd, factory, gcd, getAt, 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, isSame, isSequence, isSignedNumber, isSin, isSinh, isSlot, isSlotSequence, isSymbol, isTan, isTanh, isTimes, isTrue, isUnit, isValue, isVector, isZERO, leaves, minus, mod, multiply, negate, 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, getAt, 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, 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, negate, 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

ZERO

public static final ComplexSym ZERO

Holds the factory constructing complex instances.

Method Detail

valueOf

public static ComplexSym valueOf(java.math.BigInteger real,
                                 java.math.BigInteger imaginary)

valueOf

public static ComplexSym valueOf(java.math.BigInteger real)

valueOf

public static ComplexSym valueOf(IInteger real,
                                 IInteger imaginary)

valueOf

public static ComplexSym valueOf(IInteger real)

valueOf

public static ComplexSym valueOf(BigFraction real)

valueOf

public static ComplexSym valueOf(BigFraction real,
                                 BigFraction imaginary)

valueOf

public static ComplexSym valueOf(long real_numerator,
                                 long real_denominator,
                                 long imag_numerator,
                                 long imag_denominator)

valueOf

public static ComplexSym valueOf(IFraction real)

valueOf

public static ComplexSym valueOf(IFraction real,
                                 IFraction imaginary)

conjugate

public IComplex conjugate()

Specified by:

conjugate in interface IComplex

eabs

public IExpr eabs()

Description copied from interface: INumber

Get the absolute value for a given number

Specified by:

eabs in interface INumber

Returns:

add

public ComplexSym add(ComplexSym parm1)
               throws java.lang.ArithmeticException

Throws:

java.lang.ArithmeticException

add

public IComplex add(IComplex parm1)

Specified by:

add in interface IComplex

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

Returns:

true if this is equal to b, else false.

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

numericNumber

public final INumber numericNumber()

Description copied from interface: IBigNumber

Create a numeric number from this exact "symbolic" number.

Specified by:

numericNumber in interface IBigNumber

Returns:

getImaginaryPart

public BigFraction getImaginaryPart()

Returns the imaginary part of a complex number

Specified by:

getImaginaryPart in interface IComplex

Returns:

imaginary part

getIm

public ISignedNumber getIm()

Description copied from interface: INumber

Returns the imaginary part of a complex number

Specified by:

getIm in interface INumber

Returns:

real part

getRealPart

public BigFraction getRealPart()

Returns the real part of a complex number

Specified by:

getRealPart in interface IComplex

Returns:

real part

getRe

public ISignedNumber getRe()

Description copied from interface: INumber

Returns the real part of a complex number

Specified by:

getRe in interface INumber

Returns:

real part

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.

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

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

multiply

public IComplex multiply(IComplex parm1)

Specified by:

multiply in interface IComplex

pow

public IComplex pow(int parm1)

Specified by:

pow in interface IComplex

plus

public IExpr plus(IExpr that)

Specified by:

plus in interface IExpr

Overrides:

plus in class ExprImpl

opposite

public INumber opposite()

Specified by:

opposite in interface INumber

Overrides:

opposite in class ExprImpl

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.

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

Returns:

ONE / this.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

fullFormString

public java.lang.String fullFormString()

Description copied from interface: IExpr

Return the FullForm of this expression

Specified by:

fullFormString in interface IExpr

Overrides:

fullFormString in class ExprImpl

internalFormString

public java.lang.String internalFormString(boolean symbolsAsFactoryMethod,
                                           int depth)

Description copied from interface: IExpr

Return the internal Java form of this expression.

Specified by:

internalFormString in interface IExpr

Overrides:

internalFormString in class ExprImpl

Parameters:

symbolsAsFactoryMethod - if true use the F.symbol() method, otherwise print the symbol name.

depth - the recursion depth of this call. 0 indicates "recurse without a limit".

normalize

public INumber normalize()

Description copied from interface: IComplex

Return the normalized form of this number (i.e. if the imaginary part equals zero, return the real part as a fractional or integer number).

Specified by:

normalize in interface IComplex

Returns:

complexSign

public int complexSign()

Description copied from interface: INumber

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 )

main

public static void main(java.lang.String[] args)

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.

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: