Files

134 lines
4.1 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: bfe06c36ec1c0a37909704b292a204195b0bc14f Maintainer: leonardolara Status: ready -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="quickhashintset.loadfromstring">
<refnamediv>
<refname>QuickHashIntSet::loadFromString</refname>
<refpurpose>Este método de fábrica cria um conjunto a partir de uma string</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <modifier>static</modifier> <type>QuickHashIntSet</type><methodname>QuickHashIntSet::loadFromString</methodname>
<methodparam><type>string</type><parameter>contents</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>size</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam>
</methodsynopsis>
<simpara>
Este método de fábrica cria um novo conjunto a partir de uma definição em uma string. O
formato de arquivo consiste em inteiros com sinal de 32 bits compactados na
ordem de bytes usada pelo sistema no qual o código é executado.
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>contents</parameter></term>
<listitem>
<simpara>
A sequência que contém um formato serializado do conjunto.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>size</parameter></term>
<listitem>
<simpara>
A quantidade de listas de buckets a serem configuradas. O número informado será
automaticamente arredondado para a próxima potência de dois. Também é
automaticamente limitado de <literal>4</literal> a <literal>4194304</literal>.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>options</parameter></term>
<listitem>
<simpara>
As mesmas opções que o construtor da classe aceita; exceto que a opção de
tamanho é ignorada. É calculado automaticamente para ser o mesmo que o
número de entradas no conjunto, arredondado para o potência de dois mais próxima,
limitado automaticamente entre <literal>64</literal> e <literal>4194304</literal>.
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<simpara>
Retorna um novo <classname>QuickHashIntSet</classname>.
</simpara>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title>Exemplo de <function>QuickHashIntSet::loadFromString</function></title>
<programlisting role="php">
<![CDATA[
<?php
$contents = file_get_contents( dirname( __FILE__ ) . "/simple.set" );
$set = QuickHashIntSet::loadFromString(
$contents,
QuickHashIntSet::DO_NOT_USE_ZEND_ALLOC
);
foreach( range( 0, 0x0f ) as $key )
{
printf( "Chave %3d (%2x) está %s\n",
$key, $key,
$set->exists( $key ) ? 'definida' : 'indefinida'
);
}
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
Chave 0 ( 0) está indefinida
Chave 1 ( 1) está definida
Chave 2 ( 2) está definida
Chave 3 ( 3) está definida
Chave 4 ( 4) está indefinida
Chave 5 ( 5) está definida
Chave 6 ( 6) está indefinida
Chave 7 ( 7) está definida
Chave 8 ( 8) está indefinida
Chave 9 ( 9) está indefinida
Chave 10 ( a) está indefinida
Chave 11 ( b) está definida
Chave 12 ( c) está indefinida
Chave 13 ( d) está definida
Chave 14 ( e) está indefinida
Chave 15 ( f) está indefinida
]]>
</screen>
</example>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->