org.rubato.math.module
Class ZnStringElement

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

public final class ZnStringElement
extends StringElement
implements ZnStringFreeElement

Elements of the ring of strings with integer mod n factors.

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

Constructor Summary
ZnStringElement(int modulus, java.lang.Object... objs)
          Constructs a ZnStringElement from the array of objects objs.
ZnStringElement(java.lang.String string, int modulus)
          Constructs a ZnStringElement from a string mod modulus.
ZnStringElement(ZnString value)
          Constructs a ZnStringElement from a ZnString value.
 
Method Summary
 void add(ModuleElement element)
          Adds element to this module element.
 void add(ZnStringElement element)
           
 ModuleElement cast(Module module)
          Tries to cast this element to an element in the given module.
 ZnStringElement clone()
          Returns a deep copy of this module element.
 int compareTo(ModuleElement object)
          Compares this module element with object.
 ModuleElement difference(ModuleElement element)
          Returns the difference of this module element and element.
 ZnStringElement difference(ZnStringElement 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.
 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.
 Module getModule()
          Returns the module that this module element is an element of.
 int getModulus()
           
 RingString getRingString()
          Returns the underlying RingString.
 java.util.HashMap<java.lang.String,RingElement> getTerms()
          Returns the terms of the string as a map from strings to factors.
 ZnString getValue()
           
static XMLInputOutput<ModuleElement> getXMLInputOutput()
           
 int hashCode()
          Returns the hash code for this module element.
 RingElement 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 isOne()
          Returns true if this ring element is one.
 boolean isZero()
          Returns true iff this element is zero.
 void multiply(RingElement element)
          Multiplies this ring element with element.
 void multiply(ZnStringElement element)
           
 void negate()
          Negate this module element.
 ModuleElement negated()
          Returns the negative of this module element.
 RingElement product(RingElement element)
          Returns the product of this ring element with element.
 ZnStringElement product(ZnStringElement element)
           
 RingElement quotient(RingElement element)
          Returns the solution x of element*x = this, if it exists, otherwise a DivisionException is thrown.
 FreeElement resize(int n)
          Returns this free element resized to length n.
 void scale(RingElement element)
          Multiplies this element with element.
 ModuleElement 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(ZnStringElement element)
           
 ModuleElement sum(ModuleElement element)
          Returns the sum of this module element and element.
 ZnStringElement sum(ZnStringElement 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.StringElement
fold, getString, isInvertible
 
Methods inherited from class org.rubato.math.module.RingElement
difference, getComponent, getLength, getRing, getRingElement, iterator, multiplyCW, power, 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
 
Methods inherited from interface org.rubato.math.module.ModuleElement
fold
 

Constructor Detail

ZnStringElement

public ZnStringElement(java.lang.String string,
                       int modulus)
Constructs a ZnStringElement from a string mod modulus. The result is a ZnStringElement of the form 1*value.


ZnStringElement

public ZnStringElement(ZnString value)
Constructs a ZnStringElement from a ZnString value.


ZnStringElement

public ZnStringElement(int modulus,
                       java.lang.Object... objs)
Constructs a ZnStringElement from the array of objects objs.

Parameters:
objs - an array of objects where strings alternate with integers, the array should therefore be of even length
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 ModuleElement 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 ZnStringElement sum(ZnStringElement 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(ZnStringElement element)

difference

public ModuleElement 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 ZnStringElement difference(ZnStringElement 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(ZnStringElement element)

negated

public ModuleElement 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 ModuleElement 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 RingElement 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 ZnStringElement product(ZnStringElement 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(ZnStringElement element)

inverse

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

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

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

getModule

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

Specified by:
getModule in interface ModuleElement

getValue

public ZnString getValue()

getRingString

public RingString getRingString()
Description copied from class: StringElement
Returns the underlying RingString.

Specified by:
getRingString in class StringElement

resize

public FreeElement 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 ZnStringElement 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

getModulus

public int getModulus()
Specified by:
getModulus in interface ZnStringFreeElement

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

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

getTerms

public java.util.HashMap<java.lang.String,RingElement> getTerms()
Description copied from class: StringElement
Returns the terms of the string as a map from strings to factors.

Specified by:
getTerms in class StringElement

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 StringElement