- NAME
- mathop - Mathematical operators as Tcl commands
- SYNOPSIS
- DESCRIPTION
- ~ number
- ! number
- + ?number ...?
- - number ?number ...?
- * ?number ...?
- / number ?number ...?
- % number number
- ** ?number ...?
- & ?number ...?
- | ?number ...?
- << number number
- >> number number
- == ?arg ...?
- eq ?arg ...?
- != arg arg
- ne arg arg
- < ?arg ...?
- <= ?arg ...?
- > ?arg ...?
- >= ?arg ...?
- in arg list
- ni arg list
- EXAMPLES
- SEE ALSO
- KEYWORDS
mathop - Mathematical operators as Tcl commands
package require Tcl 8.5
::tcl::mathop::! number
::tcl::mathop::~ number
::tcl::mathop::+ ?number ...?
::tcl::mathop::- number ?number ...?
::tcl::mathop::* ?number ...?
::tcl::mathop::/ number ?number ...?
::tcl::mathop::% number number
::tcl::mathop::** ?number ...?
::tcl::mathop::& ?number ...?
::tcl::mathop::| ?number ...?
::tcl::mathop::^ ?number ...?
::tcl::mathop::<< number number
::tcl::mathop::>> number number
::tcl::mathop::== ?arg ...?
::tcl::mathop::!= arg arg
::tcl::mathop::< ?arg ...?
::tcl::mathop::<= ?arg ...?
::tcl::mathop::>= ?arg ...?
::tcl::mathop::> ?arg ...?
::tcl::mathop::eq ?arg ...?
::tcl::mathop::ne arg arg
::tcl::mathop::in arg list
::tcl::mathop::ni arg list
The commands in the ::tcl::mathop namespace implement the same set of
operations as supported by the expr command. All are exported from the
namespace, but are not imported into any other namespace by default. Note that
renaming, reimplementing or deleting any of the commands in the namespace does
not alter the way that the expr command behaves, and nor does
defining any new commands in the ::tcl::mathop namespace.
The following operator commands are supported:
~ | ! | + | - | * |
/ | % | ** | & | | |
^ | >> | << | == | eq |
!= | ne | < | <= | > |
>= | in | ni |
The behaviors of the operator commands are as follows:
- ~ number
-
Returns the bit-wise negation of number. Number may be an integer
of any size.
- ! number
-
Returns the boolean negation of number. Number may be any numeric
value or any other form of boolean value.
- + ?number ...?
-
Returns the sum of arbitrarily many arguments. Each number may be any
numeric value. If no arguments are given, the result will be zero.
- - number ?number ...?
-
Returns the either the negation of the first argument (if only one argument is
given) or the result of subtracting arbitrarily many additional arguments from
the first argument. Each number may be any numeric value. At least one
argument must be given.
- * ?number ...?
-
Returns the product of arbitrarily many arguments. Each number may be
any numeric value. If no arguments are given, the result will be one.
- / number ?number ...?
-
Returns the either the reciprocal of the first argument (if only one argument
is given) or the result of dividing the first argument by arbitrarily many
additional arguments. Each number may be any numeric value. At least one
argument must be given.
- % number number
-
Returns the integral modulus of the first argument with respect to the second.
Each number must have an integral value. Note that Tcl defines this
operation exactly even for negative numbers, so that the following equality
holds true:
(x / y) * y == x - (x % y)
- ** ?number ...?
-
Returns the result of raising each value to the power of the result of
recursively operating on the result of processing the following arguments, so
“** 2 3 4”
is the same as
“** 2 [** 3 4]”.
Each number may be
any numeric value, though the second number must not be fractional if the
first is negative. If no arguments are given, the result will be one, and if
only one argument is given, the result will be that argument. The
result will have an integral value only when all arguments are
integral values.
- & ?number ...?
-
Returns the bit-wise AND of each of the arbitrarily many arguments. Each
number must have an integral value. If no arguments are given, the
result will be minus one.
- | ?number ...?
-
Returns the bit-wise OR of each of the arbitrarily many arguments. Each
number must have an integral value. If no arguments are given, the
result will be zero..TP
^ ?number ...?
Returns the bit-wise XOR of each of the arbitrarily many arguments. Each
number must have an integral value. If no arguments are given, the
result will be zero.
- << number number
-
Returns the result of bit-wise shifting the first argument left by the
number of bits specified in the second argument. Each number
must have an integral value.
- >> number number
-
Returns the result of bit-wise shifting the first argument right by
the number of bits specified in the second argument. Each number
must have an integral value.
- == ?arg ...?
-
Returns whether each argument is equal to the arguments on each side of it in
the sense of the expr == operator (i.e., numeric comparison if
possible, exact string comparison otherwise). If fewer than two arguments
are given, this operation always returns a true value.
- eq ?arg ...?
-
Returns whether each argument is equal to the arguments on each side of it
using exact string comparison. If fewer than two arguments are given, this
operation always returns a true value.
- != arg arg
-
Returns whether the two arguments are not equal to each other, in the sense of
the expr != operator (i.e., numeric comparison if possible).
- ne arg arg
-
Returns whether the two arguments are not equal to each other using exact
string comparison.
- < ?arg ...?
-
Returns whether the arbitrarily-many arguments are ordered, with each argument
after the first having to be strictly more than the one preceding it.
Comparisons are performed preferentially on the numeric values. If fewer than
two arguments are present, this operation always returns a true value.
- <= ?arg ...?
-
Returns whether the arbitrarily-many arguments are ordered, with each argument
after the first having to be equal to or more than the one preceding it.
Comparisons are performed preferentially on the numeric values. If fewer than
two arguments are present, this operation always returns a true value.
- > ?arg ...?
-
Returns whether the arbitrarily-many arguments are ordered, with each argument
after the first having to be strictly less than the one preceding it.
Comparisons are performed preferentially on the numeric values. If fewer than
two arguments are present, this operation always returns a true value.
- >= ?arg ...?
-
Returns whether the arbitrarily-many arguments are ordered, with each argument
after the first having to be equal to or less than the one preceding it.
Comparisons are performed preferentially on the numeric values. If fewer than
two arguments are present, this operation always returns a true value.
- in arg list
-
Returns whether the value arg is present in the list list.
- ni arg list
-
Returns whether the value arg is not present in the list list.
The simplest way to use the operators is often by using namespace path
to make the commands available. This has the advantage of not affecting the
set of commands defined by the current namespace.
namespace path {::tcl::mathop ::tcl::mathfunc}
# Compute the sum of some numbers
set sum [+ 1 2 3]
# Compute the average of a list
set list {1 2 3 4 5 6}
set mean [/ [+ {*}$list] [double [llength $list]]]
# Test for list membership
set gotIt [in 3 $list]
# Test to see if a value is within some defined range
set inRange [<= 1 $x 5]
# Test to see if a list is sorted
set sorted [<= {*}$list]
expr, mathfunc, namespace
command, expression, operator
Copyright © 1995-1997 Roger E. Critchlow Jr.