org.rubato.math.module
Class ZProperFreeModule

java.lang.Object
  extended by org.rubato.math.module.ProperFreeModule
      extended by org.rubato.math.module.ZProperFreeModule
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<Module>, FreeModule, Module, ZFreeModule, XMLInputOutput<Module>

public final class ZProperFreeModule
extends ProperFreeModule
implements ZFreeModule

Free modules over integers.

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

Field Summary
static ZProperFreeModule nullModule
           
 
Method Summary
 ZFreeElement cast(ModuleElement element)
          Casts element to an element in this module if possible.
 int compareTo(Module object)
          Compares this module with object.
 ZFreeElement 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.
 ZRing getComponentModule(int i)
          Returns the i-th component module.
 java.lang.String getElementTypeName()
          Returns the value of the type attribute for this class.
 ZProperFreeModule getNullModule()
          Returns the null-module corresponding to this module.
 ZRing getRing()
          Returns the underlying ring of this module.
 ZFreeElement getUnitElement(int i)
          Returns the unit vector with 1 at position i.
static XMLInputOutput<Module> getXMLInputOutput()
           
 ZFreeElement getZero()
          Returns the zero element in this module.
 boolean hasElement(ModuleElement element)
          Returns true iff element is an element of this module.
 int hashCode()
          Returns the hash code for this module.
 boolean isNullModule()
          Returns true iff this is a null-module.
 boolean isVectorspace()
          Returns true if this free module is a vector space.
static ZFreeModule make(int dimension)
           
 ZFreeElement 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.ProperFreeModule
getDimension, getIdentityMorphism, getInjection, getProjection, getTranslation, 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
 
Methods inherited from interface org.rubato.math.module.Module
getDimension, getIdentityMorphism, getTranslation, isRing
 

Field Detail

nullModule

public static final ZProperFreeModule nullModule
Method Detail

make

public static ZFreeModule make(int dimension)

getZero

public ZFreeElement getZero()
Description copied from interface: Module
Returns the zero element in this module.

Specified by:
getZero in interface Module
Specified by:
getZero in interface ZFreeModule

getUnitElement

public ZFreeElement getUnitElement(int i)
Description copied from interface: FreeModule
Returns the unit vector with 1 at position i.

Specified by:
getUnitElement in interface FreeModule
Specified by:
getUnitElement in interface ZFreeModule

getNullModule

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

Specified by:
getNullModule in interface Module

isNullModule

public boolean isNullModule()
Description copied from interface: Module
Returns true iff this is a null-module.

Specified by:
isNullModule in interface Module

getComponentModule

public ZRing getComponentModule(int i)
Description copied from interface: Module
Returns the i-th component module.

Specified by:
getComponentModule in interface Module

getRing

public ZRing getRing()
Description copied from interface: Module
Returns the underlying ring of this module.

Specified by:
getRing in interface Module

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

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

compareTo

public int compareTo(Module object)
Description copied from interface: Module
Compares this module with object.

Specified by:
compareTo in interface java.lang.Comparable<Module>
Specified by:
compareTo in interface Module
Overrides:
compareTo in class ProperFreeModule

createElement

public ZFreeElement createElement(java.util.List<ModuleElement> elements)
Description copied from interface: Module
Creates an element in this module from a list of module elements.

Specified by:
createElement in interface Module
Specified by:
createElement in interface ZFreeModule
Returns:
null if no element in this module can be created from the arguments.

cast

public ZFreeElement 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

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
Overrides:
equals in class java.lang.Object

parseString

public ZFreeElement 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
Returns:
null if the string is in the wrong format

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

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