BitClearString, BitFlipString, and BitSetString (String functions) - Revision history

Admin: /* See also */

2013-03-22T00:05:17Z

Admin: /* See also */

2013-03-21T23:59:31Z

Admin: /* Usage notes */

2013-03-21T23:40:50Z

Usage notes

← Older revision		Revision as of 23:40, 21 March 2013
Line 20:		Line 20:
	==Usage notes==		==Usage notes==
	<ul>		<ul>
	<li>Requesting a non-positive bit number, or a bit number past the the end of the string results in a [[InvalidBitNumber exception]] being thrown.</li>		<li>Requesting a non-positive bit number, or a bit number past the the end of the string results in an [[InvalidBitNumber class\|InvalidBitNumber exception]] being thrown.</li>
	<li>Since each byte in a string has 8 bits, the valid bit numbers range from 1 to the length of the string times 8. So a null (zero-length) string has no valid bits.</li>		<li>Since each byte in a string has 8 bits, the valid bit numbers range from 1 to the length of the string times 8. So a null (zero-length) string has no valid bits.</li>
	<li>The value of a bit in a string can be tested with the [[BitValueString (String function)\|BitValueString function]].</li>		<li>The value of a bit in a string can be tested with the [[BitValueString (String function)\|BitValueString function]].</li>
	<li>Manipulating bits in a string provides an CPU and space efficient alternative to an array or [Arraylist Class\|Arraylist]] when the possible values are always 0 or 1 or <var>True</var> or <var>False</var>. However, because the bit manipulation methods require the copying of the string value for each operation, this benefit tends to be blunted as the strings get longer. So while there is no restriction on the length of a string and bit number with the string that these methods will update – they can even update bit numbers greater than 2G since a 2G-1 longstring has 16G-8 bits</li> – it's probably not a good idea to use these functions heavily on strings longer than 255 bytes (2040 bits) or so.</li>		<li>Manipulating bits in a string provides an CPU and space efficient alternative to an array or [Arraylist Class\|Arraylist]] when the possible values are always 0 or 1 or <var>True</var> or <var>False</var>. However, because the bit manipulation methods require the copying of the string value for each operation, this benefit tends to be blunted as the strings get longer. So while there is no restriction on the length of a string and bit number with the string that these methods will update – they can even update bit numbers greater than 2G since a 2G-1 longstring has 16G-8 bits</li> – it's probably not a good idea to use these functions heavily on strings longer than 255 bytes (2040 bits) or so.</li>
	</ul>		</ul>

	==Examples==		==Examples==
	This example creates a 128-byte string of null bytes, then sets every 3rd bit, clears every 4th bit, and then flips (inverts), every 5th bit, finally display the results in hexadecimal format:		This example creates a 128-byte string of null bytes, then sets every 3rd bit, clears every 4th bit, and then flips (inverts), every 5th bit, finally display the results in hexadecimal format:

Admin: /* See also */

2013-03-21T23:34:35Z

Admin at 23:31, 21 March 2013

2013-03-21T23:31:03Z

← Older revision		Revision as of 23:31, 21 March 2013
Line 1:		Line 1:
	{{Template:String:BitSetString subtitle}}		{{Template:String:BitSetString subtitle}}
			These functions provide the ability to manipulate individual bits in a string via a bit number.
	~~This page is [[under construction]]~~.
	==Syntax==		==Syntax==
	{{Template:String:BitClearString syntax}}		{{Template:String:BitClearString syntax}}
