org.rubato.math.module
Class CElement

java.lang.Object
  extended by org.rubato.math.module.RingElement
      extended by org.rubato.math.module.CElement
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<ModuleElement>, java.lang.Iterable<RingElement>, CFreeElement, FreeElement, ModuleElement, XMLInputOutput<ModuleElement>

public final class CElement
extends RingElement
implements CFreeElement

Elements in the field of complex numbers.

Author:
Gérard Milmeister
See Also:
CRing, Serialized Form

Constructor 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

CElement

public CElement(Complex value)
Constructs a CElement with complex number value.


CElement

public CElement(double value)
Constructs a CElement with complex (real) number value.


CElement

public CElement(double x,
                double y)
Constructs a CElement with complex number x + i y.

Method Detail

isOne

public boolean isOne()
Description copied from class: RingElement
Returns true if this ring element is one.

Specified by:
isOne in class RingElement

isZero

public boolean isZero()
Description copied from interface: ModuleElement
Returns true iff this element is zero.

Specified by:
isZero in interface ModuleElement

sum

public CElement sum(ModuleElement element)
             throws DomainException
Description copied from interface: ModuleElement
Returns the sum of this module element and element.

Specified by:
sum in interface CFreeElement
Specified by:
sum in interface ModuleElement
Throws:
DomainException - if element is not in domain

sum

public CElement sum(CElement element)

add

public void add(ModuleElement element)
         throws DomainException
Description copied from interface: ModuleElement
Adds element to this module element. This is a destructive operation.

Specified by:
add in interface ModuleElement
Throws:
DomainException - if element is not in domain

add

public void add(CElement element)

difference

public CElement difference(ModuleElement element)
                    throws DomainException
Description copied from interface: ModuleElement
Returns the difference of this module element and element.

Specified by:
difference in interface CFreeElement
Specified by:
difference in interface ModuleElement
Throws:
DomainException - if element is not in domain

difference

public CElement difference(CElement element)

subtract

public void subtract(ModuleElement element)
              throws DomainException
Description copied from interface: ModuleElement
Subtracts element from this module element. This is a destructive operation.

Specified by:
subtract in interface ModuleElement
Throws:
DomainException - if element is not in domain

subtract

public void subtract(CElement element)

negated

public CElement negated()
Description copied from interface: ModuleElement
Returns the negative of this module element.

Specified by:
negated in interface CFreeElement
Specified by:
negated in interface ModuleElement

negate

public void negate()
Description copied from interface: ModuleElement
Negate this module element. This is a destructive operation.

Specified by:
negate in interface ModuleElement

conjugated

public CElement conjugated()
Description copied from interface: CFreeElement
Returns the conjugate of this element.

Specified by:
conjugated in interface CFreeElement

conjugate

public void conjugate()
Description copied from interface: CFreeElement
Conjugates this element.

Specified by:
conjugate in interface CFreeElement

scaled

public CElement scaled(RingElement element)
                throws DomainException
Description copied from interface: ModuleElement
Returns the product of this element with element.

Specified by:
scaled in interface CFreeElement
Specified by:
scaled in interface ModuleElement
Throws:
DomainException - if element is not in domain

scale

public void scale(RingElement element)
           throws DomainException
Description copied from interface: ModuleElement
Multiplies this element with element. This is a destructive operation.

Specified by:
scale in interface ModuleElement
Throws:
DomainException - if element is not in domain

product

public CElement product(RingElement element)
                 throws DomainException
Description copied from class: RingElement
Returns the product of this ring element with element.

Specified by:
product in class RingElement
Throws:
DomainException - if element is not in domain

product

public CElement product(CElement element)

multiply

public void multiply(RingElement element)
              throws DomainException
Description copied from class: RingElement
Multiplies this ring element with element.

Specified by:
multiply in class RingElement
Throws:
DomainException - if element is not in domain

multiply

public void multiply(CElement element)

isInvertible

public boolean isInvertible()
Description copied from class: RingElement
Returns true if this ring element is invertible.

Specified by:
isInvertible in class RingElement

inverse

public CElement inverse()
Description copied from class: RingElement
Returns the inverse of this ring element, if it has an inverse.

Specified by:
inverse in class RingElement

invert

public void invert()
Description copied from class: RingElement
Inverts this ring element, if it has an inverse.

Specified by:
invert in class RingElement

quotient

public CElement quotient(RingElement element)
                  throws DomainException,
                         DivisionException
Description copied from class: RingElement
Returns the solution x of element*x = this, if it exists, otherwise a DivisionException is thrown.

Specified by:
quotient in class RingElement
Throws:
DomainException
DivisionException

quotient

public CElement quotient(CElement element)
                  throws DivisionException
Throws:
DivisionException

divide

public void divide(RingElement element)
            throws DomainException,
                   DivisionException
Description copied from class: RingElement
Replaces this by the solution x of element*x = this, if it exists, otherwise a DivisionException is thrown.

Specified by:
divide in class RingElement
Throws:
DomainException
DivisionException

divide

public void divide(CElement element)
            throws DivisionException
Throws:
DivisionException

divides

public boolean divides(RingElement element)
Description copied from class: RingElement
Return true iff the solution x of this*x = element exists.

Specified by:
divides in class RingElement

power

public CElement power(int n)
Description copied from class: RingElement
Raises this ring element to the power n.

Overrides:
power in class RingElement

getModule

public CRing getModule()
Description copied from interface: ModuleElement
Returns the module that this module element is an element of.

Specified by:
getModule in interface ModuleElement

getComponent

public CElement getComponent(int i)
Description copied from interface: FreeElement
Returns the i-th component of this free element.

Specified by:
getComponent in interface CFreeElement
Specified by:
getComponent in interface FreeElement
Specified by:
getComponent in interface ModuleElement
Overrides:
getComponent in class RingElement

getRingElement

public CElement getRingElement(int i)
Description copied from interface: FreeElement
Returns the i-th ring component of this free element.

Specified by:
getRingElement in interface CFreeElement
Specified by:
getRingElement in interface FreeElement
Overrides:
getRingElement in class RingElement

getValue

public Complex getValue()
Returns the complex value contained in this element.


resize

public CFreeElement resize(int n)
Description copied from interface: FreeElement
Returns this free element resized to length 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.

Specified by:
resize in interface CFreeElement
Specified by:
resize in interface FreeElement

equals

public boolean equals(java.lang.Object object)
Description copied from interface: ModuleElement
Returns true iff this element is equal to object.

Specified by:
equals in interface ModuleElement
Overrides:
equals in class java.lang.Object

compareTo

public int compareTo(ModuleElement object)
Description copied from interface: ModuleElement
Compares this module element with object.

Specified by:
compareTo in interface java.lang.Comparable<ModuleElement>
Specified by:
compareTo in interface ModuleElement
Overrides:
compareTo in class RingElement

clone

public CElement clone()
Description copied from interface: ModuleElement
Returns a deep copy of this module element.

Specified by:
clone in interface CFreeElement
Specified by:
clone in interface ModuleElement
Specified by:
clone in class RingElement

stringRep

public java.lang.String stringRep(boolean... parens)
Description copied from interface: ModuleElement
Returns a string representation of this module element. The representation is meant to be parseable. If the argument parens is present then the the representation is parenthesized if necessary.

Specified by:
stringRep in interface ModuleElement
Specified by:
stringRep in class RingElement

toString

public java.lang.String toString()
Description copied from interface: ModuleElement
Returns a human readable string representation of this module element. The representation is not meant to be parseable.

Specified by:
toString in interface ModuleElement
Overrides:
toString in class java.lang.Object

fold

public double[] fold(ModuleElement[] elements)
Description copied from interface: ModuleElement
Fold elements assuming they are of this same type.

Specified by:
fold in interface ModuleElement

cast

public ModuleElement cast(Module module)
Description copied from interface: ModuleElement
Tries to cast this element to an element in the given module.

Specified by:
cast in interface ModuleElement
Returns:
a new module element in the required module and null if the cast cannot be performed.

toXML

public void toXML(XMLWriter writer)
Description copied from interface: XMLInputOutput
Outputs XML representation to writer.

Specified by:
toXML in interface XMLInputOutput<ModuleElement>

fromXML

public ModuleElement fromXML(XMLReader reader,
                             org.w3c.dom.Element element)
Description copied from interface: XMLInputOutput
Reads XML representation from reader starting with element.

Specified by:
fromXML in interface XMLInputOutput<ModuleElement>
Returns:
an object of type T or null if parsing failed

getXMLInputOutput

public static XMLInputOutput<ModuleElement> getXMLInputOutput()

getElementTypeName

public java.lang.String getElementTypeName()
Description copied from interface: XMLInputOutput
Returns the value of the type attribute for this class.

Specified by:
getElementTypeName in interface XMLInputOutput<ModuleElement>

hashCode

public int hashCode()
Description copied from interface: ModuleElement
Returns the hash code for this module element.

Specified by:
hashCode in interface ModuleElement
Overrides:
hashCode in class java.lang.Object