JAutoDiff

nilgiri.math
Interface Ring<X>

Type Parameters:
X - A set forms a ring.
All Superinterfaces:
CommutativeGroup<X>, Group<X>
All Known Subinterfaces:
CommutativeRing<X>, ComplexNumber<R,X>, DifferentialMatrixFunction<X>, Field<X>, RealNumber<X>
All Known Implementing Classes:
AbstractBinaryFunction, AbstractUnaryFunction, Constant, DifferentialFunction, DoubleComplex, DoubleReal, Inverse, Negative, One, PolynomialTerm, Product, Sum, Variable, Zero

public interface Ring<X>
extends CommutativeGroup<X>

A class X implements the Ring<X&rt interface indicates that X has properties of being a ring.


Method Summary
 X mul(X i_v)
          Returns an object of X whose value is the product (this * i_v).
 X pow(int i_n)
          Returns an object of X whose value is the power (this ^ i_n).
 
Methods inherited from interface nilgiri.math.Group
minus, mul, negate, plus
 

Method Detail

mul

X mul(X i_v)
Returns an object of X whose value is the product (this * i_v).

Parameters:
i_v -
Returns:
this * i_v

pow

X pow(int i_n)
Returns an object of X whose value is the power (this ^ i_n). Ring guarantees the results for natural numbers only.

Parameters:
i_n - a natural number
Returns:
this ^ i_n

JAutoDiff

JAutoDiff website