FloatToString (Float function) - Revision history

JAL: /* Usage notes */

2012-11-02T17:53:17Z

Usage notes

← Older revision		Revision as of 17:53, 2 November 2012
Line 35:		Line 35:
	<li>To produce the specified length or number of decimal places in the result, <var>FloatToString</var> uses truncation, not rounding, of the input, as you can see in the last two of the PrintText statements in the example below.		<li>To produce the specified length or number of decimal places in the result, <var>FloatToString</var> uses truncation, not rounding, of the input, as you can see in the last two of the PrintText statements in the example below.

	<li><var>FloatToString</var> is available as of <var class="product">~~Sirius Mods\|~~Sirius Mods</var> Version 7.6.</ul>		<li><var>FloatToString</var> is available as of <var class="product">Sirius Mods</var> Version 7.6.</ul>

	==Examples==		==Examples==

JAL at 17:44, 2 November 2012

2012-11-02T17:44:45Z

← Older revision		Revision as of 17:44, 2 November 2012
Line 1:		Line 1:
	{{Template:Float:FloatToString subtitle}}		{{Template:Float:FloatToString subtitle}}

	The <var>FloatToString</~~var> <~~var>[[Intrinsic classes\|intrinsic]]~~</var>~~ function converts a floating point number to a string with a specific length and number of decimal places.		The <var>FloatToString</var> [[Intrinsic classes\|intrinsic]] function converts a floating point number to a string with a specific length and number of decimal places.

	==Syntax==		==Syntax==
	{{Template:Float:FloatToString syntax}}		{{Template:Float:FloatToString syntax}}

	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%string</th>		<tr><th>%string</th>
	<td>A string variable to receive the converted value of the method object number.</td></tr>		<td>A string variable to receive the converted value of the method object number.</td></tr>

	<tr><th>float</th>		<tr><th>float</th>
	<td>The (input) method object <var>float</var> value that will be converted to the output <var class="term">%string</var>.</td></tr>		<td>The (input) method object <var>float</var> value that will be converted to the output <var class="term">%string</var>.</td></tr>

	<tr><th><var>Length</var></th>		<tr><th><var>Length</var></th>
	<td>This is an optional, but ~~<var class="term">nameRequired</var>~~, parameter which specifies the output string length. The <i>number</i> value must be between 1 and 255, and it defaults to the minimum length required to represent the number.</td></tr>		<td>This is an optional, but [[Notation conventions for methods#Named parameters\|name required]], parameter which specifies the output string length. The <i>number</i> value must be between 1 and 255, and it defaults to the minimum length required to represent the number.</td></tr>

	<tr><th><var>DP</var></th>		<tr><th><var>DP</var></th>
	<td>This is an optional, but <var class="term">nameRequired</var>, parameter which specifies the number of decimal places in the result. The <i>number</i> value defaults to 0, must be between 0 and 75, and must be less than any <var>Length</var> parameter specified.</td></tr>		<td>This is an optional, but <var class="term">nameRequired</var>, parameter which specifies the number of decimal places in the result. The <i>number</i> value defaults to 0, must be between 0 and 75, and must be less than any <var>Length</var> parameter specified.</td></tr>
Line 18:		Line 22:

	==Usage notes==		==Usage notes==
	<ul><li>If the target length and number of decimal places would result in leading non-zero digits being lost, the request is canceled. For example, specifying the following results in request cancellation:		<ul>
			<li>If the target length and number of decimal places would result in leading non-zero digits being lost, the request is canceled. For example, specifying the following results in request cancellation:
	<p class="code">13.1415926:FloatToString(length=6, dp=4)		<p class="code">13.1415926:FloatToString(length=6, dp=4)
	</p>		</p>

	<li><var>FloatToString</var> neatly displays non-integer numeric values. <var>[[Round_(Float_function)\|Round]]</var> is not a good way of doing this, since <var>Round</var> returns a <var>Float</var> value and strips trailing 0s when printing the value.		<li><var>FloatToString</var> neatly displays non-integer numeric values. <var>[[Round_(Float_function)\|Round]]</var> is not a good way of doing this, since <var>Round</var> returns a <var>Float</var> value and strips trailing 0s when printing the value.

	<li><var>FloatToString</var> currently does not support E format (9.9E72) output.		<li><var>FloatToString</var> currently does not support E format (9.9E72) output.

	<li>A <var>DP</var> value of 0 has a special result: no decimal point. There is no way to get a trailing decimal point without any digits after it unless you explicitly append a point character ('<code>.</code>') to a result for which <code>DP=0</code> is specified, as is shown in the last of the <var>[[PrintText statement\|PrintText]]</var> statements in the example below, you <b><i>can</i></b> get a value with a leading decimal point and no digit before it.		<li>A <var>DP</var> value of 0 has a special result: no decimal point. There is no way to get a trailing decimal point without any digits after it unless you explicitly append a point character ('<code>.</code>') to a result for which <code>DP=0</code> is specified, as is shown in the last of the <var>[[PrintText statement\|PrintText]]</var> statements in the example below, you <b><i>can</i></b> get a value with a leading decimal point and no digit before it.

	<li>To produce the specified length or number of decimal places in the result, <var>FloatToString</var> uses truncation, not rounding, of the input, as you can see in the last two of the PrintText statements in the example below.		<li>To produce the specified length or number of decimal places in the result, <var>FloatToString</var> uses truncation, not rounding, of the input, as you can see in the last two of the PrintText statements in the example below.
	<li><var>FloatToString</var> is available as of <var class="product">[[Sirius Mods\|Sirius Mods]]</var> Version 7.6.</ul>
			<li><var>FloatToString</var> is available as of <var class="product">Sirius Mods\|Sirius Mods</var> Version 7.6.</ul>

	==Examples==		==Examples==

JAL2 at 21:23, 7 August 2012

2012-08-07T21:23:44Z

← Older revision		Revision as of 21:23, 7 August 2012
Line 14:		Line 14:
	<td>This is an optional, but <var class="term">nameRequired</var>, parameter which specifies the output string length. The <i>number</i> value must be between 1 and 255, and it defaults to the minimum length required to represent the number.</td></tr>		<td>This is an optional, but <var class="term">nameRequired</var>, parameter which specifies the output string length. The <i>number</i> value must be between 1 and 255, and it defaults to the minimum length required to represent the number.</td></tr>
	<tr><th><var>DP</var></th>		<tr><th><var>DP</var></th>
	<td>This is an optional, but <var class="term">nameRequired</var>, parameter which specifies the number of decimal places in the result. The <i>number</i> value defaults to 0, must be between 0 and 75, and must be less than any <var ~~class="term"~~>Length</var> parameter specified.</td></tr>		<td>This is an optional, but <var class="term">nameRequired</var>, parameter which specifies the number of decimal places in the result. The <i>number</i> value defaults to 0, must be between 0 and 75, and must be less than any <var>Length</var> parameter specified.</td></tr>
	</table>		</table>

Line 23:		Line 23:
	<li><var>FloatToString</var> neatly displays non-integer numeric values. <var>[[Round_(Float_function)\|Round]]</var> is not a good way of doing this, since <var>Round</var> returns a <var>Float</var> value and strips trailing 0s when printing the value.		<li><var>FloatToString</var> neatly displays non-integer numeric values. <var>[[Round_(Float_function)\|Round]]</var> is not a good way of doing this, since <var>Round</var> returns a <var>Float</var> value and strips trailing 0s when printing the value.
	<li><var>FloatToString</var> currently does not support E format (9.9E72) output.		<li><var>FloatToString</var> currently does not support E format (9.9E72) output.
	<li>A <var ~~class="term"~~>DP</var> value of 0 has a special result: no decimal point. There is no way to get a trailing decimal point without any digits after it unless you explicitly append a point character ('<code>.</code>') to a result for which <~~var class="term"~~>DP</~~var~~>=0 is specified, as is shown in the last of the <var>[[PrintText statement\|PrintText]]</var> statements in the example below, you <b><i>can</i></b> get a value with a leading decimal point and no digit before it.		<li>A <var>DP</var> value of 0 has a special result: no decimal point. There is no way to get a trailing decimal point without any digits after it unless you explicitly append a point character ('<code>.</code>') to a result for which <code>DP=0</code> is specified, as is shown in the last of the <var>[[PrintText statement\|PrintText]]</var> statements in the example below, you <b><i>can</i></b> get a value with a leading decimal point and no digit before it.
	<li>To produce the specified length or number of decimal places in the result, <var>FloatToString</var> uses truncation, not rounding, of the input, as you can see in the last two of the PrintText statements in the example below.		<li>To produce the specified length or number of decimal places in the result, <var>FloatToString</var> uses truncation, not rounding, of the input, as you can see in the last two of the PrintText statements in the example below.
	<li><var>FloatToString</var> is available as of <var class="product">[[Sirius Mods\|Sirius Mods]]</var> Version 7.6.</ul>		<li><var>FloatToString</var> is available as of <var class="product">[[Sirius Mods\|Sirius Mods]]</var> Version 7.6.</ul>

	==Examples==		==Examples==
	~~<ol><li>~~The following program demonstrates the <var>FloatToString</var> method.		The following program demonstrates the <var>FloatToString</var> method.
	<p class="code">begin		<p class="code">begin
	[[PrintText statement\|printText]] {~} = {0.1415926:floatToString}		[[PrintText statement\|printText]] {~} = {0.1415926:floatToString}
Line 49:		Line 49:
	0.1415926:floatToString(length=10, dp=4) = 0.1415		0.1415926:floatToString(length=10, dp=4) = 0.1415
	0.1415926:floatToString(length=5, dp=4) = .1415		0.1415926:floatToString(length=5, dp=4) = .1415
	</p~~></ol~~>		</p>

	==See also==		==See also==
	{{Template:Float:FloatToString footer}}		{{Template:Float:FloatToString footer}}

JALWiccan: 1 revision

2011-05-04T17:46:33Z

1 revision

← Older revision	Revision as of 17:46, 4 May 2011
(No difference)

JALWiccan: 1 revision

2011-05-04T17:46:32Z

1 revision

← Older revision		Revision as of 17:46, 4 May 2011
Line 25:		Line 25:
	<li>A <var class="term">DP</var> value of 0 has a special result: no decimal point. There is no way to get a trailing decimal point without any digits after it unless you explicitly append a point character ('<code>.</code>') to a result for which <var class="term">DP</var>=0 is specified, as is shown in the last of the <var>[[PrintText statement\|PrintText]]</var> statements in the example below, you <b><i>can</i></b> get a value with a leading decimal point and no digit before it.		<li>A <var class="term">DP</var> value of 0 has a special result: no decimal point. There is no way to get a trailing decimal point without any digits after it unless you explicitly append a point character ('<code>.</code>') to a result for which <var class="term">DP</var>=0 is specified, as is shown in the last of the <var>[[PrintText statement\|PrintText]]</var> statements in the example below, you <b><i>can</i></b> get a value with a leading decimal point and no digit before it.
	<li>To produce the specified length or number of decimal places in the result, <var>FloatToString</var> uses truncation, not rounding, of the input, as you can see in the last two of the PrintText statements in the example below.		<li>To produce the specified length or number of decimal places in the result, <var>FloatToString</var> uses truncation, not rounding, of the input, as you can see in the last two of the PrintText statements in the example below.
	<li><var>FloatToString</var> is available as of <var class="product">[[Sirius Mods\|"Sirius Mods"]]</var> Version 7.6.</ul>		<li><var>FloatToString</var> is available as of <var class="product">[[Sirius Mods\|Sirius Mods]]</var> Version 7.6.</ul>

	==Examples==		==Examples==

JALWiccan: 1 revision

2011-04-13T00:07:03Z

1 revision

← Older revision	Revision as of 00:07, 13 April 2011
(No difference)

Goff: printtext

2011-04-13T00:07:02Z

printtext

← Older revision		Revision as of 00:07, 13 April 2011
Line 11:		Line 11:
	<tr><th>float</th>		<tr><th>float</th>
	<td>The (input) method object <var>float</var> value that will be converted to the output <var class="term">%string</var>.</td></tr>		<td>The (input) method object <var>float</var> value that will be converted to the output <var class="term">%string</var>.</td></tr>
	<tr><th>Length</th>		<tr><th><var>Length</var></th>
	<td>This is an optional, but <var class="term">nameRequired</var>, parameter which specifies the output string length. The <i>number</i> value must be between 1 and 255, and it defaults to the minimum length required to represent the number.</td></tr>		<td>This is an optional, but <var class="term">nameRequired</var>, parameter which specifies the output string length. The <i>number</i> value must be between 1 and 255, and it defaults to the minimum length required to represent the number.</td></tr>
	<tr><th>DP</th>		<tr><th><var>DP</var></th>
	<td>This is an optional, but <var class="term">nameRequired</var>, parameter which specifies the number of decimal places in the result. The <i>number</i> value defaults to 0, must be between 0 and 75, and must be less than any <var class="term">Length</var> parameter specified.</td></tr>		<td>This is an optional, but <var class="term">nameRequired</var>, parameter which specifies the number of decimal places in the result. The <i>number</i> value defaults to 0, must be between 0 and 75, and must be less than any <var class="term">Length</var> parameter specified.</td></tr>
	</table>		</table>

Goff: printtext

2011-02-22T11:36:08Z

printtext

← Older revision		Revision as of 11:36, 22 February 2011
Line 25:		Line 25:
	<li>A <var class="term">DP</var> value of 0 has a special result: no decimal point. There is no way to get a trailing decimal point without any digits after it unless you explicitly append a point character ('<code>.</code>') to a result for which <var class="term">DP</var>=0 is specified, as is shown in the last of the <var>[[PrintText statement\|PrintText]]</var> statements in the example below, you <b><i>can</i></b> get a value with a leading decimal point and no digit before it.		<li>A <var class="term">DP</var> value of 0 has a special result: no decimal point. There is no way to get a trailing decimal point without any digits after it unless you explicitly append a point character ('<code>.</code>') to a result for which <var class="term">DP</var>=0 is specified, as is shown in the last of the <var>[[PrintText statement\|PrintText]]</var> statements in the example below, you <b><i>can</i></b> get a value with a leading decimal point and no digit before it.
	<li>To produce the specified length or number of decimal places in the result, <var>FloatToString</var> uses truncation, not rounding, of the input, as you can see in the last two of the PrintText statements in the example below.		<li>To produce the specified length or number of decimal places in the result, <var>FloatToString</var> uses truncation, not rounding, of the input, as you can see in the last two of the PrintText statements in the example below.
	<li><var>FloatToString</var> is available as of <var class="product">[[Sirius Mods]]</var> Version 7.6.</ul>		<li><var>FloatToString</var> is available as of <var class="product">[[Sirius Mods\|"Sirius Mods"]]</var> Version 7.6.</ul>

	==Examples==		==Examples==
	<ol><li>The following program demonstrates the <var>FloatToString</var> method.		<ol><li>The following program demonstrates the <var>FloatToString</var> method.
	<p class="code">begin		<p class="code">begin
	printText {~} = {0.1415926:floatToString}		[[PrintText statement\|printText]] {~} = {0.1415926:floatToString}
	printText {~} = {0.1415926:floatToString(dp=0)}		printText {~} = {0.1415926:floatToString(dp=0)}
	printText {~} = {0.1415926:floatToString(dp=1)}		printText {~} = {0.1415926:floatToString(dp=1)}
Line 52:		Line 52:

	==See also==		==See also==
	~~<ul><li>For details of the <var>printtext</var> statement, please see <var>[[Intrinsic classes#printtext\|printText]]</var>.~~
	~~</ul>~~
	{{Template:Float:FloatToString footer}}		{{Template:Float:FloatToString footer}}

Goff: match syntax diagram to revised template; fix tags and links

2011-02-03T07:17:27Z

match syntax diagram to revised template; fix tags and links

← Older revision		Revision as of 07:17, 3 February 2011
Line 1:		Line 1:
	{{Template:Float:FloatToString subtitle}}		{{Template:Float:FloatToString subtitle}}

	~~This~~ [[Intrinsic classes\|intrinsic]] function converts a floating point number to a string with a specific		The <var>FloatToString</var> <var>[[Intrinsic classes\|intrinsic]]</var> function converts a floating point number to a string with a specific length and number of decimal places.
	length and number of decimal places.

	~~The <var>FloatToString</var> function is available as of version 7.6 of the <var class=product>Sirius Mods</var>.~~
	==Syntax==		==Syntax==
	{{Template:Float:FloatToString syntax}}		{{Template:Float:FloatToString syntax}}
	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%~~str~~</th>		<tr><th>%string</th>
	<td>A string variable to receive the converted value of the method object number. </td></tr>		<td>A string variable to receive the converted value of the method object number.</td></tr>
	<tr><th>[Length~~=]len~~</th>		<tr><th>float</th>
	<td>This optional, ~~name-required~~, ~~argument (Length)~~ specifies the output string length. The ~~''len''~~ value must be between 1 and 255, and it defaults to the minimum length required to represent the number. </td></tr>		<td>The (input) method object <var>float</var> value that will be converted to the output <var class="term">%string</var>.</td></tr>
	<tr><th>~~[Dp=]num~~</th>		<tr><th>Length</th>
	<td>This optional, ~~name-required~~, ~~argument (Dp)~~ specifies the number of decimal places in the result. The ~~''num''~~ value defaults to 0, must be between 0 and 75, and must be less than ~~the~~ Length parameter ~~(if a Length value is~~ specified).</td></tr>		<td>This is an optional, but <var class="term">nameRequired</var>, parameter which specifies the output string length. The <i>number</i> value must be between 1 and 255, and it defaults to the minimum length required to represent the number.</td></tr>
			<tr><th>DP</th>
			<td>This is an optional, but <var class="term">nameRequired</var>, parameter which specifies the number of decimal places in the result. The <i>number</i> value defaults to 0, must be between 0 and 75, and must be less than any <var class="term">Length</var> parameter specified.</td></tr>
	</table>		</table>

	==Usage notes==		==Usage notes==
	If the target length and number of decimal places would result in leading		<ul><li>If the target length and number of decimal places would result in leading non-zero digits being lost, the request is canceled. For example, specifying the following results in request cancellation:
	non-zero digits being lost, the request is canceled.		<p class="code">13.1415926:FloatToString(length=6, dp=4)
	For example, specifying the following results in request cancellation:
	<p class="code">13.1415926:~~floatTo<var>String</var>~~(length=6, dp=4)

	</p>		</p>
	<var>FloatToString</var> neatly displays non-integer numeric values.		<li><var>FloatToString</var> neatly displays non-integer numeric values. <var>[[Round_(Float_function)\|Round]]</var> is not a good way of doing this, since <var>Round</var> returns a <var>Float</var> value and strips trailing 0s when printing the value.
	~~The Round method~~ (~~:hdref refid=flround.~~) is not a good way of doing this,		<li><var>FloatToString</var> currently does not support E format (9.9E72) output.
	since Round returns a <var>Float</var> value and strips trailing 0s when printing the value.		<li>A <var class="term">DP</var> value of 0 has a special result: no decimal point. There is no way to get a trailing decimal point without any digits after it unless you explicitly append a point character ('<code>.</code>') to a result for which <var class="term">DP</var>=0 is specified, as is shown in the last of the <var>[[PrintText statement\|PrintText]]</var> statements in the example below, you <b><i>can</i></b> get a value with a leading decimal point and no digit before it.
			<li>To produce the specified length or number of decimal places in the result, <var>FloatToString</var> uses truncation, not rounding, of the input, as you can see in the last two of the PrintText statements in the example below.
	<var>FloatToString</var> currently does not support E format (9.9E72) output.		<li><var>FloatToString</var> is available as of <var class="product">[[Sirius Mods]]</var> Version 7.6.</ul>

	A ~~''''Dp''''~~ value of 0 has a special result: no decimal point.
	There is no way to get a trailing decimal point without any
	digits after it unless you explicitly append a point character ('~~'''~~.~~'''~~')
	to a result for which ~~''''Dp~~=0~~''''~~ is specified, as is shown in the last of the [[PrintText statement\|PrintText]] statements in the example below,
	you ~~'''~~can~~'''~~ get a value with a leading decimal point and no digit before it.

	To produce the specified length or number of decimal places in the result,
	<var>FloatToString</var> uses truncation, not rounding, of the input, as you can see
	in the last two of the PrintText statements in the example below.

	==Examples==		==Examples==
	The following program demonstrates the <var>FloatToString</var> method.		<ol><li>The following program demonstrates the <var>FloatToString</var> method.
	<p class="code">begin		<p class="code">begin
	~~[[Intrinsic classes#printtext\|~~printText]] {~} = {0.1415926:floatToString}		printText {~} = {0.1415926:floatToString}
	printText {~} = {0.1415926:floatToString(dp=0)}		printText {~} = {0.1415926:floatToString(dp=0)}
	printText {~} = {0.1415926:floatToString(dp=1)}		printText {~} = {0.1415926:floatToString(dp=1)}
	printText {~} = {0.1415926:floatToString(dp=5)}		printText {~} = {0.1415926:floatToString(dp=5)}
	printText {~} = {0.1415926:floatToString(length=10)}		printText {~} = {0.1415926:floatToString(length=10)}
	printText {~} = {0.1415926:floatToString(length=10, dp=1)}		printText {~} = {0.1415926:floatToString(length=10, dp=1)}
	printText {~} = {0.1415926:floatToString(length=10, dp=4)}		printText {~} = {0.1415926:floatToString(length=10, dp=4)}
	printText {~} = {0.1415926:floatToString(length=5, dp=4)}		printText {~} = {0.1415926:floatToString(length=5, dp=4)}
	end		end
	</p>		</p>
	The result is:		The result is:
	<p class="output">0.1415926:~~floatTo<var>String</var>~~ = 0		<p class="output">0.1415926:floatToString = 0
	0.1415926:~~floatTo<var>String</var>~~(dp=0) = 0		0.1415926:floatToString(dp=0) = 0
	0.1415926:~~floatTo<var>String</var>~~(dp=1) = 0.1		0.1415926:floatToString(dp=1) = 0.1
	0.1415926:~~floatTo<var>String</var>~~(dp=5) = 0.14159		0.1415926:floatToString(dp=5) = 0.14159
	0.1415926:~~floatTo<var>String</var>~~(length=10) = 0		0.1415926:floatToString(length=10) = 0
	0.1415926:~~floatTo<var>String</var>~~(length=10, dp=1) = 0.1		0.1415926:floatToString(length=10, dp=1) = 0.1
	0.1415926:~~floatTo<var>String</var>~~(length=10, dp=4) = 0.1415		0.1415926:floatToString(length=10, dp=4) = 0.1415
	0.1415926:~~floatTo<var>String</var>~~(length=5, dp=4) = .1415		0.1415926:floatToString(length=5, dp=4) = .1415
			</p></ol>

	~~</p>~~
	==See also==		==See also==
			<ul><li>For details of the <var>printtext</var> statement, please see <var>[[Intrinsic classes#printtext\|printText]]</var>.
			</ul>
	{{Template:Float:FloatToString footer}}		{{Template:Float:FloatToString footer}}

Wiccan: 1 revision

2011-01-26T21:27:31Z

1 revision

← Older revision	Revision as of 21:27, 26 January 2011
(No difference)