trader-sar.xml

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

<refentry xml:id="function.trader-sar" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>trader_sar</refname>
  <refpurpose>Parabolic SAR</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>array</type><methodname>trader_sar</methodname>
   <methodparam><type>array</type><parameter>high</parameter></methodparam>
   <methodparam><type>array</type><parameter>low</parameter></methodparam>
   <methodparam choice="opt"><type>float</type><parameter>acceleration</parameter></methodparam>
   <methodparam choice="opt"><type>float</type><parameter>maximum</parameter></methodparam>
  </methodsynopsis>
  <para>

  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>high</parameter></term>
    <listitem>
     <para>
      &trader.arg.array.of.real.high;
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>low</parameter></term>
    <listitem>
     <para>
      &trader.arg.array.of.real.low;
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>acceleration</parameter></term>
    <listitem>
     <para>
      Acceleration Factor used up to the Maximum value. Valid range from 0 to <link xmlns="http://docbook.org/ns/docbook" linkend="constant.trader-real-max">TRADER_REAL_MAX</link>.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>maximum</parameter></term>
    <listitem>
     <para>
      Acceleration Factor Maximum value. Valid range from 0 to <link xmlns="http://docbook.org/ns/docbook" linkend="constant.trader-real-max">TRADER_REAL_MAX</link>.
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>Returns an array with calculated data or false on failure.</para>
 </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
-->