## Libraries.Compute.Statistics.Calculations.RegularizedBetaContinuedFraction Documentation

This is an implementation, ported from Apache Commons, of the incomplete beta function. More information can be found here: https://en.wikipedia.org/wiki/Beta_function

*Inherits from: *Libraries.Language.Object, Libraries.Compute.Statistics.Calculations.ContinuedFraction

## Summary

### Actions Summary Table

Actions | Description |
---|---|

Compare(Libraries.Language.Object object) | This action compares two object hash codes and returns an integer. |

Equals(Libraries.Language.Object object) | This action determines if two objects are equal based on their hash code values. |

Evaluate(number x, integer maxIterations) | Evaluate the continued fraction for a max number of iterations. |

Evaluate(number x, number epsilon, integer maxIterations) | Evaluate the continued fraction for a number, with a specified error, for a maximum number of iterations. |

Evaluate(number x) | Evaluate the continued fraction for a particular number. |

Evaluate(number x, number epsilon) | Evaluate the continued fraction for a number with a particular max error. |

GetA(integer n, number x) | |

GetB(integer n, number x) | |

GetHashCode() | This action gets the hash code for an object. |

SetA(number a) | |

SetB(number b) |

## Actions Documentation

### Compare(Libraries.Language.Object object)

This action compares two object hash codes and returns an integer. The result is larger if this hash code is larger than the object passed as a parameter, smaller, or equal. In this case, -1 means smaller, 0 means equal, and 1 means larger. This action was changed in Quorum 7 to return an integer, instead of a CompareResult object, because the previous implementation was causing efficiency issues.

**Example Code**

```
Object o
Object t
integer result = o:Compare(t) //1 (larger), 0 (equal), or -1 (smaller)
```

#### Parameters

- Libraries.Language.Object: The object to compare to.

#### Return

integer: The Compare result, Smaller, Equal, or Larger.

### Equals(Libraries.Language.Object object)

This action determines if two objects are equal based on their hash code values.

**Example Code**

```
use Libraries.Language.Object
use Libraries.Language.Types.Text
Object o
Text t
boolean result = o:Equals(t)
```

#### Parameters

- Libraries.Language.Object: The to be compared.

#### Return

boolean: True if the hash codes are equal and false if they are not equal.

### Evaluate(number x, integer maxIterations)

Evaluate the continued fraction for a max number of iterations.

#### Parameters

#### Return

number:

### Evaluate(number x, number epsilon, integer maxIterations)

Evaluate the continued fraction for a number, with a specified error, for a maximum number of iterations.

#### Parameters

#### Return

number:

### Evaluate(number x)

Evaluate the continued fraction for a particular number.

#### Parameters

#### Return

number:

### Evaluate(number x, number epsilon)

Evaluate the continued fraction for a number with a particular max error.

#### Parameters

#### Return

number:

### GetA(integer n, number x)

#### Parameters

#### Return

number

### GetB(integer n, number x)

#### Parameters

#### Return

number

### GetHashCode()

This action gets the hash code for an object.

**Example Code**

```
Object o
integer hash = o:GetHashCode()
```

#### Return

integer: The integer hash code of the object.