org.rubato.math.module
Class ZStringRing

java.lang.Object
  extended by org.rubato.math.module.Ring
      extended by org.rubato.math.module.StringRing
          extended by org.rubato.math.module.ZStringRing
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<Module>, FreeModule, Module, ZStringFreeModule, XMLInputOutput<Module>

public final class ZStringRing
extends StringRing
implements ZStringFreeModule

The ring of ZString.

Author:
Gérard Milmeister
See Also:
ZStringElement, Serialized Form

Field Summary
static ZStringRing ring
           
 
Method Summary
 ModuleElement cast(ModuleElement element)
          Casts element to an element in this module if possible.
 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.
 java.lang.String getElementTypeName()
          Returns the value of the type attribute for this class.
 ZRing getFactorRing()
          Returns the ring of the factors.
 ZStringFreeModule getFreeModule(int dimension)
          Returns the corresponding free module of dimension dim.
 ModuleMorphism getIdentityMorphism()
          Returns the identity morphism in this module.
 ZStringProperFreeModule getNullModule()
          Returns the null-module corresponding to this module.
 ZStringElement getOne()
          Returns the unit element of this ring.
static XMLInputOutput<Module> getXMLInputOutput()
           
 ZStringElement getZero()
          Returns the zero element of this ring.
 boolean hasElement(ModuleElement element)
          Returns true iff element is an element of this module.
 int hashCode()
          Returns the hash code for this module.
 boolean isField()
          Returns true if this ring is a field.
 boolean isVectorspace()
          Returns true if this free module is a vector space.
 ZStringElement 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 org.rubato.math.module.StringRing
compareTo, createElement, getComponentModule, make, make
 
Methods inherited from class org.rubato.math.module.Ring
getDimension, getInjection, getProjection, getRing, getTranslation, getUnitElement, isNullModule, isRing
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.rubato.math.module.FreeModule
getInjection, getProjection, getUnitElement
 
Methods inherited from interface org.rubato.math.module.Module
compareTo, createElement, getComponentModule, getDimension, getRing, getTranslation, isNullModule, isRing
 

Field Detail

ring

public static final ZStringRing ring
Method Detail

getZero

public ZStringElement getZero()
Description copied from class: Ring
Returns the zero element of this ring.

Specified by:
getZero in interface Module
Specified by:
getZero in class StringRing

getOne

public ZStringElement getOne()
Description copied from class: Ring
Returns the unit element of this ring.

Specified by:
getOne in class StringRing

getNullModule

public ZStringProperFreeModule getNullModule()
Description copied from interface: Module
Returns the null-module corresponding to this module.

Specified by:
getNullModule in interface Module

isField

public boolean isField()
Description copied from class: Ring
Returns true if this ring is a field.

Specified by:
isField in class Ring

isVectorspace

public boolean isVectorspace()
Description copied from interface: FreeModule
Returns true if this free module is a vector space.

Specified by:
isVectorspace in interface FreeModule

getIdentityMorphism

public ModuleMorphism getIdentityMorphism()
Description copied from interface: Module
Returns the identity morphism in this module.

Specified by:
getIdentityMorphism in interface Module
Overrides:
getIdentityMorphism in class StringRing

hasElement

public boolean hasElement(ModuleElement element)
Description copied from interface: Module
Returns true iff element is an element of this module.

Specified by:
hasElement in interface Module
Specified by:
hasElement in class StringRing

getFreeModule

public ZStringFreeModule getFreeModule(int dimension)
Description copied from class: Ring
Returns the corresponding free module of dimension dim.

Specified by:
getFreeModule in class Ring

getFactorRing

public ZRing getFactorRing()
Description copied from class: StringRing
Returns the ring of the factors.

Specified by:
getFactorRing in class StringRing

equals

public boolean equals(java.lang.Object object)
Description copied from interface: Module
Returns true iff this module is equals to object.

Specified by:
equals in interface Module
Specified by:
equals in class StringRing

cast

public ModuleElement cast(ModuleElement element)
Description copied from interface: Module
Casts element to an element in this module if possible.

Specified by:
cast in interface Module
Returns:
null if cast is not possible

toString

public java.lang.String toString()
Description copied from interface: Module
Returns a human readable string representation of this module. The representation is not meant to be parseable.

Specified by:
toString in interface Module
Overrides:
toString in class java.lang.Object

toVisualString

public java.lang.String toVisualString()
Description copied from interface: Module
Returns a human readable string representation of this module. The representation is not meant to be parseable. The string should be a short representation, possibly using Unicode characters.

Specified by:
toVisualString in interface Module

parseString

public ZStringElement parseString(java.lang.String string)
Description copied from interface: Module
Creates an element in this module from a string representation.

Specified by:
parseString in interface Module
Specified by:
parseString in class Ring
Returns:
null if the string is in the wrong format

toXML

public void toXML(XMLWriter writer)
Description copied from interface: XMLInputOutput
Outputs XML representation to writer.

Specified by:
toXML in interface XMLInputOutput<Module>

fromXML

public Module fromXML(XMLReader reader,
                      org.w3c.dom.Element element)
Description copied from interface: XMLInputOutput
Reads XML representation from reader starting with element.

Specified by:
fromXML in interface XMLInputOutput<Module>
Returns:
an object of type T or null if parsing failed

getElementTypeName

public java.lang.String getElementTypeName()
Description copied from interface: XMLInputOutput
Returns the value of the type attribute for this class.

Specified by:
getElementTypeName in interface XMLInputOutput<Module>

getXMLInputOutput

public static XMLInputOutput<Module> getXMLInputOutput()

hashCode

public int hashCode()
Description copied from interface: Module
Returns the hash code for this module.

Specified by:
hashCode in interface Module
Overrides:
hashCode in class java.lang.Object