org.jlinalg

Class RingElement<RE extends IRingElement<RE>>

java.lang.Object

org.jlinalg.RingElement<RE>

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<RE>, IRingElement<RE>

Direct Known Subclasses:

FieldElement, Polynomial

public abstract class RingElement<RE extends IRingElement<RE>>
extends java.lang.Object
implements IRingElement<RE>, java.lang.Comparable<RE>, java.io.Serializable

The basic implementation of some methods for most ring elements.

Author:

Andreas, Georg Thimm

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private static long	serialVersionUID

Constructor Summary

Constructors

Constructor and Description
RingElement()

Method Summary

Modifier and Type	Method and Description
RE	apply(MonadicOperator<RE> fun) Returns the result of applying a specified function to this FieldElement.
RE	divide(RE val)
boolean	equals(java.lang.Object obj) Determines whether or not two RingElements are equal.
boolean	ge(RE val) Checks whether this RingElement is mathematically greater than or equal to another.
boolean	gt(RE val) Checks whether this RingElement is mathematically greater than another.
RE	invert() Inverts this ring element (divides one by it)
boolean	isOne() Tests if this RingElement is the neutral element of multiplication (one).
boolean	isZero() Tests if this RingElement is the neutral element of addition (zero).
boolean	le(RE val) Checks whether this RingElement is mathematically less than or equal to another.
boolean	lt(RE val) Checks whether this RingElement is mathematically less than another.
RE	norm()
RE	subtract(RE val) Calculates the difference of this RingElement and another one.

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.jlinalg.IRingElement

abs, add, compareTo, getFactory, multiply, negate

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

RingElement

public RingElement()

Method Detail

isZero

public boolean isZero()

Tests if this RingElement is the neutral element of addition (zero).

Specified by:

isZero in interface IRingElement<RE extends IRingElement<RE>>

Returns:

true if zero

subtract

public RE subtract(RE val)

Calculates the difference of this RingElement and another one.

Specified by:

subtract in interface IRingElement<RE extends IRingElement<RE>>

Parameters:

val -

Returns:

difference

isOne

public boolean isOne()

Tests if this RingElement is the neutral element of multiplication (one).

Specified by:

isOne in interface IRingElement<RE extends IRingElement<RE>>

Returns:

true if one

equals

public boolean equals(java.lang.Object obj)

Determines whether or not two RingElements are equal.

Specified by:

equals in interface IRingElement<RE extends IRingElement<RE>>

Overrides:

equals in class java.lang.Object

Parameters:

obj -

Returns:

true if the two RingElements are mathematically equal.

apply

public RE apply(MonadicOperator<RE> fun)

Returns the result of applying a specified function to this FieldElement. New functions can be applied to a RingElement by sub-classing the abstract MonadicOperator class.

Specified by:

apply in interface IRingElement<RE extends IRingElement<RE>>

Parameters:

fun - the function to apply

Returns:

result of applying fun to this RingElement

norm

public RE norm()

Specified by:

norm in interface IRingElement<RE extends IRingElement<RE>>

Returns:

the absolute value of this field.

lt

public boolean lt(RE val)

Checks whether this RingElement is mathematically less than another.

Specified by:

lt in interface IRingElement<RE extends IRingElement<RE>>

Parameters:

val -

Returns:

true if this RingElement is less than val, false otherwise

Throws:

InvalidOperationException - if @code this} and val are not instances of the same class

gt

public boolean gt(RE val)

Checks whether this RingElement is mathematically greater than another.

Specified by:

gt in interface IRingElement<RE extends IRingElement<RE>>

Parameters:

val -

Returns:

true if this RingElement is greater than val, false otherwise

Throws:

InvalidOperationException - if this and val are not instances of the same class

le

public boolean le(RE val)

Checks whether this RingElement is mathematically less than or equal to another.

Specified by:

le in interface IRingElement<RE extends IRingElement<RE>>

Parameters:

val -

Returns:

true if this RingElement is less than or equal to val, false otherwise

Throws:

InvalidOperationException - if this and val are not instances of the same class

ge

public boolean ge(RE val)

Checks whether this RingElement is mathematically greater than or equal to another.

Specified by:

ge in interface IRingElement<RE extends IRingElement<RE>>

Parameters:

val -

Returns:

true if this RingElement is greater than or equal to val, false otherwise

Throws:

InvalidOperationException - if this and val are not instances of the same class

divide

public RE divide(RE val)
          throws DivisionByZeroException,
                 InvalidOperationException

Specified by:

divide in interface IRingElement<RE extends IRingElement<RE>>

Returns:

this divided by val

Throws:

DivisionByZeroException - if a division is possible for the type, but val is the zero element.

InvalidOperationException - as in the general case, an inversion is not possible.

invert

public RE invert()
          throws DivisionByZeroException,
                 InvalidOperationException

Description copied from interface: IRingElement

Inverts this ring element (divides one by it)

Specified by:

invert in interface IRingElement<RE extends IRingElement<RE>>

Returns:

the inverse of this ring element

Throws:

DivisionByZeroException - if an inversion is possible for the type, but the element is the zero element.

InvalidOperationException - as in the general case, an inversion is not possible.