View source for Template:Order of magnitude/doc

{{Documentation subpage}}
{{high-risk|160,000+}}

===Usage===
This template calculates the (decimal) [[order of magnitude]] of numbers within the ranges 10<sup>300</sup> to 10<sup>−300</sup> and −10<sup>−300</sup> to −10<sup>300</sup>.

The acceptable input and the output produced are optimised for use in other templates. 
*The hyphen (not a true minus sign) is used for negative numbers.
*No separator is used for thousands. 
*The template gives 0 for 0.  Although, strictly speaking, this is mathematically incorrect it has been designed this way so as to be more useful in other templates.  An important example of this is that when used by {{tl|convert}} 0&nbsp;°C or 0&nbsp;°F is considered to be on the same order of magnitude as ±1&nbsp;°C or ±1&nbsp;°F respectively.

===Examples===
*{{Xpdop3c|d=|Order of magnitude|123400}}
*{{Xpdop3c|d=|Order of magnitude|12340}}
*{{Xpdop3c|d=|Order of magnitude|1234}}
*{{Xpdop3c|d=|Order of magnitude|123.4}}
*{{Xpdop3c|d=|Order of magnitude|12.34}}
*{{Xpdop3c|d=|Order of magnitude|1.234}}
*{{Xpdop3c|d=|Order of magnitude|.1234}}
*{{Xpdop3c|d=|Order of magnitude|.01234}}
*{{Xpdop3c|d=|Order of magnitude|0}}
*{{Xpdoc|d=|Order of magnitude}}

===Incorrect usage===
The input must be an unformatted number, or the template will emit errors:
*<code><nowiki>{{Order of magnitude|}}</nowiki></code> → <strong class="error">Expression error: Unexpected = operator</strong>
*<code><nowiki>{{Order of magnitude|123,400}}</nowiki></code> → <strong class="error">Expression error: Unrecognised punctuation character ","</strong>
*<code><nowiki>{{Order of magnitude|foo}}</nowiki></code> → <strong class="error">Expression error: Unrecognised word "foo"</strong>

===Technical points===
This template calculates the order of magnitude of a number, using the [[natural logarithm]] of the absolute value of the number, divided by the log of 10. The amount is adjusted for [[truncation error]] in the digital format, and the floor number of the results is used. The magnitude of fractions, such as 0+1/1000 (-3), will also be calculated.  The code uses four expansion-depth levels.

===Template data===
{{TemplateDataHeader}}
<templatedata>{
"description": "This template calculates the order of magnitude of numbers within the ranges 10^300 to 10^−300 and −10^−300 to −10^300.",
"params": {
  "1": {
    "label": "Number",
    "description": "The number to find the order of magnitude of",
    "type": "number",
    "required": true
  }
}}</templatedata>
<includeonly>{{Sandbox other||
[[Category:Mathematical function templates|Order of magnitude]]

}}</includeonly>