|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.rubato.math.module.RingElement
org.rubato.math.module.CElement
public final class CElement
Elements in the field of complex numbers.
CRing
,
Serialized FormConstructor Summary | |
---|---|
CElement(Complex value)
Constructs a CElement with complex number value . |
|
CElement(double value)
Constructs a CElement with complex (real) number value . |
|
CElement(double x,
double y)
Constructs a CElement with complex number x + i y . |
Method Summary | |
---|---|
void |
add(CElement element)
|
void |
add(ModuleElement element)
Adds element to this module element. |
ModuleElement |
cast(Module module)
Tries to cast this element to an element in the given module. |
CElement |
clone()
Returns a deep copy of this module element. |
int |
compareTo(ModuleElement object)
Compares this module element with object . |
void |
conjugate()
Conjugates this element. |
CElement |
conjugated()
Returns the conjugate of this element. |
CElement |
difference(CElement element)
|
CElement |
difference(ModuleElement element)
Returns the difference of this module element and element . |
void |
divide(CElement element)
|
void |
divide(RingElement element)
Replaces this by the solution x of
element *x = this , if it exists,
otherwise a DivisionException is thrown. |
boolean |
divides(RingElement element)
Return true iff the solution x of this *x = element
exists. |
boolean |
equals(java.lang.Object object)
Returns true iff this element is equal to object . |
double[] |
fold(ModuleElement[] elements)
Fold elements assuming they are of this same type. |
ModuleElement |
fromXML(XMLReader reader,
org.w3c.dom.Element element)
Reads XML representation from reader starting with element . |
CElement |
getComponent(int i)
Returns the i -th component of this free element. |
java.lang.String |
getElementTypeName()
Returns the value of the type attribute for this class. |
CRing |
getModule()
Returns the module that this module element is an element of. |
CElement |
getRingElement(int i)
Returns the i -th ring component of this free element. |
Complex |
getValue()
Returns the complex value contained in this element. |
static XMLInputOutput<ModuleElement> |
getXMLInputOutput()
|
int |
hashCode()
Returns the hash code for this module element. |
CElement |
inverse()
Returns the inverse of this ring element, if it has an inverse. |
void |
invert()
Inverts this ring element, if it has an inverse. |
boolean |
isInvertible()
Returns true if this ring element is invertible. |
boolean |
isOne()
Returns true if this ring element is one. |
boolean |
isZero()
Returns true iff this element is zero. |
void |
multiply(CElement element)
|
void |
multiply(RingElement element)
Multiplies this ring element with element . |
void |
negate()
Negate this module element. |
CElement |
negated()
Returns the negative of this module element. |
CElement |
power(int n)
Raises this ring element to the power n . |
CElement |
product(CElement element)
|
CElement |
product(RingElement element)
Returns the product of this ring element with element . |
CElement |
quotient(CElement element)
|
CElement |
quotient(RingElement element)
Returns the solution x of element *x = this ,
if it exists, otherwise a DivisionException is thrown. |
CFreeElement |
resize(int n)
Returns this free element resized to length n . |
void |
scale(RingElement element)
Multiplies this element with element . |
CElement |
scaled(RingElement element)
Returns the product of this element with element . |
java.lang.String |
stringRep(boolean... parens)
Returns a string representation of this module element. |
void |
subtract(CElement element)
|
void |
subtract(ModuleElement element)
Subtracts element from this module element. |
CElement |
sum(CElement element)
|
CElement |
sum(ModuleElement element)
Returns the sum of this module element and element . |
java.lang.String |
toString()
Returns a human readable string representation of this module element. |
void |
toXML(XMLWriter writer)
Outputs XML representation to writer . |
Methods inherited from class org.rubato.math.module.RingElement |
---|
difference, getLength, getRing, iterator, multiplyCW, productCW, sum |
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, wait, wait, wait |
Methods inherited from interface org.rubato.math.module.FreeElement |
---|
getLength, iterator, multiplyCW, productCW |
Constructor Detail |
---|
public CElement(Complex value)
value
.
public CElement(double value)
value
.
public CElement(double x, double y)
x
+ i y
.
Method Detail |
---|
public boolean isOne()
RingElement
isOne
in class RingElement
public boolean isZero()
ModuleElement
isZero
in interface ModuleElement
public CElement sum(ModuleElement element) throws DomainException
ModuleElement
element
.
sum
in interface CFreeElement
sum
in interface ModuleElement
DomainException
- if element
is not in domainpublic CElement sum(CElement element)
public void add(ModuleElement element) throws DomainException
ModuleElement
element
to this module element.
This is a destructive operation.
add
in interface ModuleElement
DomainException
- if element
is not in domainpublic void add(CElement element)
public CElement difference(ModuleElement element) throws DomainException
ModuleElement
element
.
difference
in interface CFreeElement
difference
in interface ModuleElement
DomainException
- if element
is not in domainpublic CElement difference(CElement element)
public void subtract(ModuleElement element) throws DomainException
ModuleElement
element
from this module element.
This is a destructive operation.
subtract
in interface ModuleElement
DomainException
- if element
is not in domainpublic void subtract(CElement element)
public CElement negated()
ModuleElement
negated
in interface CFreeElement
negated
in interface ModuleElement
public void negate()
ModuleElement
negate
in interface ModuleElement
public CElement conjugated()
CFreeElement
conjugated
in interface CFreeElement
public void conjugate()
CFreeElement
conjugate
in interface CFreeElement
public CElement scaled(RingElement element) throws DomainException
ModuleElement
element
.
scaled
in interface CFreeElement
scaled
in interface ModuleElement
DomainException
- if element
is not in domainpublic void scale(RingElement element) throws DomainException
ModuleElement
element
.
This is a destructive operation.
scale
in interface ModuleElement
DomainException
- if element
is not in domainpublic CElement product(RingElement element) throws DomainException
RingElement
element
.
product
in class RingElement
DomainException
- if element
is not in domainpublic CElement product(CElement element)
public void multiply(RingElement element) throws DomainException
RingElement
element
.
multiply
in class RingElement
DomainException
- if element
is not in domainpublic void multiply(CElement element)
public boolean isInvertible()
RingElement
isInvertible
in class RingElement
public CElement inverse()
RingElement
inverse
in class RingElement
public void invert()
RingElement
invert
in class RingElement
public CElement quotient(RingElement element) throws DomainException, DivisionException
RingElement
element
*x = this
,
if it exists, otherwise a DivisionException is thrown.
quotient
in class RingElement
DomainException
DivisionException
public CElement quotient(CElement element) throws DivisionException
DivisionException
public void divide(RingElement element) throws DomainException, DivisionException
RingElement
this
by the solution x of
element
*x = this
, if it exists,
otherwise a DivisionException is thrown.
divide
in class RingElement
DomainException
DivisionException
public void divide(CElement element) throws DivisionException
DivisionException
public boolean divides(RingElement element)
RingElement
this
*x = element
exists.
divides
in class RingElement
public CElement power(int n)
RingElement
n
.
power
in class RingElement
public CRing getModule()
ModuleElement
getModule
in interface ModuleElement
public CElement getComponent(int i)
FreeElement
i
-th component of this free element.
getComponent
in interface CFreeElement
getComponent
in interface FreeElement
getComponent
in interface ModuleElement
getComponent
in class RingElement
public CElement getRingElement(int i)
FreeElement
i
-th ring component of this free element.
getRingElement
in interface CFreeElement
getRingElement
in interface FreeElement
getRingElement
in class RingElement
public Complex getValue()
public CFreeElement resize(int n)
FreeElement
n
.
If the new length n
is greater than the old length,
the new values are filled with the zero of the underlying ring.
If the new length n
is less than the old length,
the vector of values is simply truncated.
resize
in interface CFreeElement
resize
in interface FreeElement
public boolean equals(java.lang.Object object)
ModuleElement
object
.
equals
in interface ModuleElement
equals
in class java.lang.Object
public int compareTo(ModuleElement object)
ModuleElement
object
.
compareTo
in interface java.lang.Comparable<ModuleElement>
compareTo
in interface ModuleElement
compareTo
in class RingElement
public CElement clone()
ModuleElement
clone
in interface CFreeElement
clone
in interface ModuleElement
clone
in class RingElement
public java.lang.String stringRep(boolean... parens)
ModuleElement
stringRep
in interface ModuleElement
stringRep
in class RingElement
public java.lang.String toString()
ModuleElement
toString
in interface ModuleElement
toString
in class java.lang.Object
public double[] fold(ModuleElement[] elements)
ModuleElement
elements
assuming they are of this same type.
fold
in interface ModuleElement
public ModuleElement cast(Module module)
ModuleElement
cast
in interface ModuleElement
public void toXML(XMLWriter writer)
XMLInputOutput
writer
.
toXML
in interface XMLInputOutput<ModuleElement>
public ModuleElement fromXML(XMLReader reader, org.w3c.dom.Element element)
XMLInputOutput
reader
starting with element
.
fromXML
in interface XMLInputOutput<ModuleElement>
public static XMLInputOutput<ModuleElement> getXMLInputOutput()
public java.lang.String getElementTypeName()
XMLInputOutput
getElementTypeName
in interface XMLInputOutput<ModuleElement>
public int hashCode()
ModuleElement
hashCode
in interface ModuleElement
hashCode
in class java.lang.Object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |