Module:Utils/doc: Difference between revisions

Line 9:

: Removes leading and trailing whitespaces (but not interior ones) from a string.

; <code>table_contains(tbl, x)</code>*

; <code>table_contains(tbl, x)</code>*

: Check if table contains x.

; <code>index_of(array, index)</code>*

; <code>index_of(array, index)</code>*

: Return the first index with the given value (or nil if not found).

Line 21:

: Checks if <code>input</code> is a number; on error, use <code>def_value</code>.

; <code>log(x, b)</code>

; <code>log(x, b)</code>

: Returns the logarithm base <code>b</code> of <code>x</code>. Parameter <code>b</code> defaults to base 2 (octave) if it is omitted.

; <code>gcd(a, b)</code>

; <code>gcd(a, b)</code>

: Returns the greatest common divisor of <code>a</code> and <code>b</code>.

; <code>round_dec(x, places)</code>

; <code>round_dec(x, places)</code>

: Returns <code>x</code> rounded to a precision of <code>places</code> decimal places. Parameter <code>places</code> defaults to 0 if it is omitted.

; <code>round(x, prec)</code>

; <code>round(x, prec)</code>

: Returns <code>x</code> rounded to a precision of <code>prec</code> significant figures. Parameter <code>prec</code> defaults to 6 if it is omitted.

Line 46:

; <code>next_young_diagram(d)</code>

: Returns the next Young diagram of the same size; the first one is <code>[N]</code>, the last one is <code>[1, 1, ..., 1]</code>. After the last one, <code>nil</code> is returned. The input table is modified.~~<br /><br />~~

: Returns the next Young diagram of the same size; the first one is <code>[N]</code>, the last one is <code>[1, 1, ..., 1]</code>. After the last one, <code>nil</code> is returned. The input table is modified.

<nowiki />* These functions are designed to be used by other modules only; they cannot be called with <code>{{<nowiki />#invoke:}}</code>.

<nowiki />* These functions are designed to be used by other modules only; they cannot be called with <code>{{<nowiki />#invoke: }}</code>.

}}

@@ Line 9: / Line 9: @@
 : Removes leading and trailing whitespaces (but not interior ones) from a string.
-; <code>table_contains(tbl, x)</code>*
+; <code>table_contains(tbl,&nbsp;x)</code>*
 : Check if table contains x.
-; <code>index_of(array, index)</code>*
+; <code>index_of(array,&nbsp;index)</code>*
 : Return the first index with the given value (or nil if not found).
@@ Line 21: / Line 21: @@
 : Checks if <code>input</code> is a number; on error, use <code>def_value</code>.
-; <code>log(x, b)</code>
+; <code>log(x,&nbsp;b)</code>
 : Returns the logarithm base <code>b</code> of <code>x</code>. Parameter <code>b</code> defaults to base 2 (octave) if it is omitted.
-; <code>gcd(a, b)</code>
+; <code>gcd(a,&nbsp;b)</code>
 : Returns the greatest common divisor of <code>a</code> and <code>b</code>.
-; <code>round_dec(x, places)</code>
+; <code>round_dec(x,&nbsp;places)</code>
 : Returns <code>x</code> rounded to a precision of <code>places</code> decimal places. Parameter <code>places</code> defaults to 0 if it is omitted.
-; <code>round(x, prec)</code>
+; <code>round(x,&nbsp;prec)</code>
 : Returns <code>x</code> rounded to a precision of <code>prec</code> significant figures. Parameter <code>prec</code> defaults to 6 if it is omitted.
@@ Line 46: / Line 46: @@
 ; <code>next_young_diagram(d)</code>
-: Returns the next Young diagram of the same size; the first one is <code>[N]</code>, the last one is <code>[1, 1, ..., 1]</code>. After the last one, <code>nil</code> is returned. The input table is modified.<br /><br />
+: Returns the next Young diagram of the same size; the first one is <code>[N]</code>, the last one is <code>[1, 1, ..., 1]</code>. After the last one, <code>nil</code> is returned. The input table is modified.
-<nowiki />* These functions are designed to be used by other modules only; they cannot be called with <code>{{<nowiki />#invoke:}}</code>.
+<nowiki />* These functions are designed to be used by other modules only; they cannot be called with <code>{{<nowiki />#invoke:&nbsp;}}</code>.
 }}