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

java.lang.Object
  nilgiri.math.autodiff.DifferentialFunction<X>
      nilgiri.math.autodiff.Constant<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>>

Direct Known Subclasses:

One, Zero

public class Constant<X extends Field<X>>
extends DifferentialFunction<X>

A constant in X forms a field. Computations are done correctly while objects of this class and those values are immutable.

Method Summary

DifferentialFunction<X>	diff(Variable<X> i_v) 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.
DifferentialFunction<X>	inverse() Returns an object of X whose value is (1 / this).
boolean	isConstant() Returns true if this is a constant.
DifferentialFunction<X>	negate() Returns an object of X whose value is (- this).
java.lang.String	toString()

Methods inherited from class nilgiri.math.autodiff.DifferentialFunction

div, isVariable, minus, mul, mul, plus, pow

Methods inherited from class java.lang.Object

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

Method Detail

isConstant

public boolean isConstant()

Description copied from class: DifferentialFunction

Returns true if this is a constant.

Overrides:

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

Returns:

true if this is a constant.

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_v)

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

inverse

public DifferentialFunction<X> inverse()

Description copied from interface: Field

Returns an object of X whose value is (1 / this).

Specified by:

inverse in interface Field<DifferentialFunction<X extends Field<X>>>

Overrides:

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

Returns:

1 / this

negate

public DifferentialFunction<X> negate()

Description copied from interface: Group

Returns an object of X whose value is (- this).

Specified by:

negate in interface Group<DifferentialFunction<X extends Field<X>>>

Overrides:

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

Returns:

- this