Line 8:		Line 7:
	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%result</th><td>string</td></tr>		<tr><th>%result</th><td>A copy of the input (method object) string with a single bit (possibly) modified.</td></tr>
	<tr><th>string</th>		<tr><th>string</th>
	<td>string</td></tr>		<td>The string for which a bit is to be modified.</td></tr>
	<tr><th>bitNumber</th>		<tr><th>bitNumber</th>
	<td>number</td></tr>		<td>The bit number in the input string that is to be modified. Note that this is a bit number not a bit offset. So the first bit in the string is bit number 1.</td></tr>
	</table>		</table>
			<ul>
			<li><var>BitClearString</var> turns off the indicated bit. If it is already off, the bit stays off.</li>
			<li><var>BitFlipString</var> changes the indicated bit. If it is on, the bit is turned off; if it is off, the bit is turned on.</li>
			<li><var>BitSetString</var> turns on the indicated bit. If it is already on, the bit stays on.</li>
			</ul>
	==Usage notes==		==Usage notes==
			<ul>
			<li>Requesting a non-positive bit number, or a bit number past the the end of the string results in a [[InvalidBitNumber exception]] being thrown.</li>
			<li>Since each byte in a string has 8 bits, the valid bit numbers range from 1 to the length of the string times 8. So a null (zero-length) string has no valid bits.</li>
			<li>The value of a bit in a string can be tested with the [[BitValueString (String function)\|BitValueString function]].</li>
			<li>Manipulating bits in a string provides an CPU and space efficient alternative to an array or [Arraylist Class\|Arraylist]] when the possible values are always 0 or 1 or <var>True</var> or <var>False</var>. However, because the bit manipulation methods require the copying of the string value for each operation, this benefit tends to be blunted as the strings get longer. So while there is no restriction on the length of a string and bit number with the string that these methods will update – they can even update bit numbers greater than 2G since a 2G-1 longstring has 16G-8 bits</li> – it's probably not a good idea to use these functions heavily on strings longer than 255 bytes (2040 bits) or so.</li>
			</ul>
	==Examples==		==Examples==
			This example creates a 128-byte string of null bytes, then sets every 3rd bit, clears every 4th bit, and then flips (inverts), every 5th bit, finally display the results in hexadecimal format:
			<p class="code">%string is string len 255
			%i is float
			...
			%string = '00':x:[[Left (String function)\|left]](128, pad='00':x')

			for %i from 1 to %string:length * 8 by 3
			%string = %string:bitSetString(%i)
			end for

			for %i from 1 to %string:length * 8 by 4
			%string = %string:bitClearString(%i)
			end for

			for %i from 1 to %string:length * 8 by 5
			%string = %string:bitFlipString(%i)
			end for
			</p>
	==See also==		==See also==
	{{Template:String:BitSetString footer}}		{{Template:String:BitSetString footer}}

Admin: /* Syntax */

2013-03-21T20:14:15Z

Syntax

← Older revision		Revision as of 20:14, 21 March 2013
Line 3:		Line 3:
	This page is [[under construction]].		This page is [[under construction]].
	==Syntax==		==Syntax==
			{{Template:String:BitClearString syntax}}
			{{Template:String:BitFlipString syntax}}
	{{Template:String:BitSetString syntax}}		{{Template:String:BitSetString syntax}}
	===Syntax terms===		===Syntax terms===
Line 12:		Line 14:
	<td>number</td></tr>		<td>number</td></tr>
	</table>		</table>

	==Usage notes==		==Usage notes==
	==Examples==		==Examples==
	==See also==		==See also==
	{{Template:String:BitSetString footer}}		{{Template:String:BitSetString footer}}

Admin: Admin moved page BitClearString, BitFlipString, and BitSetString (String function) to BitClearString, BitFlipString, and BitSetString (String functions) without leaving a redirect

2013-03-21T20:12:06Z

Admin moved page BitClearString, BitFlipString, and BitSetString (String function) to BitClearString, BitFlipString, and BitSetString (String functions) without leaving a redirect

← Older revision	Revision as of 20:12, 21 March 2013
(No difference)

Admin: Admin moved page BitSetString (String function) to BitClearString, BitFlipString, and BitSetString (String function)

2013-03-21T20:11:49Z

Admin moved page BitSetString (String function) to BitClearString, BitFlipString, and BitSetString (String function)

← Older revision	Revision as of 20:11, 21 March 2013
(No difference)

Wiccan: Automatically generated page update

2013-03-21T20:10:05Z

Automatically generated page update

New page

{{Template:String:BitSetString subtitle}}

This page is [[under construction]].
==Syntax==
{{Template:String:BitSetString syntax}}
===Syntax terms===
<table class="syntaxTable">
<tr><th>%result</th><td>string</td></tr>
<tr><th>string</th>
<td>string</td></tr>
<tr><th>bitNumber</th>
<td>number</td></tr>
</table>
==Usage notes==
==Examples==
==See also==
{{Template:String:BitSetString footer}}

← Older revision		Revision as of 00:05, 22 March 2013
Line 59:		Line 59:
	<td>		<td>
	<ul>		<ul>
	~~<li><var>[[BitClearString, BitFlipString, BitSetString (String functions)\|BitClearString, BitFlipString, BitSetString]]</var>~~
	<li><var>[[BitCountString (String function)\|BitCountString]]</var>		<li><var>[[BitCountString (String function)\|BitCountString]]</var>
			<li><var>[[BitValueString (String function)\|BitValueString]]</var>
	</ul>		</ul>
	</td>		</td>
	</table>		</table>
	{{Template:String:BitSetString footer}}		{{Template:String:BitSetString footer}}

← Older revision		Revision as of 23:59, 21 March 2013
Line 59:		Line 59:
	<td>		<td>
	<ul>		<ul>
	<li><var>[[~~BitValueString~~ (String ~~function~~)\|~~BitValueString~~]]</var>		<li><var>[[BitClearString, BitFlipString, BitSetString (String functions)\|BitClearString, BitFlipString, BitSetString]]</var>
	<li><var>[[BitCountString (String function)\|BitCountString]]</var>		<li><var>[[BitCountString (String function)\|BitCountString]]</var>
	</ul>		</ul>

@@ Line 45: / Line 45: @@
 </p>
 ==See also==
 {{Template:String:BitSetString footer}}