Deflate (String function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
No edit summary
 
(3 intermediate revisions by one other user not shown)
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 15: Line 14:


<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.
Line 55: Line 54:
<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>
<li><var>[[Zip (String function)|Zip]]</var>
</ul>
</ul>
</ul>
</ul>


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

Latest revision as of 21:00, 3 September 2015

Compress a longstring with deflate (String class)

[Introduced in Sirius Mods 7.4]

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.

Syntax

%outString = string:Deflate[( [FixedCode= boolean], [LazyMatch= boolean], - [MaxChain= number])]

Syntax terms

%outString The resulting compressed string.
string The string to be compressed.
FixedCode FixedCode is an optional, name required, parameter that is a Boolean value that specifies whether the compression uses fixed codes or is dynamic, based on the contents of the input string.
  • With fixed code compression (fixedCode=true), 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.
  • With dynamic compression (fixedCode=false), 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.
The default value for this argument is False (use dynamic compression).
LazyMatch LazyMatch is an optional, name required, parameter that is a Boolean value that specifies whether to use "lazy match" compression, as specified in RFC 1951. The default value for this argument is False (do not use "lazy match" compression).
MaxChain MaxChain is an optional, name required, parameter that is a numeric value that specifies the maximum hash chain length, as explained in RFC 1951. The default value for this argument is 0. If specified, it must be between 0 and 99, inclusive.

Usage notes

  • The NCMPBUF parameter must be set to a non-0 value during Model 204initialization to allow use of the Deflate function; otherise, invoking Deflate causes request cancellation.
  • 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.
  • Short strings (less than 128 bytes) typically compress better with fixedCode=true.

Examples

In the following example, %out is set to the compressed version of the given string:

%out = 'How much wood could a woodchuck chuck':deflate(fixedCode=true)

See also