File 'base/math.tcl' (part of 'Pool_Base')

Description (short): Mathematical procedures
Written by: Andreas Kupries
Description: Some mathematical procedures
Depends on: Tcl
Keywords: minimum search, maximum search

::pool::math::max (x y)

Argument: x First number to check

Argument: y Second number to check

Returns: Maximum of x and y.

::pool::math::maxList (list)

Determines the maximum number contained in list.

Argument: list list of numbers to search the maximum in.

Returns: Maximum element in list.

::pool::math::maxVarargs (args)

Determines the maximum of an arbitrary number of arguments. Uses ::pool::math::maxList to accomplish this.

Argument: args list of numbers to search the maximum in.

Returns: Maximum element in args.

::pool::math::min (x y)

Argument: x First number to check

Argument: y Second number to check

Returns: Minimum of x and y.

::pool::math::minList (list)

Determines the minimum number contained in list.

Argument: list list of numbers to search the minimum in.

Returns: Minimum element in list.

::pool::math::minVarargs (args)

Determines the minimum of an arbitrary number of arguments. Uses ::pool::math::minList to accomplish this.

Argument: args list of numbers to search the minimum in.

Returns: Minimum element in args.

::pool::math::setMax (varName value)

by Brent Welch

Set the variable varName to the maximum of its current and the specified value.

Argument: varName The name of the variable to maximize.

Argument: value The value to compare against.

Returns: 1 if the value of the variable, 0 else.

::pool::math::setMin (varName value)

by Brent Welch

Set the variable varName to the minimum of its current and the specified value.

Argument: varName The name of the variable to minimize.

Argument: value The value to compare against.

Returns: 1 if the value of the variable, 0 else.

Generated by AutoDoc 2.4 at 09/14/2000, invoked by Andreas Kupries

::pool::math::max (x y)
Argument: x	First number to check
Argument: y	Second number to check
Returns: Maximum of x and y.

::pool::math::maxList (list)
Determines the maximum number contained in list.
Argument: list	list of numbers to search the maximum in.
Returns: Maximum element in list.

::pool::math::maxVarargs (args)
Determines the maximum of an arbitrary number of arguments. Uses ::pool::math::maxList to accomplish this.
Argument: args	list of numbers to search the maximum in.
Returns: Maximum element in args.

::pool::math::min (x y)
Argument: x	First number to check
Argument: y	Second number to check
Returns: Minimum of x and y.

::pool::math::minList (list)
Determines the minimum number contained in list.
Argument: list	list of numbers to search the minimum in.
Returns: Minimum element in list.

::pool::math::minVarargs (args)
Determines the minimum of an arbitrary number of arguments. Uses ::pool::math::minList to accomplish this.
Argument: args	list of numbers to search the minimum in.
Returns: Minimum element in args.

::pool::math::setMax (varName value)
by Brent Welch
Set the variable varName to the maximum of its current and the specified value.
Argument: varName	The name of the variable to maximize.
Argument: value	The value to compare against.
Returns: 1 if the value of the variable, 0 else.

::pool::math::setMin (varName value)
by Brent Welch
Set the variable varName to the minimum of its current and the specified value.
Argument: varName	The name of the variable to minimize.
Argument: value	The value to compare against.
Returns: 1 if the value of the variable, 0 else.