Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
92 changes: 92 additions & 0 deletions reference/mongodb/bson/binary/fromvector.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: dac7a370d34ddda0a647ea551c28d6e168261613 Maintainer: Fan2Shrek Status: ready -->
<!-- Reviewed: yes -->

<refentry xml:id="mongodb-bson-binary.fromvector" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>MongoDB\BSON\Binary::fromVector</refname>
<refpurpose>Crée un nouveau binaire avec le sous-type <constant>MongoDB\BSON\Binary::SUBTYPE_VECTOR</constant> à partir du tableau et du type de vecteur donnés</refpurpose>
</refnamediv>

<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>final</modifier> <modifier>public</modifier> <modifier>static</modifier> <type>MongoDB\BSON\Binary</type><methodname>MongoDB\BSON\Binary::fromVector</methodname>
<methodparam><type>array</type><parameter>vector</parameter></methodparam>
<methodparam><type>MongoDB\BSON\VectorType</type><parameter>vectorType</parameter></methodparam>
</methodsynopsis>
</refsect1>

<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>vector</parameter> (<type>array</type>)</term>
<listitem>
<para>
Un tableau de valeurs représentant les données vectorielles. Le type de chaque valeur doit correspondre au type indiqué par le paramètre <parameter>vectorType</parameter>:
<itemizedlist>
<listitem><simpara>pour <constant>MongoDB\BSON\VectorType::Float32</constant>, chaque valeur doit être un <type>float</type></simpara></listitem>
<listitem><simpara>pour <constant>MongoDB\BSON\VectorType::Int8</constant>, chaque valeur doit être un <type>int</type> de 8 bits, c'est-à-dire de <literal>-127</literal> à <literal>128</literal></simpara></listitem>
<listitem><simpara>pour <constant>MongoDB\BSON\VectorType::PackedBit</constant>, chaque valeur doit être un <type>bool</type> ou un <type>int</type> de 1 bit, c'est-à-dire <literal>0</literal> ou <literal>1</literal></simpara></listitem>
</itemizedlist>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>vectorType</parameter> (<type>MongoDB\BSON\VectorType</type>)</term>
<listitem>
<para>
Le type de donnée du vecteur.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>

<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Renvoie un nouveau binaire avec le sous-type <constant>MongoDB\BSON\Binary::SUBTYPE_VECTOR</constant>.
</para>
</refsect1>

<refsect1 role="errors">
&reftitle.errors;
<simplelist>
&mongodb.throws.argumentparsing;
</simplelist>
</refsect1>

<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><methodname>MongoDB\BSON\Binary::toArray</methodname></member>
<member><methodname>MongoDB\BSON\Binary::getVectorType</methodname></member>
<member><enumname>MongoDB\BSON\VectorType</enumname></member>
<member><link xlink:href="&url.mongodb.docs.bson;">BSON Types</link></member>
</simplelist>
</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
-->
68 changes: 68 additions & 0 deletions reference/mongodb/bson/binary/getvectortype.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: dac7a370d34ddda0a647ea551c28d6e168261613 Maintainer: Fan2Shrek Status: ready -->
<!-- Reviewed: yes -->

<refentry xml:id="mongodb-bson-binary.getvectortype" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>MongoDB\BSON\Binary::getVectorType</refname>
<refpurpose>Renvoie le type de données pour un binaire avec le sous-type vecteur</refpurpose>
</refnamediv>

<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>final</modifier> <modifier>public</modifier> <type>MongoDB\BSON\VectorType</type><methodname>MongoDB\BSON\Binary::getVectorType</methodname>
<void />
</methodsynopsis>
</refsect1>

<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>

<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Renvoie le type de données du vecteur binaire.
</para>
</refsect1>

