|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.rubato.math.module.RestrictedElement
public class RestrictedElement
Elements in a restricted module. Instances are created using
the static make(RestrictedModule,ModuleElement)
method.
Method Summary | |
---|---|
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. |
RestrictedElement |
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 . |
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 . |
ModuleElement |
getComponent(int i)
Returns the i -th component element. |
java.lang.String |
getElementTypeName()
Returns the value of the type attribute for this class. |
int |
getLength()
Returns the length of the element. |
Module |
getModule()
Returns the module that this module element is an element of. |
ModuleElement |
getUnrestrictedElement()
|
static XMLInputOutput<ModuleElement> |
getXMLInputOutput()
|
static RestrictedElement |
getZero(RestrictedModule module)
|
boolean |
isZero()
Returns true iff this element is zero. |
static RestrictedElement |
make(RestrictedModule module,
ModuleElement element)
|
void |
negate()
Negate this module element. |
ModuleElement |
negated()
Returns the negative of this module element. |
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. |
ModuleElement |
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 java.lang.Object |
---|
getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface org.rubato.math.module.ModuleElement |
---|
hashCode |
Method Detail |
---|
public static RestrictedElement make(RestrictedModule module, ModuleElement element) throws DomainException
DomainException
public static RestrictedElement getZero(RestrictedModule module)
public boolean isZero()
ModuleElement
isZero
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 int getLength()
ModuleElement
getLength
in interface ModuleElement
public ModuleElement getComponent(int i)
ModuleElement
i
-th component element.
getComponent
in interface ModuleElement
public ModuleElement sum(ModuleElement element) throws DomainException
ModuleElement
element
.
sum
in interface ModuleElement
DomainException
- if element
is not in domainpublic 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 ModuleElement difference(ModuleElement element) throws DomainException
ModuleElement
element
.
difference
in interface ModuleElement
DomainException
- if element
is not in domainpublic 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 ModuleElement negated()
ModuleElement
negated
in interface ModuleElement
public void negate()
ModuleElement
negate
in interface ModuleElement
public double[] fold(ModuleElement[] elements)
ModuleElement
elements
assuming they are of this same type.
fold
in interface ModuleElement
public Module getModule()
ModuleElement
getModule
in interface ModuleElement
public ModuleElement getUnrestrictedElement()
public ModuleElement cast(Module module)
ModuleElement
cast
in interface ModuleElement
public java.lang.String stringRep(boolean... parens)
ModuleElement
stringRep
in interface ModuleElement
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
public RestrictedElement clone()
ModuleElement
clone
in interface ModuleElement
clone
in class java.lang.Object
public java.lang.String toString()
ModuleElement
toString
in interface ModuleElement
toString
in class java.lang.Object
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>
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |