<?xml version="1.0"?>
<document title="XtPHP" description="Biblioteca de classes que facilitam a vida do programador.">
<class name="XtMath">
<description>Proporciona métodos metmáticos e estatísticos.</description>
<methods>
<method name="sum" visibility="public" example="math.php">
<description>Soma valores de um array.</description>
<params>
<param type="array" name="$array" optional="false" default="">Um array com os números a serem somados.</param>
</params>
<return type="number">A soma.</return>
</method>
<method name="med" visibility="public" example="math.php">
<description>Calcula a média dos valores de um array.</description>
<params>
<param type="array" name="$array" optional="false" default="">Um array com os números.</param>
</params>
<return type="number">A média.</return>
</method>
<method name="max" visibility="public" example="math.php">
<description>Retorna o maior valor dentre valores de um array.</description>
<params>
<param type="array" name="$array" optional="false" default="">Um array com os números.</param>
</params>
<return type="number">O maior valor.</return>
</method>
<method name="min" visibility="public" example="math.php">
<description>Retorna o menor valor dentre valores de um array.</description>
<params>
<param type="array" name="$array" optional="false" default="">Um array com os números.</param>
</params>
<return type="number">O menor valor.</return>
</method>
<method name="desvpad" visibility="public" example="math.php">
<description>Retorna o desvio padrão dos valores de um array.</description>
<params>
<param type="array" name="$array" optional="false" default="">Um array com os números.</param>
</params>
<return type="number">O desvio padrão.</return>
</method>
<method name="len" visibility="public" example="math.php">
<description>Conta o número de elementos de um array.</description>
<params>
<param type="array" name="$array" optional="false" default="">Um array.</param>
</params>
<return type="number">O número de elementos.</return>
</method>
<method name="correlation" visibility="public" example="math.php">
<description>Define a correlação entre dois conjuntos de números.</description>
<params>
<param type="array" name="$arr1" optional="false" default="">O primeiro conjunto de números.</param>
<param type="array" name="$arr2" optional="false" default="">O segundo conjunto de números.</param>
</params>
<return type="number">O coeficente de correlação.</return>
</method>
<method name="linearProj" visibility="public" example="math.php">
<description>Realiza projeção linear de valores.</description>
<params>
<param type="array" name="$x0" optional="false" default="">Valores passados de X.</param>
<param type="array" name="$y0" optional="false" default="">Valores passados de Y.</param>
<param type="array" name="$x1" optional="false" default="">Valores futuros de X.</param>
</params>
<return type="array">Conjunto de valores de Y projetados.</return>
</method>
</methods>
</class>
</document>
|