<refsect1 role="errors">
&reftitle.errors;
<simplelist>
<member>Lève une <classname>MongoDB\Driver\Exception\LogicException</classname> si le sous-type n'est pas <constant>MongoDB\BSON\Binary::SUBTYPE_VECTOR</constant>.</member>
&mongodb.throws.argumentparsing;
</simplelist>
</refsect1>

<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><link xlink:href="&url.mongodb.docs.bson;">Types BSON</link></member>
<member><enumname>MongoDB\BSON\VectorType</enumname></member>
</simplelist>
</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
-->
68 changes: 68 additions & 0 deletions reference/mongodb/bson/binary/toarray.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: dac7a370d34ddda0a647ea551c28d6e168261613 Maintainer: Fan2Shrek Status: ready -->
<!-- Reviewed: yes -->

<refentry xml:id="mongodb-bson-binary.toarray" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>MongoDB\BSON\Binary::toArray</refname>
<refpurpose>Renvoie le vecteur sous forme de tableau pour un binaire avec le sous-type <constant>MongoDB\BSON\Binary::SUBTYPE_VECTOR</constant></refpurpose>
</refnamediv>

<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>final</modifier> <modifier>public</modifier> <type>array</type><methodname>MongoDB\BSON\Binary::toArray</methodname>
<void />
</methodsynopsis>
</refsect1>

<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>

<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Renvoie un tableau contenant les données vectorielles.
</para>
</refsect1>

<refsect1 role="errors">
&reftitle.errors;
<simplelist>
<member>Lève une <classname>MongoDB\Driver\Exception\LogicException</classname> si le sous-type n'est pas <constant>MongoDB\BSON\Binary::SUBTYPE_VECTOR</constant>.</member>
&mongodb.throws.argumentparsing;
</simplelist>
</refsect1>

<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><methodname>MongoDB\BSON\Binary::fromVector</methodname></member>
<member><link xlink:href="&url.mongodb.docs.bson;">Types BSON</link></member>
</simplelist>
</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
-->
71 changes: 71 additions & 0 deletions reference/mongodb/bson/vectortype.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: dac7a370d34ddda0a647ea551c28d6e168261613 Maintainer: Fan2Shrek Status: ready -->
<!-- Reviewed: yes -->

<reference xml:id="enum.mongodb-bson-vectortype" role="enum" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">

<title>L'énumération MongoDB\BSON\VectorType</title>
<titleabbrev>MongoDB\BSON\VectorType</titleabbrev>

<partintro>
<section xml:id="mongodb-bson-vectortype.intro">
&reftitle.intro;
<para>
L'énumération <enumname>MongoDB\BSON\VectorType</enumname> est utilisée pour spécifier le type de
données vectorielles stockées dans une <classname>MongoDB\BSON\Binary</classname> avec le
sous-type <constant>MongoDB\BSON\Binary::TYPE_VECTOR</constant>.
</para>
</section>

<section xml:id="mongodb-bson-vectortype.synopsis">
&reftitle.enumsynopsis;

<enumsynopsis>
<enumname>MongoDB\BSON\VectorType</enumname>

<enumitem>
<enumidentifier>Float32</enumidentifier>
<enumitemdescription>
Chaque élément dans le vecteur est une valeur à virgule flottante de 32 bits.
</enumitemdescription>
</enumitem>

<enumitem>
<enumidentifier>Int8</enumidentifier>
<enumitemdescription>
Chaque élément dans le vecteur est une valeur entière de 8 bits.
</enumitemdescription>
</enumitem>

<enumitem>
<enumidentifier>PackedBit</enumidentifier>
<enumitemdescription>
Chaque élément dans le vecteur est une valeur de 1 bit. Lors de la création de vecteurs
de ce type, vous pouvez passer soit des valeurs <type>bool</type>, soit des valeurs <type>int</type> de 1 bit, c'est-à-dire <literal>0</literal> ou <literal>1</literal>.
</enumitemdescription>
</enumitem>
</enumsynopsis>
</section>
</partintro>
</reference>

<!-- 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
-->