FloatToString (Float function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
mNo edit summary
 
(31 intermediate revisions by 6 users not shown)
Line 1: Line 1:
This [[Intrinsic classes|intrinsic]] function converts a floating point number to a string with a specific
{{Template:Float:FloatToString subtitle}}
length and number of decimal places.


The FloatToString function is available as of version 7.6 of the [[Sirius Mods]].
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.
===FloatToString syntax===
  %str = number:FloatToString([Length=len] [, Dp=num])
====Syntax Terms====
<dl>
<dt>%str
<dd>A string variable to receive the converted value of the
method object number.
<dt>[Length=]len
<dd>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.
<dt>[Dp=]num
<dd>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).


</dl>
==Syntax==
===Usage Notes===
{{Template:Float:FloatToString syntax}}
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:
    13.1415926:floatToString(length=6, dp=4)


FloatToString neatly displays non-integer numeric values.
===Syntax terms===
The Round method (:hdref refid=flround.) is not a good way of doing this,
<table class="syntaxTable">
since Round returns a Float value and strips trailing 0s when printing the value.
<tr><th>%string</th>
<td>A string variable to receive the converted value of the method object number.</td></tr>


FloatToString currently does not support E format (9.9E72) output.
<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>


A ''''Dp'''' value of 0 has a special result: no decimal point.
<tr><th><var>Length</var></th>
There is no way to get a trailing decimal point without any
<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>
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,
<tr><th><var>DP</var></th>
FloatToString uses truncation, not rounding, of the input, as you can see
<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>
in the last two of the PrintText statements in the example below.
</table>


===Examples===
==Usage notes==
The following program demonstrates the FloatToString method.
<ul>
  begin
<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:
      [[Intrinsic classes#printtext|printText]] {~} = {0.1415926:floatToString}
<p class="code">13.1415926:FloatToString(length=6, dp=4)
      printText {~} = {0.1415926:floatToString(dp=0)}
</p>
      printText {~} = {0.1415926:floatToString(dp=1)}
 
      printText {~} = {0.1415926:floatToString(dp=5)}
<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.
      printText {~} = {0.1415926:floatToString(length=10)}
 
      printText {~} = {0.1415926:floatToString(length=10, dp=1)}
<li><var>FloatToString</var> currently does not support E format (9.9E72) output.
      printText {~} = {0.1415926:floatToString(length=10, dp=4)}
 
      printText {~} = {0.1415926:floatToString(length=5, dp=4)}
<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.
  end
 
<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>
 
==Examples==
The following program demonstrates the <var>FloatToString</var> method.
<p class="code">begin
    [[PrintText statement|printText]] {~} = {0.1415926:floatToString}
    printText {~} = {0.1415926:floatToString(dp=0)}
    printText {~} = {0.1415926:floatToString(dp=1)}
    printText {~} = {0.1415926:floatToString(dp=5)}
    printText {~} = {0.1415926:floatToString(length=10)}
    printText {~} = {0.1415926:floatToString(length=10, dp=1)}
    printText {~} = {0.1415926:floatToString(length=10, dp=4)}
    printText {~} = {0.1415926:floatToString(length=5, dp=4)}
end
</p>
The result is:
The result is:
    0.1415926:floatToString = 0
<p class="output">0.1415926:floatToString = 0
    0.1415926:floatToString(dp=0) = 0
0.1415926:floatToString(dp=0) = 0
    0.1415926:floatToString(dp=1) = 0.1
0.1415926:floatToString(dp=1) = 0.1
    0.1415926:floatToString(dp=5) = 0.14159
0.1415926:floatToString(dp=5) = 0.14159
    0.1415926:floatToString(length=10) =          0
0.1415926:floatToString(length=10) =          0
    0.1415926:floatToString(length=10, dp=1) =        0.1
0.1415926:floatToString(length=10, dp=1) =        0.1
    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>
===See also===
[[List of intrinsic Float methods]]
[[Category: Intrinsic Float methods|FloatToString function]]
[[Category: Intrinsic methods]]


<!--
==See also==
<section begin=dpl_desc />
{{Template:Float:FloatToString footer}}
Convert to string with EBCDIC/displayable representation of Float value
<section end=dpl_desc />
-->

Latest revision as of 17:53, 2 November 2012

Convert a number to a string (Float class)


The FloatToString intrinsic function converts a floating point number to a string with a specific length and number of decimal places.

Syntax

%string = float:FloatToString[( [Length= number], [DP= number])]

Syntax terms

%string A string variable to receive the converted value of the method object number.
float The (input) method object float value that will be converted to the output %string.
Length This is an optional, but name required, parameter which specifies the output string length. The number value must be between 1 and 255, and it defaults to the minimum length required to represent the number.
DP This is an optional, but nameRequired, parameter which specifies the number of decimal places in the result. The number value defaults to 0, must be between 0 and 75, and must be less than any Length parameter specified.

Usage notes

  • 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:

    13.1415926:FloatToString(length=6, dp=4)

  • FloatToString neatly displays non-integer numeric values. Round is not a good way of doing this, since Round returns a Float value and strips trailing 0s when printing the value.
  • FloatToString currently does not support E format (9.9E72) output.
  • 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 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, FloatToString uses truncation, not rounding, of the input, as you can see in the last two of the PrintText statements in the example below.
  • FloatToString is available as of Sirius Mods Version 7.6.

Examples

The following program demonstrates the FloatToString method.

begin printText {~} = {0.1415926:floatToString} printText {~} = {0.1415926:floatToString(dp=0)} printText {~} = {0.1415926:floatToString(dp=1)} printText {~} = {0.1415926:floatToString(dp=5)} printText {~} = {0.1415926:floatToString(length=10)} printText {~} = {0.1415926:floatToString(length=10, dp=1)} printText {~} = {0.1415926:floatToString(length=10, dp=4)} printText {~} = {0.1415926:floatToString(length=5, dp=4)} end

The result is:

0.1415926:floatToString = 0 0.1415926:floatToString(dp=0) = 0 0.1415926:floatToString(dp=1) = 0.1 0.1415926:floatToString(dp=5) = 0.14159 0.1415926:floatToString(length=10) = 0 0.1415926:floatToString(length=10, dp=1) = 0.1 0.1415926:floatToString(length=10, dp=4) = 0.1415 0.1415926:floatToString(length=5, dp=4) = .1415

See also

Retrieved from "https://m204wiki.rocketsoftware.com/index.php?title=FloatToString_(Float_function)&oldid=3814"