Gauss Function (G Dataflow)

Last Modified: August 13, 2019

Computes the Gauss hypergeometric function according to a specific input argument and parameters.

x

Input argument. If x is negative, the node uses the absolute value of x.

Default: 0

a

The first parameter of the Gauss hypergeometric function.

b

The second parameter of the Gauss hypergeometric function.

c

The third parameter of the Gauss hypergeometric function.

error in

Error conditions that occur before this node runs.

The node responds to this input according to standard error behavior.

Standard Error Behavior

Many nodes provide an error in input and an error out output so that the node can respond to and communicate errors that occur while code is running. The value of error in specifies whether an error occurred before the node runs. Most nodes respond to values of error in in a standard, predictable way.

error in does not contain an error error in contains an error
If no error occurred before the node runs, the node begins execution normally.

If no error occurs while the node runs, it returns no error. If an error does occur while the node runs, it returns that error information as error out.

If an error occurred before the node runs, the node does not execute. Instead, it returns the error in value as error out.

Default: No error

F(x, a, b, c)

Value of the Gauss hypergeometric function.

error out

Error information.

The node produces this output according to standard error behavior.

Standard Error Behavior

Many nodes provide an error in input and an error out output so that the node can respond to and communicate errors that occur while code is running. The value of error in specifies whether an error occurred before the node runs. Most nodes respond to values of error in in a standard, predictable way.

error in does not contain an error error in contains an error
If no error occurred before the node runs, the node begins execution normally.

If no error occurs while the node runs, it returns no error. If an error does occur while the node runs, it returns that error information as error out.

If an error occurred before the node runs, the node does not execute. Instead, it returns the error in value as error out.

Algorithm for Computing the Gauss Function

The Gauss hypergeometric function F(x, a, b, c) is a solution of the following differential equation:

$x\left(1-x\right)\frac{{d}^{2}w}{d{x}^{2}}+\left[c-\left(a+b+1\right)x\right]\frac{dw}{dx}-abw=0$

The function is defined according to the following intervals for the input values.

$a,b,c\in \Re ,x\in \left(-\infty ,1\right)$
$\left(c>a+b\right)⇒x\in \left(-\infty ,1\right]$

This node supports the entire domain of this function that produces real-valued results. For any real value of a, b, and c, the function is defined for real values of x < 1. For real values of a, b, and c, such that c > a + b, the domain of x is extended to include 1.

Where This Node Can Run:

Desktop OS: Windows

FPGA: Not supported

Web Server: Not supported in VIs that run in a web application