Functions Index :: H :: Hyperbola

[<< up one level]

Module:

numeric :: curves2d

Definition:

Hyperbola(float x, float a, float b, bool "up_part", float "xc", float "yc")

Description:

Returns the y-value of x so that the point (x,y) lies on a hyperbola parallel to x axis defined by long axis half-length a, short axis half-length b and its center (xc,yc).

If xc or yc are not provided they default to zero.

up_part determines whether the point will be on the upper or lower part of the curve. If up_part is true or omitted it will on the upper part (ie >= yc), else on the lower (ie < yc).

Notes and conditions on arguments relations:

1] If x >= xc + a the function returns the y-value that corresponds to a point on the right branch of the hyperbola.

2] If x <= xc - a the function returns the y-value that corresponds to a point on the left branch of the hyperbola.

3] If x does not satisfy the above two conditions (does not correspond to a point in any branch, the function throws an error.

4] Exchange x,y to get a hyperbola with axis parallel to y axis.

Examples:

TODO in a later version of AVSLib.

 

[<< top]