Deflate (String function) - Revision history

ELowell at 21:00, 3 September 2015

2015-09-03T21:00:21Z

← Older revision		Revision as of 21:00, 3 September 2015
Line 1:		Line 1:
	{{Template:String:Deflate subtitle}}		{{Template:String:Deflate subtitle}}

	This function compresses a longstring using the "deflate" algorithm. The deflate algorithm is described completely in RFC 1951. It is very effective with HTML and XML data.		This function compresses a longstring using the "deflate" algorithm. The deflate algorithm is described completely in RFC 1951. It is very effective with HTML and XML data.

Line 8:		Line 7:
	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%outString</th>		<tr><th nowrap>%outString</th>
	<td>The resulting compressed string.</td></tr>		<td>The resulting compressed string.</td></tr>

Line 61:		Line 60:
	</ul>		</ul>
	</ul>		</ul>


	{{Template:String:Deflate footer}}		{{Template:String:Deflate footer}}

JAL2: /* Syntax terms */

2012-08-09T18:37:08Z

Syntax terms

← Older revision		Revision as of 18:37, 9 August 2012
Line 15:		Line 15:

	<tr><th><var>FixedCode</var></th>		<tr><th><var>FixedCode</var></th>
	<td><var>FixedCode</var> is an optional, name required, parameter that is a <var>[[Boolean_enumeration#Using_Boolean_enumerations\|Boolean]]</var> value that specifies whether the compression uses fixed codes or is dynamic, based on the contents of the input <var class="term">string</var>.		<td><var>FixedCode</var> is an optional, [[Notation conventions for methods#Named parameters\|name required]], parameter that is a <var>[[Boolean_enumeration#Using_Boolean_enumerations\|Boolean]]</var> value that specifies whether the compression uses fixed codes or is dynamic, based on the contents of the input <var class="term">string</var>.
	<ul>		<ul>
	<li>With fixed code compression (<code>fixedCode=true</code>), the tables used for compression (defined as part of RFC 1951) are somewhat optimized for ASCII character data, but they slightly decrease the amount of CPU required to perform compression. Also, since the codes are already defined as part of the specification, they are not included in the compressed data.		<li>With fixed code compression (<code>fixedCode=true</code>), the tables used for compression (defined as part of RFC 1951) are somewhat optimized for ASCII character data, but they slightly decrease the amount of CPU required to perform compression. Also, since the codes are already defined as part of the specification, they are not included in the compressed data.

JAL2: /* See also */

2012-08-09T18:28:47Z

JAL2: /* See also */

2012-08-09T17:59:27Z

JAL2: /* See also */

2012-08-09T17:54:36Z

JAL2: /* Usage notes */

2012-07-31T22:12:35Z

Usage notes

← Older revision		Revision as of 22:12, 31 July 2012
Line 33:		Line 33:
	==Usage notes==		==Usage notes==
	<ul>		<ul>

	<li>The <var>[[NCMPBUF parameter\|NCMPBUF]]</var> parameter must be set to a		<li>The <var>[[NCMPBUF parameter\|NCMPBUF]]</var> parameter must be set to a
	non-0 value during <var class="product">Model 204</var>initialization to allow		non-0 value during <var class="product">Model 204</var>initialization to allow
	use of the <var>Deflate</var> function; otherise, invoking <var>Deflate</var>		use of the <var>Deflate</var> function; otherise, invoking <var>Deflate</var>
	causes request cancellation.		causes request cancellation.
	<li>As with any compression scheme, it is possible that a particular string will become longer after compression. This would happen, for example, if a deflated string were passed to $Deflate.
			<li>As with any compression scheme, it is possible that a particular string will become longer after compression. This would happen, for example, if a deflated string were passed to <var>Deflate</var>.

	<li>Short strings (less than 128 bytes) typically compress better with <code>fixedCode=true</code>.		<li>Short strings (less than 128 bytes) typically compress better with <code>fixedCode=true</code>.
	</ul>		</ul>

JAL2: /* Syntax terms */

2012-07-31T22:11:01Z

Syntax terms

JAL2: /* Syntax terms */

2012-07-31T22:03:22Z

Syntax terms

← Older revision		Revision as of 22:03, 31 July 2012
Line 15:		Line 15:

	<tr><th><var>FixedCode</var></th>		<tr><th><var>FixedCode</var></th>
	<td><var>FixedCode</var> is an optional, name required, <var>[[Boolean_enumeration#Using_Boolean_enumerations\|Boolean]]</var> parameter that is a <var>Boolean</var> value that specifies whether the compression uses fixed codes		<td><var>FixedCode</var> is an optional, name required, <var>[[Boolean_enumeration#Using_Boolean_enumerations\|Boolean]]</var> parameter that is a <var>Boolean</var> value that specifies whether the compression uses fixed codes or is dynamic, based on the contents of the input <var class="term">string</var>.
	or is dynamic, based on the contents of the input <var class="term">string</var>.
	<ul>		<ul>
	<li>With fixed code compression (<code>fixedCode=true</code>), the tables used for compression (defined as part of RFC 1951) are somewhat optimized for ASCII character data, but slightly decrease the amount of CPU required to perform compression. Also, since the codes are already defined as part of the specification, they are not included in the compressed data.		<li>With fixed code compression (<code>fixedCode=true</code>), the tables used for compression (defined as part of RFC 1951) are somewhat optimized for ASCII character data, but slightly decrease the amount of CPU required to perform compression. Also, since the codes are already defined as part of the specification, they are not included in the compressed data.

JAL2: /* Examples */

2012-07-31T22:02:40Z

Examples

← Older revision		Revision as of 22:02, 31 July 2012
Line 43:		Line 43:

	==Examples==		==Examples==
	In the following example, %~~LSTRC~~ is set to the compressed version of the given string:		In the following example, <code>%out</code> is set to the compressed version of the given string:
	<p class="code">%out = 'How much wood could a woodchuck chuck':deflate(fixedCode=true)		<p class="code">%out = 'How much wood could a woodchuck chuck':deflate(fixedCode=true)
	</p>		</p>

JAL2: /* Syntax terms */

2012-07-31T22:01:37Z

Syntax terms

← Older revision		Revision as of 22:01, 31 July 2012
Line 8:		Line 8:
	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%outString</th><td>The resulting compressed string.</td></tr>		<tr><th>%outString</th>
			<td>The resulting compressed string.</td></tr>

	<tr><th>string</th>		<tr><th>string</th>
	<td>The string to be compressed.</td></tr>		<td>The string to be compressed.</td></tr>

	<tr><th><var>FixedCode</var></th>		<tr><th><var>FixedCode</var></th>
	<td><var>FixedCode</var> is an optional, name required, <var>[[Boolean_enumeration#Using_Boolean_enumerations\|Boolean]]</var> parameter that is a <var>Boolean</var> value that specifies whether the compression uses fixed codes		<td><var>FixedCode</var> is an optional, name required, <var>[[Boolean_enumeration#Using_Boolean_enumerations\|Boolean]]</var> parameter that is a <var>Boolean</var> value that specifies whether the compression uses fixed codes
	or is dynamic, based on the contents of the input <var class="term">string</var>.<ul>		or is dynamic, based on the contents of the input <var class="term">string</var>.
			<ul>
	<li>With fixed code compression (<code>fixedCode=true</code>), the tables used for compression (defined as part of RFC 1951) are somewhat optimized for ASCII character data, but slightly decrease the amount of CPU required to perform compression. Also, since the codes are already defined as part of the specification, they are not included in the compressed data.		<li>With fixed code compression (<code>fixedCode=true</code>), the tables used for compression (defined as part of RFC 1951) are somewhat optimized for ASCII character data, but slightly decrease the amount of CPU required to perform compression. Also, since the codes are already defined as part of the specification, they are not included in the compressed data.
	<li>With dynamic compression (<code>fixedCode=false</code>), the compression code tables are generated based on the input data. Dynamic tables typically provide somewhat better compression on most types of data. There is a very slight CPU overhead in computing the frequencies of byte values in the input data. Also, since the code tables are dynamic, they are included as part of the compressed data. This will increase the size of the compressed longstring, but these tables are small, since they are also stored in a compressed form.		<li>With dynamic compression (<code>fixedCode=false</code>), the compression code tables are generated based on the input data. Dynamic tables typically provide somewhat better compression on most types of data. There is a very slight CPU overhead in computing the frequencies of byte values in the input data. Also, since the code tables are dynamic, they are included as part of the compressed data. This will increase the size of the compressed longstring, but these tables are small, since they are also stored in a compressed form.
	</ul>		</ul>
	~~This argument is optional; its~~ default value is <~~code~~>~~false~~</~~code~~> (use dynamic compression).</td></tr>		The default value for this argument is <var>False</var> (use dynamic compression).</td></tr>

	<tr><th><var>LazyMatch</var></th>		<tr><th><var>LazyMatch</var></th>
	<td><var>LazyMatch</var> is an optional, name required, parameter that is a <var>Boolean</var> value that specifies whether to use "lazy match" compression, as specified in RFC 1951.		<td><var>LazyMatch</var> is an optional, name required, parameter that is a <var>Boolean</var> value that specifies whether to use "lazy match" compression, as specified in RFC 1951.
	This argument is optional; its default value is <code>false</code> (do not use "lazy match" compression).</td></tr>		This argument is optional; its default value is <code>false</code> (do not use "lazy match" compression).</td></tr>

	<tr><th><var>MaxChain</var></th>		<tr><th><var>MaxChain</var></th>
	<td><var>MaxChain</var> is an optional, name required, parameter that is a numeric value that specifies the maximum hash chain length, as explained in RFC 1951.		<td><var>MaxChain</var> is an optional, name required, parameter that is a numeric value that specifies the maximum hash chain length, as explained in RFC 1951.

← Older revision		Revision as of 18:28, 9 August 2012
Line 58:		Line 58:
	<li><var>[[GunzipFilename (String function)\|GunzipFilename]]</var>		<li><var>[[GunzipFilename (String function)\|GunzipFilename]]</var>
	<li><var>[[Gzip (String function)\|Gzip]]</var>		<li><var>[[Gzip (String function)\|Gzip]]</var>
			<li><var>[[Zip (String function)\|Zip]]</var>
	</ul>		</ul>
	</ul>		</ul>

← Older revision		Revision as of 17:59, 9 August 2012
Line 55:		Line 55:
	<ul>		<ul>
	<li><var>[[Gunzip (String function)\|Gunzip]]</var>		<li><var>[[Gunzip (String function)\|Gunzip]]</var>
			<li><var>[[GunzipDatetimeNS (String function)\|GunzipDatetimeNS]]</var>
			<li><var>[[GunzipFilename (String function)\|GunzipFilename]]</var>
	<li><var>[[Gzip (String function)\|Gzip]]</var>		<li><var>[[Gzip (String function)\|Gzip]]</var>
	</ul>		</ul>

← Older revision		Revision as of 17:54, 9 August 2012
Line 52:		Line 52:
	<ul>		<ul>
	<li><var>[[Inflate (String function)\|Inflate]]</var> is used to decompress the string to its original value.		<li><var>[[Inflate (String function)\|Inflate]]</var> is used to decompress the string to its original value.
	<li>Other related methods: [[??]]		<li>Other related methods:
			<ul>
			<li><var>[[Gunzip (String function)\|Gunzip]]</var>
			<li><var>[[Gzip (String function)\|Gzip]]</var>
	</ul>		</ul>
			</ul>


	{{Template:String:Deflate footer}}		{{Template:String:Deflate footer}}

← Older revision		Revision as of 22:11, 31 July 2012
Line 15:		Line 15:

	<tr><th><var>FixedCode</var></th>		<tr><th><var>FixedCode</var></th>
	<td><var>FixedCode</var> is an optional, name required, <var>[[Boolean_enumeration#Using_Boolean_enumerations\|Boolean]]~~</var> parameter that is a <var>Boolean~~</var> value that specifies whether the compression uses fixed codes or is dynamic, based on the contents of the input <var class="term">string</var>.		<td><var>FixedCode</var> is an optional, name required, parameter that is a <var>[[Boolean_enumeration#Using_Boolean_enumerations\|Boolean]]</var> value that specifies whether the compression uses fixed codes or is dynamic, based on the contents of the input <var class="term">string</var>.
	<ul>		<ul>
	<li>With fixed code compression (<code>fixedCode=true</code>), the tables used for compression (defined as part of RFC 1951) are somewhat optimized for ASCII character data, but slightly decrease the amount of CPU required to perform compression. Also, since the codes are already defined as part of the specification, they are not included in the compressed data.		<li>With fixed code compression (<code>fixedCode=true</code>), the tables used for compression (defined as part of RFC 1951) are somewhat optimized for ASCII character data, but they slightly decrease the amount of CPU required to perform compression. Also, since the codes are already defined as part of the specification, they are not included in the compressed data.
	<li>With dynamic compression (<code>fixedCode=false</code>), the compression code tables are generated based on the input data. Dynamic tables typically provide somewhat better compression on most types of data. There is a very slight CPU overhead in computing the frequencies of byte values in the input data. Also, since the code tables are dynamic, they are included as part of the compressed data. This will increase the size of the compressed longstring, but these tables are small, since they are also stored in a compressed form.		<li>With dynamic compression (<code>fixedCode=false</code>), the compression code tables are generated based on the input data. Dynamic tables typically provide somewhat better compression on most types of data. There is a very slight CPU overhead in computing the frequencies of byte values in the input data. Also, since the code tables are dynamic, they are included as part of the compressed data. This will increase the size of the compressed longstring, but these tables are small, since they are also stored in a compressed form.
	</ul>		</ul>
Line 24:		Line 24:
	<tr><th><var>LazyMatch</var></th>		<tr><th><var>LazyMatch</var></th>
	<td><var>LazyMatch</var> is an optional, name required, parameter that is a <var>Boolean</var> value that specifies whether to use "lazy match" compression, as specified in RFC 1951.		<td><var>LazyMatch</var> is an optional, name required, parameter that is a <var>Boolean</var> value that specifies whether to use "lazy match" compression, as specified in RFC 1951.
	~~This argument is optional; its~~ default value is <~~code~~>~~false~~</~~code~~> (do not use "lazy match" compression).</td></tr>		The default value for this argument is <var>False</var> (do not use "lazy match" compression).</td></tr>

	<tr><th><var>MaxChain</var></th>		<tr><th><var>MaxChain</var></th>
	<td><var>MaxChain</var> is an optional, name required, parameter that is a numeric value that specifies the maximum hash chain length, as explained in RFC 1951.		<td><var>MaxChain</var> is an optional, name required, parameter that is a numeric value that specifies the maximum hash chain length, as explained in RFC 1951.
	~~This argument is optional; its~~ default value is 0. If specified, it must be between 0 and 99, inclusive.</td></tr>		The default value for this argument is 0. If specified, it must be between 0 and 99, inclusive.</td></tr>
	</table>		</table>