Provided by: tcl8.6-doc_8.6.1-4ubuntu1_all

**NAME**

mathop - Mathematical operators as Tcl commands

**SYNOPSIS**

package requireTcl8.5::tcl::mathop::!number::tcl::mathop::~number::tcl::mathop::+?number...?::tcl::mathop::-number?number...?::tcl::mathop::*?number...?::tcl::mathop::/number?number...?::tcl::mathop::%numbernumber::tcl::mathop::**?number...?::tcl::mathop::&?number...?::tcl::mathop::|?number...?::tcl::mathop::^?number...?::tcl::mathop::<<numbernumber::tcl::mathop::>>numbernumber::tcl::mathop::==?arg...?::tcl::mathop::!=argarg::tcl::mathop::<?arg...?::tcl::mathop::<=?arg...?::tcl::mathop::>=?arg...?::tcl::mathop::>?arg...?::tcl::mathop::eq?arg...?::tcl::mathop::neargarg::tcl::mathop::inarglist::tcl::mathop::niarglist_________________________________________________________________

**DESCRIPTION**

The commands in the::tcl::mathopnamespace implement the same set of operations as supported by theexprcommand. 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 doesnotalter the way that theexprcommand behaves, and nor does defining any new commands in the::tcl::mathopnamespace. The following operator commands are supported:~!+-*/%**&|^>><<==eq!=ne<<=>>=inniMATHEMATICALOPERATORSThe behaviors of the mathematical operator commands are as follows:!booleanReturns the boolean negation ofboolean, wherebooleanmay be any numeric value or any other form of boolean value (i.e. it returns truth if the argument is falsity or zero, and falsity if the argument is truth or non-zero).+?number...? Returns the sum of arbitrarily many arguments. Eachnumberargument may be any numeric value. If no arguments are given, the result will be zero (the summation identity).-number?number...? If only a singlenumberargument is given, returns the negation of that numeric value. Otherwise returns the number that results when all subsequent numeric values are subtracted from the first one. Allnumberarguments must be numeric values. At least one argument must be given.*?number...? Returns the product of arbitrarily many arguments. Eachnumbermay be any numeric value. If no arguments are given, the result will be one (the multiplicative identity)./number?number...? If only a singlenumberargument is given, returns the reciprocal of that numeric value (i.e. the value obtained by dividing 1.0 by that value). Otherwise returns the number that results when the first numeric argument is divided by all subsequent numeric arguments. Allnumberarguments must be numeric values. At least one argument must be given. Note that when the leading values in the list of arguments are integers, integer division will be used for those initial steps (i.e. the intermediate results will be as if the functionsfloorandintare applied to them, in that order). If all values in the operation are integers, the result will be an integer.%numbernumberReturns the integral modulus (i.e., remainder) of the first argument with respect to the second. Eachnumbermust have an integral value. Also, the sign of the result will be the same as the sign of the secondnumber, which must not be zero. Note that Tcl defines this operation exactly even for negative numbers, so that the following command returns a true value (omitting the namespace for clarity):==[*[/xy]y] [-x[%xy]]**?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 “**234” is the same as “**2[**34]”. Eachnumbermay 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.COMPARISONOPERATORSThe behaviors of the comparison operator commands (most of which operate preferentially on numeric arguments) are as follows:==?arg...? Returns whether each argument is equal to the arguments on each side of it in the sense of theexpr== 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.!=argargReturns whether the two arguments are not equal to each other, in the sense of theexpr!= operator (i.e., numeric comparison if possible, exact string comparison otherwise).neargargReturns 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, and are otherwise performed using UNICODE string comparison. If fewer than two arguments are present, this operation always returns a true value. When the arguments are numeric but should be compared as strings, thestringcomparecommand should be used instead.<=?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, and are otherwise performed using UNICODE string comparison. If fewer than two arguments are present, this operation always returns a true value. When the arguments are numeric but should be compared as strings, thestringcomparecommand should be used instead.>?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, and are otherwise performed using UNICODE string comparison. If fewer than two arguments are present, this operation always returns a true value. When the arguments are numeric but should be compared as strings, thestringcomparecommand should be used instead.>=?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, and are otherwise performed using UNICODE string comparison. If fewer than two arguments are present, this operation always returns a true value. When the arguments are numeric but should be compared as strings, thestringcomparecommand should be used instead.BIT-WISEOPERATORSThe behaviors of the bit-wise operator commands (all of which only operate on integral arguments) are as follows:~numberReturns the bit-wise negation ofnumber.Numbermay be an integer of any size. Note that the result of this operation will always have the opposite sign to the inputnumber.&?number...? Returns the bit-wise AND of each of the arbitrarily many arguments. Eachnumbermust 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. Eachnumbermust have an integral value. If no arguments are given, the result will be zero.^?number...? Returns the bit-wise XOR of each of the arbitrarily many arguments. Eachnumbermust have an integral value. If no arguments are given, the result will be zero.<<numbernumberReturns the result of bit-wise shifting the first argument left by the number of bits specified in the second argument. Eachnumbermust have an integral value.>>numbernumberReturns the result of bit-wise shifting the first argument right by the number of bits specified in the second argument. Eachnumbermust have an integral value.LISTOPERATORSThe behaviors of the list-oriented operator commands are as follows:inarglistReturns whether the valueargis present in the listlist(according to exact string comparison of elements).niarglistReturns whether the valueargis not present in the listlist(according to exact string comparison of elements).

**EXAMPLES**

The simplest way to use the operators is often by usingnamespacepathto 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}#Computethesumofsomenumbersset sum [+1 2 3]#Computetheaverageofalistset list {1 2 3 4 5 6} set mean [/[+{*}$list] [double [llength $list]]]#Testforlistmembershipset gotIt [in3 $list]#Testtoseeifavalueiswithinsomedefinedrangeset inRange [<=1 $x 5]#Testtoseeifalistissortedset sorted [<={*}$list]

**SEE** **ALSO**

expr(3tcl), mathfunc(3tcl), namespace(3tcl)

**KEYWORDS**

command, expression, operator