|
|||||||||
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.StringElement
org.rubato.math.module.ZStringElement
public final class ZStringElement
Elements of the ring of strings with integer factors.
ZStringRing
,
Serialized FormConstructor Summary | |
---|---|
ZStringElement(java.lang.Object... objs)
Constructs a ZStringElement from the array of objects objs . |
|
ZStringElement(java.lang.String string)
Constructs a ZStringElement from an ordinary String string . |
|
ZStringElement(ZString value)
Constructs a ZStringElement from a ZString value . |
Method Summary | |
---|---|
void |
add(ModuleElement element)
Adds element to this module element. |
void |
add(ZStringElement element)
|
ModuleElement |
cast(Module module)
Tries to cast this element to an element in the given module. |
ZStringElement |
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 . |
ZStringElement |
difference(ZStringElement 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. |
RingString |
getRingString()
Returns the underlying RingString . |
java.lang.String |
getString()
Convenience method for getting the string in a StringElement . |
java.util.HashMap<java.lang.String,RingElement> |
getTerms()
Returns the terms of the string as a map from strings to factors. |
ZString |
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(ZStringElement 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 . |
ZStringElement |
product(ZStringElement 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(ZStringElement element)
|
ModuleElement |
sum(ModuleElement element)
Returns the sum of this module element and element . |
ZStringElement |
sum(ZStringElement 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, 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 |
---|
public ZStringElement(java.lang.String string)
string
.
The result is a ZStringElement of the form 1*value.
public ZStringElement(ZString value)
value
.
public ZStringElement(java.lang.Object... objs)
objs
.
objs
- an array of objects where strings alternate with
integers, the array should therefore be of even
lengthMethod Detail |
---|
public boolean isOne()
RingElement
isOne
in class RingElement
public boolean isZero()
ModuleElement
isZero
in interface ModuleElement
public ModuleElement sum(ModuleElement element) throws DomainException
ModuleElement
element
.
sum
in interface ModuleElement
DomainException
- if element
is not in domainpublic ZStringElement sum(ZStringElement 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(ZStringElement element)
public ModuleElement difference(ModuleElement element) throws DomainException
ModuleElement
element
.
difference
in interface ModuleElement
DomainException
- if element
is not in domainpublic ZStringElement difference(ZStringElement 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(ZStringElement element)
public ModuleElement negated()
ModuleElement
negated
in interface ModuleElement
public void negate()
ModuleElement
negate
in interface ModuleElement
public ModuleElement scaled(RingElement element) throws DomainException
ModuleElement
element
.
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 RingElement product(RingElement element) throws DomainException
RingElement
element
.
product
in class RingElement
DomainException
- if element
is not in domainpublic ZStringElement product(ZStringElement element)
public void multiply(RingElement element) throws DomainException
RingElement
element
.
multiply
in class RingElement
DomainException
- if element
is not in domainpublic void multiply(ZStringElement element)
public RingElement inverse()
RingElement
inverse
in class RingElement
public void invert()
RingElement
invert
in class RingElement
public RingElement 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 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 boolean divides(RingElement element)
RingElement
this
*x = element
exists.
divides
in class RingElement
public Module getModule()
ModuleElement
getModule
in interface ModuleElement
public ZString getValue()
public RingString getRingString()
StringElement
RingString
.
getRingString
in class StringElement
public FreeElement 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 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 ZStringElement clone()
ModuleElement
clone
in interface ModuleElement
clone
in class RingElement
public java.lang.String toString()
ModuleElement
toString
in interface ModuleElement
toString
in class java.lang.Object
public java.lang.String stringRep(boolean... parens)
ModuleElement
stringRep
in interface ModuleElement
stringRep
in class RingElement
public java.lang.String getString()
StringElement
StringElement
.
Only useful if the RingString
has only one term.
getString
in class StringElement
public java.util.HashMap<java.lang.String,RingElement> getTerms()
StringElement
getTerms
in class StringElement
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 StringElement
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |