====== sub ======

===== Description =====

Subtract one number from another.

===== Function prototype =====

<code>
variant sub <variant:arg1> <variant:arg2>
</code>


===== Arguments =====

^  Name  ^  Type  ^ Comment ^
|  //arg1//  |  variant  | A number. |
|  //arg2//  |  variant  | The number to be subtracted from //arg1//. |

<note important>
If the type of //arg1// is not equal to that of //arg2//, the ordering of the arguments may change the result of calls to ''sub''. See comments for [[plugins:general:zeoscript:reference:functions:add]].
</note>

===== Return value =====

The value of //arg1// minus //arg2//, in the data type of //arg1//.

===== Example =====

<code>
echo <zs:sub 9.5 3>
</code>

... the output of which is written to the event log by [[plugins:general:zeoscript:reference:functions:echo]] as:

<file>
6.5
</file>

===== Comments =====

None.

===== See also =====

  * [[plugins:general:zeoscript:reference:functions:add]]
  * [[plugins:general:zeoscript:reference:functions:mul]]
  * [[plugins:general:zeoscript:reference:functions:div]]
  * [[plugins:general:zeoscript:reference:functions:mod]]
  * [[plugins:general:zeoscript:reference:functions:incr]]
  * [[plugins:general:zeoscript:reference:functions:decr]]