org.rubato.math.module.morphism
Class FoldingMorphism

java.lang.Object
  extended by org.rubato.math.module.morphism.ModuleMorphism
      extended by org.rubato.math.module.morphism.FoldingMorphism
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<ModuleMorphism>, XMLInputOutput<ModuleMorphism>

public final class FoldingMorphism
extends ModuleMorphism

Morphism that represents the folding of a set of ModuleElements.

Author:
Gérard Milmeister
See Also:
Serialized Form

Constructor Summary
FoldingMorphism(ModuleElement[] elements)
          Create a morphism that maps each of elements to its fold number.
 
Method Summary
 int compareTo(ModuleMorphism object)
          Compares two module morphisms.
 boolean equals(java.lang.Object object)
          Returns true iff this morphism is equal to object.
 ModuleMorphism 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.
 ModuleMorphism getRingMorphism()
          Returns the the ring morphism that transforms between the rings of the domain and codomain modules.
static XMLInputOutput<ModuleMorphism> getXMLInputOutput()
           
 ModuleElement map(ModuleElement element)
          Maps the element x.
 double mapValue(ModuleElement element)
           
 java.lang.String toString()
          Returns a string representation of this morphism.
 void toXML(XMLWriter writer)
          Outputs XML representation to writer.
 
Methods inherited from class org.rubato.math.module.morphism.ModuleMorphism
atZero, clone, composable, compose, difference, getCodomain, getConstantMorphism, getConstantMorphism, getDomain, getIdentityMorphism, inDomain, isConstant, isIdentity, isLinear, isModuleHomomorphism, isRingHomomorphism, isRingMorphism, power, scaled, sum
 
Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

FoldingMorphism

public FoldingMorphism(ModuleElement[] elements)
Create a morphism that maps each of elements to its fold number.

Method Detail

map

public ModuleElement map(ModuleElement element)
Description copied from class: ModuleMorphism
Maps the element x. This must be implemented for each specific morphism type.

Specified by:
map in class ModuleMorphism
Returns:
the result of mapping element x

mapValue

public double mapValue(ModuleElement element)

getRingMorphism

public ModuleMorphism getRingMorphism()
Description copied from class: ModuleMorphism
Returns the the ring morphism that transforms between the rings of the domain and codomain modules.

Specified by:
getRingMorphism in class ModuleMorphism

compareTo

public int compareTo(ModuleMorphism object)
Description copied from class: ModuleMorphism
Compares two module morphisms. Checks first for equality. The default comparison is on names, subclasses may implement a more meaningful comparison.

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

equals

public boolean equals(java.lang.Object object)
Description copied from class: ModuleMorphism
Returns true iff this morphism is equal to object. In general it is not possible to determine whether to functions are the same, so this returns true iff both morphisms have the same structure.

Specified by:
equals in class ModuleMorphism

toString

public java.lang.String toString()
Description copied from class: ModuleMorphism
Returns a string representation of this morphism. This string is used for generic comparison.

Specified by:
toString in class ModuleMorphism

toXML

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


fromXML

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

Returns:
an object of type T or null if parsing failed

getXMLInputOutput

public static XMLInputOutput<ModuleMorphism> getXMLInputOutput()

getElementTypeName

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