|
|||||||||
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.CProperFreeElement
public final class CProperFreeElement
Elements in the free modules of complex numbers.
CProperFreeModule
,
Serialized FormMethod Summary | |
---|---|
void |
add(CProperFreeElement element)
Adds element to this. |
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. |
CProperFreeElement |
clone()
Returns a deep copy of this module element. |
int |
compareTo(ModuleElement object)
Compares this module element with object . |
void |
conjugate()
Conjugates this element. |
CProperFreeElement |
conjugated()
Returns the conjugate of this element. |
CProperFreeElement |
difference(CProperFreeElement element)
|
CProperFreeElement |
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 . |
CElement |
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 |
getLength()
Returns the length of this free element. |
CProperFreeModule |
getModule()
Returns the module that this module element is an element of. |
CElement |
getRingElement(int i)
Returns the i -th ring component of this free element. |
Complex[] |
getValue()
Returns the array of Complex contained in this element. |
Complex |
getValue(int i)
Returns the Complex at index i . |
static XMLInputOutput<ModuleElement> |
getXMLInputOutput()
|
int |
hashCode()
Returns the hash code for this module element. |
boolean |
isZero()
Returns true iff this element is zero. |
static CFreeElement |
make(Complex[] v)
Creates a CFreeElement from an array of Complex. |
void |
multiplyCW(CProperFreeElement element)
|
void |
multiplyCW(ModuleElement element)
Multiply this module element componentwise with element . |
void |
negate()
Negate this module element. |
CProperFreeElement |
negated()
Returns the negative of this module element. |
CProperFreeElement |
productCW(CProperFreeElement element)
|
CProperFreeElement |
productCW(ModuleElement element)
Returns the componentwise product of this module element and element . |
CFreeElement |
resize(int n)
Returns this free element resized to length n . |
void |
scale(CElement element)
|
void |
scale(RingElement element)
Multiplies this element with element . |
CProperFreeElement |
scaled(CElement element)
|
CProperFreeElement |
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(CProperFreeElement element)
Subtracts element from this. |
void |
subtract(ModuleElement element)
Subtracts element from this module element. |
CProperFreeElement |
sum(CProperFreeElement element)
Returns the sum of this and element . |
CProperFreeElement |
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 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 CFreeElement make(Complex[] v)
public boolean isZero()
ModuleElement
isZero
in interface ModuleElement
public CProperFreeElement conjugated()
CFreeElement
conjugated
in interface CFreeElement
public void conjugate()
CFreeElement
conjugate
in interface CFreeElement
public CProperFreeElement sum(ModuleElement element) throws DomainException
ModuleElement
element
.
sum
in interface CFreeElement
sum
in interface ModuleElement
DomainException
- if element
is not in domainpublic CProperFreeElement sum(CProperFreeElement element) throws DomainException
element
.
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 void add(CProperFreeElement element) throws DomainException
element
to this.
This is a destructive operation.
DomainException
- if element
is not in domainpublic CProperFreeElement difference(ModuleElement element) throws DomainException
ModuleElement
element
.
difference
in interface CFreeElement
difference
in interface ModuleElement
DomainException
- if element
is not in domainpublic CProperFreeElement difference(CProperFreeElement element) throws DomainException
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(CProperFreeElement element) throws DomainException
element
from this.
This is a destructive operation.
DomainException
- if element
is not in domainpublic CProperFreeElement productCW(ModuleElement element) throws DomainException
FreeElement
element
.
productCW
in interface FreeElement
DomainException
- if element
is not in domainpublic CProperFreeElement productCW(CProperFreeElement 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(CProperFreeElement element) throws DomainException
DomainException
public CProperFreeElement negated()
ModuleElement
negated
in interface CFreeElement
negated
in interface ModuleElement
public void negate()
ModuleElement
negate
in interface ModuleElement
public CProperFreeElement scaled(RingElement element) throws DomainException
ModuleElement
element
.
scaled
in interface CFreeElement
scaled
in interface ModuleElement
DomainException
- if element
is not in domainpublic CProperFreeElement scaled(CElement element)
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(CElement element)
public CElement getComponent(int i)
FreeElement
i
-th component of this free element.
getComponent
in interface CFreeElement
getComponent
in interface FreeElement
getComponent
in interface ModuleElement
public CElement getRingElement(int i)
FreeElement
i
-th ring component of this free element.
getRingElement
in interface CFreeElement
getRingElement
in interface FreeElement
public int getLength()
FreeElement
getLength
in interface FreeElement
getLength
in interface ModuleElement
public CProperFreeModule getModule()
ModuleElement
getModule
in interface ModuleElement
public Complex[] getValue()
public Complex getValue(int i)
i
.
public CFreeElement 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 CFreeElement
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 CProperFreeElement clone()
ModuleElement
clone
in interface CFreeElement
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 |