org.rubato.math.module
Class ProductElement

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

public class ProductElement
extends RingElement
implements ProductFreeElement

Elements in a product ring.

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

Method Summary
 void add(ModuleElement element)
          Adds element to this module element.
 void add(ProductElement element)
          Adds element to this element.
 ModuleElement cast(Module module)
          Tries to cast this element to an element in the given module.
 ProductElement clone()
          Returns a deep copy of this module element.
 int compareTo(ModuleElement object)
          Compares this module element with object.
 ProductElement difference(ModuleElement element)
          Returns the difference of this module element and element.
 ProductElement difference(ProductElement element)
          Returns the difference of this element and element.
 void divide(ProductElement 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.
 java.lang.String getElementTypeName()
          Returns the value of the type attribute for this class.
 RingElement getFactor(int i)
          Returns the factor at position i of this product element.
 int getFactorCount()
          Returns the number of factors of this product element.
 ProductRing getModule()
          Returns the module that this module element is an element of.
 ProductRing getRing()
          Returns the ring this element is a member of.
 RingElement getValue(int i)
          Returns the factor at position i of this product element.
static XMLInputOutput<ModuleElement> getXMLInputOutput()
           
 int hashCode()
          Returns the hash code for this module element.
 ProductElement 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.
static ProductElement make(java.util.List<RingElement> factors)
          Creates a new product element from the collection factors.
static ProductElement make(RingElement[] factors)
          Creates a new product element from the array factors.
static ProductElement make(RingElement e1, RingElement e2)
          Creates a new product element e1xe1.
static ProductElement make(RingElement e1, RingElement e2, RingElement e3)
          Creates a new product element e1xe1xe3.
 void multiply(ProductElement element)
          Multiplies this element with element.
 void multiply(RingElement element)
          Multiplies this ring element with element.
 void negate()
          Negate this module element.
 ProductElement negated()
          Returns the negative of this module element.
 ProductElement power(int n)
          Raises this ring element to the power n.
 ProductElement product(ProductElement element)
          Returns the product of this element and element.
 ProductElement product(RingElement element)
          Returns the product of this ring element with element.
 ProductElement quotient(ProductElement element)
           
 ProductElement quotient(RingElement element)
          Returns the solution x of element*x = this, if it exists, otherwise a DivisionException is thrown.
 ProductFreeElement resize(int n)
          Returns this free element resized to length n.
 void scale(RingElement element)
          Multiplies this element with element.
 ProductElement 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(ModuleElement element)
          Subtracts element from this module element.
 void subtract(ProductElement element)
          Subtracts element from this element.
 ProductElement sum(ModuleElement element)
          Returns the sum of this module element and element.
 ProductElement sum(ProductElement element)
          Returns the sum of this 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, getComponent, getLength, getRingElement, 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
getComponent, getLength, getRingElement, iterator, multiplyCW, productCW
 

Method Detail

make

public static ProductElement make(RingElement e1,
                                  RingElement e2)
Creates a new product element e1xe1.


make

public static ProductElement make(RingElement e1,
                                  RingElement e2,
                                  RingElement e3)
Creates a new product element e1xe1xe3.


make

public static ProductElement make(RingElement[] factors)
Creates a new product element from the array factors.


make

public static ProductElement make(java.util.List<RingElement> factors)
Creates a new product element from the collection factors.


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 ProductElement sum(ModuleElement element)
                   throws DomainException
Description copied from interface: ModuleElement
Returns the sum of this module element and element.

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

sum

public ProductElement sum(ProductElement element)
                   throws DomainException
Returns the sum of this element and element.

Throws:
DomainException

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(ProductElement element)
         throws DomainException
Adds element to this element.

Throws:
DomainException

difference

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

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

difference

public ProductElement difference(ProductElement element)
                          throws DomainException
Returns the difference of this element and element.

Throws:
DomainException

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(ProductElement element)
              throws DomainException
Subtracts element from this element.

Throws:
DomainException

negated

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

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

scaled

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

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 ProductElement 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 ProductElement product(ProductElement element)
                       throws DomainException
Returns the product of this element and element.

Throws:
DomainException

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(ProductElement element)
              throws DomainException
Multiplies this element with element.

Throws:
DomainException

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 ProductElement 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 ProductElement 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 ProductElement quotient(ProductElement element)
                        throws DomainException,
                               DivisionException
Throws:
DomainException
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(ProductElement element)
            throws DomainException,
                   DivisionException
Throws:
DomainException
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 ProductElement power(int n)
Description copied from class: RingElement
Raises this ring element to the power n.

Overrides:
power in class RingElement

getModule

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

Specified by:
getModule in interface ModuleElement

getRing

public ProductRing getRing()
Description copied from class: RingElement
Returns the ring this element is a member of.

Specified by:
getRing in interface ProductFreeElement
Overrides:
getRing in class RingElement

getFactorCount

public int getFactorCount()
Returns the number of factors of this product element.

Specified by:
getFactorCount in interface ProductFreeElement

getFactor

public RingElement getFactor(int i)
Returns the factor at position i of this product element.


getValue

public RingElement getValue(int i)
Returns the factor at position i of this product element.


resize

public ProductFreeElement 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 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 ProductElement clone()
Description copied from interface: ModuleElement
Returns a deep copy of this module element.

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