Revision as of 18:52, 12 August 2018

$calc can be used to perform mathematical calculations from the mIRC editbox line, or from inside of a custom script.

Synopsis

$calc(operations)

The $calc identifier adheres to mathematical standards set forth by the PE(MD)(AS) order of operations, but also includes Floor Divide and Modulo. Therefore, a combination of brackets and parentheses can be used in order to manipulate the order of operations or to make a mix of operators easier to view. $calc can also be used to calculate variables in mIRC, as well as other custom identifiers that return numerical values.

Parameters

operationsThese are a specific set of mathematical operations for $calc to perform.

Operators

When parenthesis are not used to override the order of evaluation, these are the operators and the order in which they are used in calculating the result:

^1. Exponent

//2. Floor division, same as $floor($calc(X / Y))

%3. Modulus (remainder when dividing X / Y )

*4. Multiplication

/4. Division

+5. Addition

-5. Subtraction

Parenthesis used to demonstrate the order:

//echo -a $calc( 99 // 4 ^ .5 % 11 * 2 + 1) is same as $calc( ((( 99 // (4 ^ .5))  % 11) * 2) + 1)

Examples

Echo a simple addition calculation to the active window

//echo -a $calc(3 + 5)

Echo a manipulated order of operations calculation to the active window

//echo -a $calc(3 * 4 * (3 + 5)))

Note that the extra closing parenthesis doesn't cause an error, but best practice is to avoid this, because future versions may not be as forgiving.

Echo the remainder of the calculation, by invoking the modulus operator, to the active window

//echo -a $calc(10 % 3)

Create a simple alias to take in two parameters, then raise the first to the power of the second, and return the value

alias power {
 
  ; Make sure both inputs are numbers
  if (($1 isnum) && ($2 isnum)) {
    return $calc($1 ^ $2)
  }
}

The above $power alias can now be used like so:

//echo -a $power(5,2)

The result of the above command would be:

25

Modulus of N1/N2 is often seen as a number 0 through N2 less 1, but that applies only to integers. It's the remainder (not the fraction) when dividing the numerator by the denominator.
//var %x -10 , %y 3.14 | echo -a $calc(%x - %y * $int($calc( %x / %y))) vs $calc(%x % %y)
* Shows -0.58 vs -0.58
 
Order of Operation PEMDAS means Multiplication and Division are applied at the same time, as do Addition and subtraction together. It does not mean doing all multiplications before any divisions, nor doing all additions before doing any subtractions.
 
//echo -a $calc( 2 / 4 * 5 )
yields 2.5 because it goes left-to-right performing multiplies and divides. It divides 2/4 to obtain 0.5 before multiplying by 5, not multipling 4*5 before dividing that into 2.
//echo -a $calc( 2 - 3 + 5 )
yields 4 because it goes left-to-right performing adds and subtracts. It subtracts 3 from 2 = -1, then adds 5.
 
//echo -a $calc(  -2^8*3-1 )
//echo -a $calc( 0-2^8*3-1 )
produce 2 different answers because the presence of the 0 changes the meaning of the hyphen. In the 1st example it's -2 to the 8th power which is +256. That's then multiplied by 3, before having 1 subtracted from it. In the 2nd example, it starts by taking 2 to the 8th power, then multiplying by 3 to obtain the 2nd term 768. Then it starts with zero, subtracts the 768, then subtracts another 1.

Limits and Quirks

Integers outside the range -2^53 through +2^53 lose precision. Some of those 53 bits are used by the fraction, so adding a fraction shrinks the range where $calc returns accurate results.
 
//echo -a $calc(9007199254740992 + 1) and $calc(9007199254740993) both return 9007199254740992
//echo -a $calc(4294967296.000031) returns 4294967296.000032
//echo -a $calc(9007199254740993) vs $calc(900719925474099.3) returns 9007199254740992 vs 900719925474099.25
 
$calc has reduced accuracy for larger integers, and even lower accuracy for fractions of lower numbers. This inaccuracy is often reflected in other identifiers which use same stored values used by $calc.
 
For example, $base can't be trusted to be accurate when handling values larger than 2^53.
//echo -a $base($str(f,14),16,16) returns 100000000000000
 
if() can sometimes return inaccurate results for values larger than 2^53. For example, this executes as if $true:
//if (18014398509481984 == 18014398509481985) echo match
 
$calc limits output to 6 decimals, with trailing zeroes dropped.
//echo -a $pi vs $calc($pi)
 
//echo -a $calc( 123 + 1abc + 2def )
$calc stops processing when it encounters non-numerics, so this undocumented feature has often been used to strip text labels attached to a number:
//var %a $md5(abc) | echo -a %a vs $calc(%a) returns 900150983cd24fb0d6963f7d28e17f72 vs 900150983
 
//echo -a $calc( number + text ) returns number
//echo -a $calc( text + number ) returns 0
//var %a | echo -a $calc($1) vs $calc(%a) vs $calc($null) all evaluate to 0 when %var or $identifier is null
 
You can use [ ] to force evaluation out of the normal order, but $calc has problems handling $+ as shown by:
//echo -a $calc( 123 + 1 $+ 23 + 456 ) vs $calc( 123 + ( 1 $+ 23 ) ) vs $calc( 123 + $+ + 456 )
In the first example, it causes everything after the $+ to be ignored, as if $+ is a text string with no special meaning except when preceded and followed by operators.
//echo -a $calc( 5 ^ $+ + .1)
 
When the $+ is inside additional parenthesis, the entire result is zero:
//echo -a s $calc( 123 + ( 1 $+ 23 ) )

See also the $calc section at msl_injection#$calc()

Compatability

Added: mIRC v5.1
Added on: 28 Aug 1997
Note: Unless otherwise stated, this was the date of original functionality.
Further enhancements may have been made in later versions.

See Also

• $base
• $abs, $int, $ceil, $floor, $round
• $and, $not, $or, $xor
• $sqrt
• $pi
• $rand
• $log, $log10
• $sin, $asin, $sinh
• $cos, $acos, $cosh
• $tan, $atan, $atan2, $tanh
• $biton, $bitoff, $isbit
• $hypot, $intersect
• $inrect, $inroundrect, $inellipse, $inpoly, $onpoly,