Documents
Writing Docs Gigedit SFZ Instrument Scripts NKSP Language NKSP Reference

min()

Returns the minimum value of the passed two value arguments. That means, it compares the two passed values with each other and returns the one which is smaller.

Function Prototype

min(number1,number2)

Arguments

Argument Name Data Type Description
number1 Integer Number or
Real Number
One of the two numbers to compare with.
[required]
number2 Integer Number or
Real Number
One of the two numbers to compare with.
[required]

Return Value

Data Type Description
Integer Number or
Real Number
Smallest number of the passed two values.

Remarks

This functions accepts any standard unit and finalness for its two arguments. However the unit types of the two arguments must be identical. The return value's unit type is identical to the two passed arguments' one, and the return value's finalness is the case if at least one of the two arguments has finalness.

Examples

The following example prints the result of some example argument values to the terminal as soon as the script is loaded.

See also

max()

Availability

Since LinuxSampler 2.0.0.svn23.

Document Updated:  2019-09-24  |  Author:  Christian Schoenebeck