IsPrime (Float function): Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
m (match syntax diagram to revised template; fix tags and some links; still some incomplete / unfound links) |
||
| Line 1: | Line 1: | ||
{{Template:Float:IsPrime subtitle}} | {{Template:Float:IsPrime subtitle}} | ||
The <var>IsPrime</var> <var>[[Intrinsic classes|intrinsic]]</var> function returns a boolean value that indicates whether the method object value, rounded to an integer, is [http://en.wikipedia.org/wiki/Prime_number prime]. The method returns '<code>True</code>' if <var class="term">float</var> is prime, and it returns '<code>False</code>' if it is not prime. | |||
The method returns ' | |||
==Syntax== | ==Syntax== | ||
{{Template:Float:IsPrime syntax}} | {{Template:Float:IsPrime syntax}} | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>% | <tr><th>%boolean</th> | ||
<td>An enumeration object of type Boolean to contain the returned value of <var>IsPrime</var>. </td></tr> | <td>An enumeration object of type Boolean to contain the returned value of <var>IsPrime</var>. </td></tr> | ||
<tr><th> | <tr><th>float</th> | ||
<td>A <var>Float</var> value.</td></tr> | <td>A <var>Float</var> value.</td></tr> | ||
</table> | </table> | ||
==Usage notes== | ==Usage notes== | ||
<ul><li>If <var class="term">float</var> is a negative value or is greater than 2<sup>31</sup>-1, the request is canceled. | |||
<li><var>IsPrime</var> is available as of <var class="product">[[Sirius Mods|"Sirius Mods"]]</var> Version 7.3.</ul> | |||
==Examples== | ==Examples== | ||
The following statement returns ' | <ol><li>The following statement returns '<code>113:isprime = True</code>'. | ||
<p class="code"> | <p class="code">printText {~} = {113:isprime} | ||
</p> | </p> | ||
The enumeration value is printed, above, as the result of an implicit | The enumeration value is printed, above, as the result of an implicit <var>[[ToString_(Float function)|ToString]]</var> method call.</ol> | ||
==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:IsPrime footer}} | {{Template:Float:IsPrime footer}} | ||
Revision as of 00:42, 4 February 2011
Is this number prime? (Float class)
The IsPrime intrinsic function returns a boolean value that indicates whether the method object value, rounded to an integer, is prime. The method returns 'True' if float is prime, and it returns 'False' if it is not prime.
Syntax
%boolean = float:IsPrime
Syntax terms
| %boolean | An enumeration object of type Boolean to contain the returned value of IsPrime. |
|---|---|
| float | A Float value. |
Usage notes
- If float is a negative value or is greater than 231-1, the request is canceled.
- IsPrime is available as of "Sirius Mods" Version 7.3.
Examples
- The following statement returns '
113:isprime = True'.printText {~} = {113:isprime}
The enumeration value is printed, above, as the result of an implicit ToString method call.
See also
- For details of the printtext statement, please see printText.