nilgiri.math.autodiff
Class Product<X extends Field<X>>

java.lang.Object
  nilgiri.math.autodiff.DifferentialFunction<X>
      nilgiri.math.autodiff.AbstractBinaryFunction<X>
          nilgiri.math.autodiff.Product<X>

Type Parameters:

X - A set forms a field.

All Implemented Interfaces:

Differential<Variable<X>,DifferentialFunction<X>>, CommutativeGroup<DifferentialFunction<X>>, CommutativeRing<DifferentialFunction<X>>, Field<DifferentialFunction<X>>, Group<DifferentialFunction<X>>, Ring<DifferentialFunction<X>>

public class Product<X extends Field<X>>
extends AbstractBinaryFunction<X>

A product of two objects of DifferentialFunction<X&rt.

Constructor Summary

Product(DifferentialFunction<X> i_v1, DifferentialFunction<X> i_v2)
Constructs an object whose value is (i_v1 * i_v2)

Method Summary

DifferentialFunction<X>	diff(Variable<X> i_v1) Returns an object of D whose value is the derivative with respect to i_v.
X	getValue() Returns the value in X of the function.
java.lang.String	toString()

Methods inherited from class nilgiri.math.autodiff.AbstractBinaryFunction

larg, rarg

Methods inherited from class nilgiri.math.autodiff.DifferentialFunction

div, inverse, isConstant, isVariable, minus, mul, mul, negate, plus, pow

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Product

public Product(DifferentialFunction<X> i_v1,
               DifferentialFunction<X> i_v2)

Constructs an object whose value is (i_v1 * i_v2)

Parameters:

i_v1 - left argument of a multiplication operator *.

i_v2 - right argument of a multiplication operator *.

Method Detail

getValue

public X getValue()

Description copied from class: DifferentialFunction

Returns the value in X of the function.

Specified by:

getValue in class DifferentialFunction<X extends Field<X>>

Returns:

the value.

diff

public DifferentialFunction<X> diff(Variable<X> i_v1)

Description copied from interface: Differential

Returns an object of D whose value is the derivative with respect to i_v.

Specified by:

diff in interface Differential<Variable<X extends Field<X>>,DifferentialFunction<X extends Field<X>>>

Specified by:

diff in class DifferentialFunction<X extends Field<X>>

Returns:

the derivative with respect to i_v.

toString

public java.lang.String toString()

Specified by:

toString in class DifferentialFunction<X extends Field<X>>