arundel.util.functions

Class Constant

java.lang.Object

arundel.util.functions.Constant

All Implemented Interfaces:

Function

public class Constant
extends java.lang.Object
implements Function

Field Summary

Fields

Modifier and Type	Field and Description
int	constant

Constructor Summary

Constructors

Constructor and Description
Constant(int c)

Method Summary

Modifier and Type	Method and Description
double[]	derivatives(double... param) Returns the partial derivatives of this function with respect to its parameters as an array of Function
int	noOfInputs() Note that the no of inputs for a constant function does not matter as it will output the same constant irrespective of the input.
static Constant	op(int c) Creates a new instance of Constant
double	operate(double... param) Operates on the given set of inputs and returns the result of the operation.

Methods inherited from class java.lang.Object

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

Field Detail

constant

public final int constant

Constructor Detail

Constant

public Constant(int c)

Method Detail

op

public static Constant op(int c)

Creates a new instance of Constant

Parameters:

c - the constant output of the new function

Returns:

a new Constant instance

noOfInputs

public int noOfInputs()

Note that the no of inputs for a constant function does not matter as it will output the same constant irrespective of the input.

Specified by:

noOfInputs in interface Function

Returns:

the no of inputs = 1 (by default)

operate

public double operate(double... param)

Description copied from interface: Function

Operates on the given set of inputs and returns the result of the operation. This is the elixir of the concept of functions.

Specified by:

operate in interface Function

Parameters:

param - to be operated on

Returns:

the result of the operation or Double.NaN if expected number of parameters is not found (if it matters).

derivatives

public double[] derivatives(double... param)

Description copied from interface: Function

Returns the partial derivatives of this function with respect to its parameters as an array of Function

Specified by:

derivatives in interface Function

Parameters:

param - point of tangency

Returns:

array of partial derivative values, null if the expected no of parameters is not found