|
|||||||||
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.ProductElement
public class ProductElement
Elements in a product ring.
ProductRing
,
Serialized FormMethod Summary | |
---|---|
void |
add(ModuleElement element)
Adds element to this module element. |
void |
add(ProductElement element)
Adds element to this element. |
ModuleElement |
cast(Module module)
Tries to cast this element to an element in the given module. |
ProductElement |
clone()
Returns a deep copy of this module element. |
int |
compareTo(ModuleElement object)
Compares this module element with object . |
ProductElement |
difference(ModuleElement element)
Returns the difference of this module element and element . |
ProductElement |
difference(ProductElement element)
Returns the difference of this element and element . |
void |
divide(ProductElement 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 . |
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 . |
java.lang.String |
getElementTypeName()
Returns the value of the type attribute for this class. |
RingElement |
getFactor(int i)
Returns the factor at position i of this product element. |
int |
getFactorCount()
Returns the number of factors of this product element. |
ProductRing |
getModule()
Returns the module that this module element is an element of. |
ProductRing |
getRing()
Returns the ring this element is a member of. |
RingElement |
getValue(int i)
Returns the factor at position i of this product element. |
static XMLInputOutput<ModuleElement> |
getXMLInputOutput()
|
int |
hashCode()
Returns the hash code for this module element. |
ProductElement |
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 |
isInvertible()
Returns true if this ring element is invertible. |
boolean |
isOne()
Returns true if this ring element is one. |
boolean |
isZero()
Returns true iff this element is zero. |
static ProductElement |
make(java.util.List<RingElement> factors)
Creates a new product element from the collection factors . |
static ProductElement |
make(RingElement[] factors)
Creates a new product element from the array factors . |
static ProductElement |
make(RingElement e1,
RingElement e2)
Creates a new product element e1xe1. |
static ProductElement |
make(RingElement e1,
RingElement e2,
RingElement e3)
Creates a new product element e1xe1xe3. |
void |
multiply(ProductElement element)
Multiplies this element with element . |
void |
multiply(RingElement element)
Multiplies this ring element with element . |
void |
negate()
Negate this module element. |
ProductElement |
negated()
Returns the negative of this module element. |
ProductElement |
power(int n)
Raises this ring element to the power n . |
ProductElement |
product(ProductElement element)
Returns the product of this element and element . |
ProductElement |
product(RingElement element)
Returns the product of this ring element with element . |
ProductElement |
quotient(ProductElement element)
|
ProductElement |
quotient(RingElement element)
Returns the solution x of element *x = this ,
if it exists, otherwise a DivisionException is thrown. |
ProductFreeElement |
resize(int n)
Returns this free element resized to length n . |
void |
scale(RingElement element)
Multiplies this element with element . |
ProductElement |
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(ProductElement element)
Subtracts element from this element. |
ProductElement |
sum(ModuleElement element)
Returns the sum of this module element and element . |
ProductElement |
sum(ProductElement element)
Returns the sum of this 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 org.rubato.math.module.RingElement |
---|
difference, getComponent, getLength, getRingElement, iterator, multiplyCW, 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 |
Method Detail |
---|
public static ProductElement make(RingElement e1, RingElement e2)
public static ProductElement make(RingElement e1, RingElement e2, RingElement e3)
public static ProductElement make(RingElement[] factors)
factors
.
public static ProductElement make(java.util.List<RingElement> factors)
factors
.
public boolean isOne()
RingElement
isOne
in class RingElement
public boolean isZero()
ModuleElement
isZero
in interface ModuleElement
public ProductElement sum(ModuleElement element) throws DomainException
ModuleElement
element
.
sum
in interface ModuleElement
DomainException
- if element
is not in domainpublic ProductElement sum(ProductElement 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(ProductElement element) throws DomainException
element
to this element.
DomainException
public ProductElement difference(ModuleElement element) throws DomainException
ModuleElement
element
.
difference
in interface ModuleElement
DomainException
- if element
is not in domainpublic ProductElement difference(ProductElement 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(ProductElement element) throws DomainException
element
from this element.
DomainException
public ProductElement negated()
ModuleElement
negated
in interface ModuleElement
public void negate()
ModuleElement
negate
in interface ModuleElement
public ProductElement 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 ProductElement product(RingElement element) throws DomainException
RingElement
element
.
product
in class RingElement
DomainException
- if element
is not in domainpublic ProductElement product(ProductElement element) throws DomainException
element
.
DomainException
public void multiply(RingElement element) throws DomainException
RingElement
element
.
multiply
in class RingElement
DomainException
- if element
is not in domainpublic void multiply(ProductElement element) throws DomainException
element
.
DomainException
public boolean isInvertible()
RingElement
isInvertible
in class RingElement
public ProductElement inverse()
RingElement
inverse
in class RingElement
public void invert()
RingElement
invert
in class RingElement
public ProductElement 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 ProductElement quotient(ProductElement element) throws DomainException, DivisionException
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 void divide(ProductElement element) throws DomainException, DivisionException
DomainException
DivisionException
public boolean divides(RingElement element)
RingElement
this
*x = element
exists.
divides
in class RingElement
public ProductElement power(int n)
RingElement
n
.
power
in class RingElement
public ProductRing getModule()
ModuleElement
getModule
in interface ModuleElement
public ProductRing getRing()
RingElement
getRing
in interface ProductFreeElement
getRing
in class RingElement
public int getFactorCount()
getFactorCount
in interface ProductFreeElement
public RingElement getFactor(int i)
i
of this product element.
public RingElement getValue(int i)
i
of this product element.
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 RingElement
public ProductElement clone()
ModuleElement
clone
in interface ModuleElement
clone
in class RingElement
public java.lang.String stringRep(boolean... parens)
ModuleElement
stringRep
in interface ModuleElement
stringRep
in class RingElement
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 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 java.lang.Object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |