R_F (HM Gears 0.10.7 API)

java.lang.Object
- org.hortonmachine.gears.utils.math.functions.R_F

All Implemented Interfaces:

ISingleArgmentFunction
```
public final class R_F
extends Object
implements ISingleArgmentFunction
```
Mathematical function R_F.
An equation that it is used to estimate the value of the rain time that generate the maximum discharge.

The parameters required by the functions in setParameters(double...) are:
- known the know value.
- exponent the value used as exponent.
Author:

Daniele Andreis

Constructor Summary

Constructors
Constructor Description

R_F()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`double`	`getValue(double x)`	Return the value of the function in a specific point.
`void`	`setParameters(double... params)`	Set the parameters for the particular function.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - R_F
```
public R_F()
```
- Method Detail
  - getValue
```
public double getValue(double x)
```
    Description copied from interface: ISingleArgmentFunction
    
    Return the value of the function in a specific point.
    
    Specified by:
    
    getValue in interface ISingleArgmentFunction
    
    Parameters:
    
    x - the point where evaluate the function.
    
    Returns:
    
    the function value.
  - setParameters
```
public void setParameters(double... params)
```
    Description copied from interface: ISingleArgmentFunction
    
    Set the parameters for the particular function.
    The list and definition of the parameters are described in the class documentation of each function.
    
    Specified by:
    
    setParameters in interface ISingleArgmentFunction
    
    Parameters:
    
    params - the parameters to set.