|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.rubato.math.module.RestrictedModule
public class RestrictedModule
Modules with restricted ring of scalars. Instances are created using
the static make(ModuleMorphism,Module)
method.
Method Summary | |
---|---|
ModuleElement |
cast(ModuleElement element)
Casts element to an element in this module if possible. |
int |
compareTo(Module object)
Compares this module with object . |
ModuleElement |
createElement(java.util.List<ModuleElement> elements)
Creates an element in this module from a list of module elements. |
boolean |
equals(java.lang.Object object)
Returns true iff this module is equals to object . |
Module |
fromXML(XMLReader reader,
org.w3c.dom.Element element)
Reads XML representation from reader starting with element . |
Module |
getComponentModule(int i)
Returns the i -th component module. |
int |
getDimension()
Returns the dimension of this module. |
java.lang.String |
getElementTypeName()
Returns the value of the type attribute for this class. |
ModuleMorphism |
getIdentityMorphism()
Returns the identity morphism in this module. |
Module |
getNullModule()
Returns the null-module corresponding to this module. |
ModuleMorphism |
getRestrictingMorphism()
Returns the morphism responsible for the restriction. |
Ring |
getRing()
Returns the underlying ring of this module. |
ModuleMorphism |
getTranslation(ModuleElement element)
Returns a morphism that translates by element . |
Module |
getUnrestrictedModule()
Returns the unrestricted module at the origin of this restricted module. |
static XMLInputOutput<Module> |
getXMLInputOutput()
|
ModuleElement |
getZero()
Returns the zero element in this module. |
boolean |
hasElement(ModuleElement element)
Returns true iff element is an element of this module. |
boolean |
isNullModule()
Returns true iff this is a null-module. |
boolean |
isRing()
Returns true iff this module is a ring. |
static RestrictedModule |
make(ModuleMorphism morphism,
Module module)
Creates a new scalar-restricted module based on module
where the restriction is effectuated through morphism . |
static RestrictedModule |
make(Ring ring,
Module module)
Creates a new scalar-restricted module based on module
where the restriction is effectuated through embedding the given
ring in the base ring of module . |
ModuleElement |
parseString(java.lang.String string)
Creates an element in this module from a string representation. |
java.lang.String |
toString()
Returns a human readable string representation of this module. |
java.lang.String |
toVisualString()
Returns a human readable string representation of this module. |
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.Module |
---|
hashCode |
Method Detail |
---|
public static RestrictedModule make(ModuleMorphism morphism, Module module) throws DomainException
module
where the restriction is effectuated through morphism
.
The codomain of morphism
must be equal to the base ring
of module
.
DomainException
- if morphism
does not have
the correct codomainpublic static RestrictedModule make(Ring ring, Module module) throws DomainException
module
where the restriction is effectuated through embedding the given
ring
in the base ring of module
.
DomainException
- if the embedding is not possiblepublic ModuleElement getZero()
Module
getZero
in interface Module
public ModuleMorphism getIdentityMorphism()
Module
getIdentityMorphism
in interface Module
public int getDimension()
Module
getDimension
in interface Module
public Module getNullModule()
Module
getNullModule
in interface Module
public boolean isNullModule()
Module
isNullModule
in interface Module
public boolean isRing()
Module
isRing
in interface Module
public Ring getRing()
Module
getRing
in interface Module
public Module getComponentModule(int i)
Module
i
-th component module.
getComponentModule
in interface Module
public Module getUnrestrictedModule()
public ModuleMorphism getRestrictingMorphism()
public boolean hasElement(ModuleElement element)
Module
element
is an element of this module.
hasElement
in interface Module
public ModuleMorphism getTranslation(ModuleElement element)
Module
element
.
getTranslation
in interface Module
public ModuleElement cast(ModuleElement element)
Module
element
to an element in this module if possible.
cast
in interface Module
public ModuleElement createElement(java.util.List<ModuleElement> elements)
Module
createElement
in interface Module
public ModuleElement parseString(java.lang.String string)
Module
parseString
in interface Module
public boolean equals(java.lang.Object object)
Module
object
.
equals
in interface Module
equals
in class java.lang.Object
public int compareTo(Module object)
Module
object
.
compareTo
in interface java.lang.Comparable<Module>
compareTo
in interface Module
public java.lang.String toString()
Module
toString
in interface Module
toString
in class java.lang.Object
public java.lang.String toVisualString()
Module
toVisualString
in interface Module
public void toXML(XMLWriter writer)
XMLInputOutput
writer
.
toXML
in interface XMLInputOutput<Module>
public Module fromXML(XMLReader reader, org.w3c.dom.Element element)
XMLInputOutput
reader
starting with element
.
fromXML
in interface XMLInputOutput<Module>
public static XMLInputOutput<Module> getXMLInputOutput()
public java.lang.String getElementTypeName()
XMLInputOutput
getElementTypeName
in interface XMLInputOutput<Module>
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |