org.rubato.math.module
Class DirectSumModule

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

public final class DirectSumModule
extends java.lang.Object
implements Module

Module with arbitrary modules as components.

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

Method Summary
 DirectSumElement cast(ModuleElement element)
          Casts element to an element in this module if possible.
 int compareTo(Module object)
          Compares this module with object.
 DirectSumElement 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.
 DirectSumElement fill(java.util.List<ModuleElement> elements)
           
 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.
 DirectSumModule getNullModule()
          Returns the null-module corresponding to this module.
 Ring getRing()
          Returns the underlying ring of this module.
 ModuleMorphism getTranslation(ModuleElement element)
          Returns a morphism that translates by element.
 DirectSumElement 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 isRing()
          Returns true iff this module is a ring.
static DirectSumModule make(Module... components)
          Creates a direct sum with the given components.
static DirectSumModule makeNullModule(Ring ring)
          Creates a direct sum with no components of the given ring.
 DirectSumElement 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, notify, notifyAll, wait, wait, wait
 

Method Detail

make

public static DirectSumModule make(Module... components)
Creates a direct sum with the given components. All components must be modules of the same ring.


makeNullModule

public static DirectSumModule makeNullModule(Ring ring)
Creates a direct sum with no components of the given ring.


getNullModule

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

isRing

public boolean isRing()
Description copied from interface: Module
Returns true iff this module is a ring.

Specified by:
isRing in interface Module

getRing

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

Specified by:
getRing in interface Module

getZero

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

Specified by:
getZero in interface Module

getIdentityMorphism

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

Specified by:
getIdentityMorphism in interface Module

getDimension

public int getDimension()
Description copied from interface: Module
Returns the dimension of this module.

Specified by:
getDimension in interface Module

getComponentModule

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

Specified by:
getComponentModule in interface Module

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

createElement

public DirectSumElement 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
Returns:
null if no element in this module can be created from the arguments.

fill

public DirectSumElement fill(java.util.List<ModuleElement> elements)

cast

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

getTranslation

public ModuleMorphism getTranslation(ModuleElement element)
Description copied from interface: Module
Returns a morphism that translates by element.

Specified by:
getTranslation 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

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 DirectSumElement 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>

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