|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ModuleElement
The interface for elements in a module.
Module
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. |
ModuleElement |
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 |
getComponent(int i)
Returns the i -th component element. |
int |
getLength()
Returns the length of the element. |
Module |
getModule()
Returns the module that this module element is an element of. |
int |
hashCode()
Returns the hash code for this module element. |
boolean |
isZero()
Returns true iff this element is zero. |
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. |
Methods inherited from interface org.rubato.xml.XMLInputOutput |
---|
fromXML, getElementTypeName, toXML |
Method Detail |
---|
boolean isZero()
ModuleElement scaled(RingElement element) throws DomainException
element
.
DomainException
- if element
is not in domainvoid scale(RingElement element) throws DomainException
element
.
This is a destructive operation.
DomainException
- if element
is not in domainint getLength()
ModuleElement getComponent(int i)
i
-th component element.
ModuleElement sum(ModuleElement element) throws DomainException
element
.
DomainException
- if element
is not in domainvoid add(ModuleElement element) throws DomainException
element
to this module element.
This is a destructive operation.
DomainException
- if element
is not in domainModuleElement difference(ModuleElement element) throws DomainException
element
.
DomainException
- if element
is not in domainvoid subtract(ModuleElement element) throws DomainException
element
from this module element.
This is a destructive operation.
DomainException
- if element
is not in domainModuleElement negated()
void negate()
double[] fold(ModuleElement[] elements)
elements
assuming they are of this same type.
Module getModule()
ModuleElement cast(Module module)
java.lang.String stringRep(boolean... parens)
java.lang.String toString()
toString
in class java.lang.Object
boolean equals(java.lang.Object object)
object
.
equals
in class java.lang.Object
int compareTo(ModuleElement object)
object
.
compareTo
in interface java.lang.Comparable<ModuleElement>
ModuleElement clone()
int hashCode()
hashCode
in class java.lang.Object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |