<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->

<refentry xml:id="ds-set.sum" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>Ds\Set::sum</refname>
  <refpurpose>Returns the sum of all values in the set</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <modifier>public</modifier> <type class="union"><type>int</type><type>float</type></type><methodname>Ds\Set::sum</methodname>
   <void />
  </methodsynopsis>
  <para>
    Returns the sum of all values in the set.
  </para>
  <note>
    <para>
        Arrays and objects are considered equal to zero when calculating the sum.
    </para>
  </note>

 </refsect1>

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

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
    The sum of all the values in the set as either a <type>float</type> or <type>int</type>
    depending on the values in the set.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <example>
   <title><function>Ds\Set::sum</function> integer example</title>
   <programlisting role="php">
<![CDATA[
<?php
$set = new \Ds\Set([1, 2, 3]);
var_dump($set->sum());
?>
]]>
   </programlisting>
   &example.outputs.similar;
   <screen>
<![CDATA[
int(6)
]]>
   </screen>
  </example>
  <example>
   <title><function>Ds\Set::sum</function> float example</title>
   <programlisting role="php">
<![CDATA[
<?php
$set = new \Ds\Set([1, 2.5, 3]);
var_dump($set->sum());
?>
]]>
   </programlisting>
   &example.outputs.similar;
   <screen>
<![CDATA[
float(6.5)
]]>
   </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
-->
