org.jlinalg

Interface IRingElement<RE extends IRingElement<RE>>

All Known Subinterfaces:

IEuclideanRingElement<RE>

All Known Implementing Classes:

BigDecimalWrapper, Complex, DoubleWrapper, F2, FastRational, FieldElement, FieldP, FieldPBig, FieldPLong, Polynomial, Rational, RationalFunction, RingElement

public interface IRingElement<RE extends IRingElement<RE>>

Author:

Georg Thimm

Method Summary

Modifier and Type	Method and Description
RE	abs() Returns absolute value of this element
RE	add(RE other) Calculates the sum of this RingElement and another one.
RE	apply(MonadicOperator<RE> fun) Returns the result of applying a specified function to this FielkdElement.
int	compareTo(RE o)
RE	divide(RE val)
boolean	equals(java.lang.Object obj) Determines whether or not two IRingElements are equal.
boolean	ge(RE val) Checks whether this IRingElement is mathematically greater than or equal to another.
IRingElementFactory<RE>	getFactory() Give access to the factory for this type.
boolean	gt(RE val) Checks whether this IRingElement is mathematically greater than another.
RE	invert() Inverts this ring element (divides one by it)
boolean	isOne() Tests if this IRingElement 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 IRingElement is mathematically less than or equal to another.
boolean	lt(RE val) Checks whether this IRingElement is mathematically less than another.
RE	multiply(RE other) Calculates the product of this IRingElement and another one.
RE	negate() Calculates the inverse element of addition for this IRingElement.
RE	norm()
RE	subtract(RE val) Calculates the difference of this IRingElement and another one.

Method Detail

isZero

boolean isZero()

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

Returns:

true if zero

add

RE add(RE other)

Calculates the sum of this RingElement and another one.

Parameters:

other -

Returns:

sum

subtract

RE subtract(RE val)

Calculates the difference of this IRingElement and another one.

Parameters:

val -

Returns:

difference

negate

RE negate()

Calculates the inverse element of addition for this IRingElement.

Returns:

negated

isOne

boolean isOne()

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

Returns:

true if one

multiply

RE multiply(RE other)

Calculates the product of this IRingElement and another one.

Parameters:

other -

Returns:

product

equals

boolean equals(java.lang.Object obj)

Determines whether or not two IRingElements are equal.

Overrides:

equals in class java.lang.Object

Parameters:

obj -

Returns:

true if the two IRingElements are mathematically equal.

compareTo

int compareTo(RE o)

Parameters:

o - the object

Returns:

-,0,+} as this object is less than, equal to, or greater than the specified object.

apply

RE apply(MonadicOperator<RE> fun)

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

Parameters:

fun - the function to apply

Returns:

result of applying fun to this IRingElement

abs

RE abs()

Returns absolute value of this element

Returns:

the absolute value.

norm

RE norm()

Returns:

the norm of this element.

lt

boolean lt(RE val)

Checks whether this IRingElement is mathematically less than another.

Parameters:

val -

Returns:

true if this IRingElement is less than val, false otherwise

gt

boolean gt(RE val)

Checks whether this IRingElement is mathematically greater than another.

Parameters:

val -

Returns:

true if this IRingElement is greater than val, false otherwise

le

boolean le(RE val)

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

Parameters:

val -

Returns:

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

ge

boolean ge(RE val)

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

Parameters:

val -

Returns:

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

invert

RE invert()
   throws DivisionByZeroException

Inverts this ring element (divides one by it)

Returns:

the inverse of this ring element

Throws:

DivisionByZeroException - if this is equal to the zero element.

divide

RE divide(RE val)
   throws DivisionByZeroException

Parameters:

val -

Returns:

this divided by val

Throws:

DivisionByZeroException

getFactory

IRingElementFactory<RE> getFactory()

Give access to the factory for this type. This is to replace in a consistent manner the constructors of

Returns:

a factory for creating instances of classes implementing IRingElement