org.rubato.math.module
Class RestrictedElement

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

public class RestrictedElement
extends java.lang.Object
implements ModuleElement

Elements in a restricted module. Instances are created using the static make(RestrictedModule,ModuleElement) method.

Author:
Gérard Milmeister
See Also:
Serialized Form

Method Summary
 void add(ModuleElement element)
          Adds element to this module element.
 ModuleElement cast(Module module)
          Tries to cast this element to an element in the given module.
 RestrictedElement clone()
          Returns a deep copy of this module element.
 int compareTo(ModuleElement object)
          Compares this module element with object.
 ModuleElement difference(ModuleElement element)
          Returns the difference of this module element and element.
 boolean equals(java.lang.Object object)
          Returns true iff this element is equal to object.
 double[] fold(ModuleElement[] elements)
          Fold elements assuming they are of this same type.
 ModuleElement fromXML(XMLReader reader, org.w3c.dom.Element element)
          Reads XML representation from reader starting with element.
 ModuleElement getComponent(int i)
          Returns the i-th component element.
 java.lang.String getElementTypeName()
          Returns the value of the type attribute for this class.
 int getLength()
          Returns the length of the element.
 Module getModule()
          Returns the module that this module element is an element of.
 ModuleElement getUnrestrictedElement()
           
static XMLInputOutput<ModuleElement> getXMLInputOutput()
           
static RestrictedElement getZero(RestrictedModule module)
           
 boolean isZero()
          Returns true iff this element is zero.
static RestrictedElement make(RestrictedModule module, ModuleElement element)
           
 void negate()
          Negate this module element.
 ModuleElement negated()
          Returns the negative of this module element.
 void scale(RingElement element)
          Multiplies this element with element.
 ModuleElement scaled(RingElement element)
          Returns the product of this element with element.
 java.lang.String stringRep(boolean... parens)
          Returns a string representation of this module element.
 void subtract(ModuleElement element)
          Subtracts element from this module element.
 ModuleElement sum(ModuleElement element)
          Returns the sum of this module element and element.
 java.lang.String toString()
          Returns a human readable string representation of this module element.
 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.ModuleElement
hashCode
 

Method Detail

make

public static RestrictedElement make(RestrictedModule module,
                                     ModuleElement element)
                              throws DomainException
Throws:
DomainException

getZero

public static RestrictedElement getZero(RestrictedModule module)

isZero

public boolean isZero()
Description copied from interface: ModuleElement
Returns true iff this element is zero.

Specified by:
isZero in interface ModuleElement

scaled

public ModuleElement scaled(RingElement element)
                     throws DomainException
Description copied from interface: ModuleElement
Returns the product of this element with element.

Specified by:
scaled in interface ModuleElement
Throws:
DomainException - if element is not in domain

scale

public void scale(RingElement element)
           throws DomainException
Description copied from interface: ModuleElement
Multiplies this element with element. This is a destructive operation.

Specified by:
scale in interface ModuleElement
Throws:
DomainException - if element is not in domain

getLength

public int getLength()
Description copied from interface: ModuleElement
Returns the length of the element.

Specified by:
getLength in interface ModuleElement

getComponent

public ModuleElement getComponent(int i)
Description copied from interface: ModuleElement
Returns the i-th component element.

Specified by:
getComponent in interface ModuleElement

sum

public ModuleElement sum(ModuleElement element)
                  throws DomainException
Description copied from interface: ModuleElement
Returns the sum of this module element and element.

Specified by:
sum in interface ModuleElement
Throws:
DomainException - if element is not in domain

add

public void add(ModuleElement element)
         throws DomainException
Description copied from interface: ModuleElement
Adds element to this module element. This is a destructive operation.

Specified by:
add in interface ModuleElement
Throws:
DomainException - if element is not in domain

difference

public ModuleElement difference(ModuleElement element)
                         throws DomainException
Description copied from interface: ModuleElement
Returns the difference of this module element and element.

Specified by:
difference in interface ModuleElement
Throws:
DomainException - if element is not in domain

subtract

public void subtract(ModuleElement element)
              throws DomainException
Description copied from interface: ModuleElement
Subtracts element from this module element. This is a destructive operation.

Specified by:
subtract in interface ModuleElement
Throws:
DomainException - if element is not in domain

negated

public ModuleElement negated()
Description copied from interface: ModuleElement
Returns the negative of this module element.

Specified by:
negated in interface ModuleElement

negate

public void negate()
Description copied from interface: ModuleElement
Negate this module element. This is a destructive operation.

Specified by:
negate in interface ModuleElement

fold

public double[] fold(ModuleElement[] elements)
Description copied from interface: ModuleElement
Fold elements assuming they are of this same type.

Specified by:
fold in interface ModuleElement

getModule

public Module getModule()
Description copied from interface: ModuleElement
Returns the module that this module element is an element of.

Specified by:
getModule in interface ModuleElement

getUnrestrictedElement

public ModuleElement getUnrestrictedElement()

cast

public ModuleElement cast(Module module)
Description copied from interface: ModuleElement
Tries to cast this element to an element in the given module.

Specified by:
cast in interface ModuleElement
Returns:
a new module element in the required module and null if the cast cannot be performed.

stringRep

public java.lang.String stringRep(boolean... parens)
Description copied from interface: ModuleElement
Returns a string representation of this module element. The representation is meant to be parseable. If the argument parens is present then the the representation is parenthesized if necessary.

Specified by:
stringRep in interface ModuleElement

equals

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

Specified by:
equals in interface ModuleElement
Overrides:
equals in class java.lang.Object

compareTo

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

Specified by:
compareTo in interface java.lang.Comparable<ModuleElement>
Specified by:
compareTo in interface ModuleElement

clone

public RestrictedElement clone()
Description copied from interface: ModuleElement
Returns a deep copy of this module element.

Specified by:
clone in interface ModuleElement
Overrides:
clone in class java.lang.Object

toString

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

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

toXML

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

Specified by:
toXML in interface XMLInputOutput<ModuleElement>

fromXML

public ModuleElement 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<ModuleElement>
Returns:
an object of type T or null if parsing failed

getXMLInputOutput

public static XMLInputOutput<ModuleElement> getXMLInputOutput()

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