|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.rubato.math.module.ProperFreeElement
org.rubato.math.module.ProductProperFreeElement
public final class ProductProperFreeElement
Elements in the free module over a product ring.
ProductProperFreeModule
,
Serialized FormMethod Summary | |
---|---|
void |
add(ModuleElement element)
Adds element to this module element. |
void |
add(ProductProperFreeElement element)
Adds element to this this element. |
ModuleElement |
cast(Module module)
Tries to cast this element to an element in the given module. |
ProductProperFreeElement |
clone()
Returns a deep copy of this module element. |
int |
compareTo(ModuleElement object)
Compares this module element with object . |
ProductProperFreeElement |
difference(ModuleElement element)
Returns the difference of this module element and element . |
ProductProperFreeElement |
difference(ProductProperFreeElement element)
Returns the difference of this 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 . |
ProductElement |
getComponent(int i)
Returns the i -th component of this free element. |
java.lang.String |
getElementTypeName()
Returns the value of the type attribute for this class. |
int |
getFactorCount()
Returns the number of factors of the underlying product ring. |
int |
getLength()
Returns the length of this free element. |
ProductFreeModule |
getModule()
Returns the module that this module element is an element of. |
ProductRing |
getRing()
Returns the underlying product ring. |
ProductElement |
getRingElement(int i)
Returns the i -th ring component of this free element. |
ProductElement[] |
getValue()
Returns the product element components as an array. |
ProductElement |
getValue(int i)
Returns the i -th product element component. |
static XMLInputOutput<ModuleElement> |
getXMLInputOutput()
|
int |
hashCode()
Returns the hash code for this module element. |
boolean |
isZero()
Returns true iff this element is zero. |
static ProductFreeElement |
make(ProductElement[] v)
Creates a new product free element over the specified ring with given components. |
static ProductFreeElement |
make(ProductRing ring,
ProductElement[] v)
Creates a new product free element over the specified ring with given components. |
void |
multiplyCW(ModuleElement element)
Multiply this module element componentwise with element . |
void |
multiplyCW(ProductProperFreeElement element)
|
void |
negate()
Negate this module element. |
ProductFreeElement |
negated()
Returns the negative of this module element. |
ProductProperFreeElement |
productCW(ModuleElement element)
Returns the componentwise product of this module element and element . |
ProductProperFreeElement |
productCW(ProductProperFreeElement element)
|
ProductFreeElement |
resize(int n)
Returns this free element resized to length n . |
void |
scale(ProductElement element)
Scales this element by element. |
void |
scale(RingElement element)
Multiplies this element with element . |
ProductProperFreeElement |
scaled(ProductElement element)
Returns this element scaled by element . |
ProductProperFreeElement |
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(ProductProperFreeElement element)
Subtracts element from this element. |
ProductProperFreeElement |
sum(ModuleElement element)
Returns the sum of this module element and element . |
ProductProperFreeElement |
sum(ProductProperFreeElement element)
Returns the sum of this element with 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.ProperFreeElement |
---|
iterator |
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, wait, wait, wait |
Methods inherited from interface org.rubato.math.module.FreeElement |
---|
iterator |
Method Detail |
---|
public static ProductFreeElement make(ProductRing ring, ProductElement[] v)
public static ProductFreeElement make(ProductElement[] v)
v
must be of length > 0.
public boolean isZero()
ModuleElement
isZero
in interface ModuleElement
public ProductProperFreeElement sum(ModuleElement element) throws DomainException
ModuleElement
element
.
sum
in interface ModuleElement
DomainException
- if element
is not in domainpublic ProductProperFreeElement sum(ProductProperFreeElement element) throws DomainException
element
.
DomainException
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(ProductProperFreeElement element) throws DomainException
element
to this this element.
DomainException
public ProductProperFreeElement difference(ModuleElement element) throws DomainException
ModuleElement
element
.
difference
in interface ModuleElement
DomainException
- if element
is not in domainpublic ProductProperFreeElement difference(ProductProperFreeElement element) throws DomainException
element
.
DomainException
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(ProductProperFreeElement element) throws DomainException
element
from this element.
DomainException
public ProductProperFreeElement productCW(ModuleElement element) throws DomainException
FreeElement
element
.
productCW
in interface FreeElement
DomainException
- if element
is not in domainpublic ProductProperFreeElement productCW(ProductProperFreeElement element) throws DomainException
DomainException
public void multiplyCW(ModuleElement element) throws DomainException
FreeElement
element
.
This is a destructive operation.
multiplyCW
in interface FreeElement
DomainException
- if element
is not in domainpublic void multiplyCW(ProductProperFreeElement element) throws DomainException
DomainException
public ProductFreeElement negated()
ModuleElement
negated
in interface ModuleElement
public void negate()
ModuleElement
negate
in interface ModuleElement
public ProductProperFreeElement scaled(RingElement element) throws DomainException
ModuleElement
element
.
scaled
in interface ModuleElement
DomainException
- if element
is not in domainpublic ProductProperFreeElement scaled(ProductElement element) throws DomainException
element
.
DomainException
public void scale(RingElement element) throws DomainException
ModuleElement
element
.
This is a destructive operation.
scale
in interface ModuleElement
DomainException
- if element
is not in domainpublic void scale(ProductElement element) throws DomainException
DomainException
public int getFactorCount()
getFactorCount
in interface ProductFreeElement
public ProductElement getComponent(int i)
FreeElement
i
-th component of this free element.
getComponent
in interface FreeElement
getComponent
in interface ModuleElement
public ProductElement getRingElement(int i)
FreeElement
i
-th ring component of this free element.
getRingElement
in interface FreeElement
public int getLength()
FreeElement
getLength
in interface FreeElement
getLength
in interface ModuleElement
public ProductFreeModule getModule()
ModuleElement
getModule
in interface ModuleElement
public ProductRing getRing()
ProductFreeElement
getRing
in interface ProductFreeElement
public ProductElement[] getValue()
public ProductElement getValue(int i)
i
-th product element component.
public ProductFreeElement 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 ProperFreeElement
public ModuleElement cast(Module module)
ModuleElement
cast
in interface ModuleElement
public ProductProperFreeElement clone()
ModuleElement
clone
in interface ModuleElement
clone
in class ProperFreeElement
public java.lang.String stringRep(boolean... parens)
ModuleElement
stringRep
in interface ModuleElement
public java.lang.String toString()
ModuleElement
toString
in interface ModuleElement
toString
in class java.lang.Object
public double[] fold(ModuleElement[] elements)
ModuleElement
elements
assuming they are of this same type.
fold
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 java.lang.Object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |