com.graphbuilder.math.func.Function Interface Reference
The Function interface represents a function that takes a number of inputs and returns a value. More...
Public Member Functions | |
| double | of (double[] param, int numParam) |
| Takes the specified double array as input and returns a double value. | |
| boolean | acceptNumParam (int numParam) |
| Returns true if the numParam is an accurate representation of the number of inputs the function processes. | |
Detailed Description
The Function interface represents a function that takes a number of inputs and returns a value.
The number of inputs expected depends on the function. For example, the PiFunction returns the value of Pi regardless of the input. The CosFunction uses the value at index location 0. The PowFunction uses the values at index locations 0 and 1. See the FuncMap class for more information.
- See also:
- com.graphbuilder.math.FuncMap
Definition at line 12 of file Function.java.
Member Function Documentation
| boolean com.graphbuilder.math.func.Function.acceptNumParam | ( | int | numParam | ) |
Returns true if the numParam is an accurate representation of the number of inputs the function processes.
Implemented in com.graphbuilder.math.func.AbsFunction, com.graphbuilder.math.func.AvgFunction, com.graphbuilder.math.func.CeilFunction, com.graphbuilder.math.func.CombinFunction, com.graphbuilder.math.func.EFunction, com.graphbuilder.math.func.ExpFunction, com.graphbuilder.math.func.FactFunction, com.graphbuilder.math.func.FloorFunction, com.graphbuilder.math.func.IfFunction, com.graphbuilder.math.func.LgFunction, com.graphbuilder.math.func.LnFunction, com.graphbuilder.math.func.LogFunction, com.graphbuilder.math.func.MaxFunction, com.graphbuilder.math.func.MinFunction, com.graphbuilder.math.func.ModFunction, com.graphbuilder.math.func.PowFunction, com.graphbuilder.math.func.RoundFunction, com.graphbuilder.math.func.SignFunction, com.graphbuilder.math.func.SqrtFunction, com.graphbuilder.math.func.SumFunction, and edu.rice.cs.hpc.data.experiment.metric.StdDevFunction.
| double com.graphbuilder.math.func.Function.of | ( | double[] | param, | |
| int | numParam | |||
| ) |
Takes the specified double array as input and returns a double value.
Functions that accept a variable number of inputs can take numParam to be the number of inputs.
Implemented in com.graphbuilder.math.func.AbsFunction, com.graphbuilder.math.func.AvgFunction, com.graphbuilder.math.func.CeilFunction, com.graphbuilder.math.func.CombinFunction, com.graphbuilder.math.func.EFunction, com.graphbuilder.math.func.ExpFunction, com.graphbuilder.math.func.FactFunction, com.graphbuilder.math.func.FloorFunction, com.graphbuilder.math.func.IfFunction, com.graphbuilder.math.func.LgFunction, com.graphbuilder.math.func.LnFunction, com.graphbuilder.math.func.LogFunction, com.graphbuilder.math.func.MaxFunction, com.graphbuilder.math.func.MinFunction, com.graphbuilder.math.func.ModFunction, com.graphbuilder.math.func.PowFunction, com.graphbuilder.math.func.RoundFunction, com.graphbuilder.math.func.SignFunction, com.graphbuilder.math.func.SqrtFunction, com.graphbuilder.math.func.SumFunction, and edu.rice.cs.hpc.data.experiment.metric.StdDevFunction.
The documentation for this interface was generated from the following file:
- edu.rice.cs.hpc.data/externals/com/graphbuilder/math/func/Function.java
