harbour-core/harbour/doc/es/math.txt

/*
 * $Id$
 */

/*
 * Las siguientes partes son derechos adquiridos de sus autores individuales.
 * www - http://www.harbour-project.org
 *
 * Copyright 2001 Ricardo Ram¡rez R. <rramirez@crownlitometal.com>
 * Documentaci¢n en Espa¤ol de: ABS(), EXP(), LOG(), INT(), MAX()
 *                              MIN(), SQRT(), ROUND()
 *
 *      Basado en ../en/math.txt
 *
 * Vea doc/license.txt por los t‚rminos de la licencia.
 *
 */

/*  $DOC$
 *  $FUNCNAME$
 *      ABS()
 *  $CATEGORY$
 *      Matem ticas
 *  $ONELINER$
 *      Devuelve el valor absoluto de un n£mero.
 *  $SYNTAX$
 *      ABS(<nNumero>) --> <nAbsNumero>
 *  $ARGUMENTS$
 *      <nNumero> Cualquier n£mero.
 *  $RETURNS$
 *      <nAbsNumero> El valor absoluto de un n£mero.
 *  $DESCRIPTION$
 *      Esta funci¢n entrega el valor absoluto de un valor o una expresi¢n
 *      <nNumero>.
 *  $EXAMPLES$
 *      Function Main()
 *
 *         Local nNumero  := 50
 *         Local nNumero1 := 27
 *
 *         qout( nNumero - nNumero1 )
 *         qout( nNumero1 - nNumero )
 *         qout( ABS(nNumero - nNumero1 ) )
 *         qout( ABS(nNumero1 - nNumero ) )
 *         qout( ABS( -1 * 345 ) )
 *      Return Nil
 *  $STATUS$
 *      R
 *  $COMPLIANCE$
 *      Esta es una funci¢n compatible con CA-Cl*pper.
 *  $PLATFORMS$
 *      Todas
 *  $FILES$
 *      Se encuentra en la librer¡a rtl
 *  $SEEALSO$
 *      EXP(),INT()
 *  $END$
 */

/*  $DOC$
 *  $FUNCNAME$
 *      EXP()
 *  $CATEGORY$
 *      Matem ticas
 *  $ONELINER$
 *      Calcula el valor de e elevado a la potencia indicada.
 *  $SYNTAX$
 *      EXP( <nNumero> ) --> <nValor>
 *  $ARGUMENTS$
 *      <nNumero> Cualquier n£mero real.
 *  $RETURNS$
 *      <nValor>  El anti-logaritmo de <nNumero>.
 *  $DESCRIPTION$
 *      Esta function devuelve el valor de e elevado a la potencia indicada
 *      en <nNumero>.  Es la contraria de LOG().
 *  $EXAMPLES$
 *      ? EXP(45)
 *  $STATUS$
 *      R
 *  $COMPLIANCE$
 *      Esta es una funci¢n compatible con CA-Cl*pper.
 *  $PLATFORMS$
 *      Todas
 *  $FILES$
 *      Se encuentra en la librer¡a rtl
 *  $SEEALSO$
 *      LOG(),SET DECIMALS,SET FIXED
 *  $END$
 */

/*  $DOC$
 *  $FUNCNAME$
 *      INT()
 *  $CATEGORY$
 *      Matem ticas
 *  $ONELINER$
 *      Devuelve la parte entera de un valor n£merico.
 *  $SYNTAX$
 *      INT( <nNumero> ) --> <nIntNumero>
 *  $ARGUMENTS$
 *      <nNumero> Cualquier valor n£merico.
 *  $RETURNS$
 *      <nIntNumero> La parte entera de un valor n£merico.
 *  $DESCRIPTION$
 *      Esta funci¢n convierte una expresi¢n num‚rica en entero.  Todos
 *      lo d¡gitos decimales son truncados.  Esta funci¢n no redondea el
 *      valor ni por encima ni por debajo; simplemente trunca el valor
 *      desde el punto decimal.
 *  $EXAMPLES$
 *      SET Decimal to 5
 *      ? INT( 632512.62541 )
 *      ? INT( 845414111.91440 )
 *      </fixed>
 *  $STATUS$
 *      R
 *  $COMPLIANCE$
 *      Esta es una funci¢n compatible con CA-Cl*pper.
 *  $PLATFORMS$
 *      Todas
 *  $FILES$
 *      Se encuentra en la librer¡a rtl
 *  $SEEALSO$
 *      ROUND(),STRZERO()
 *  $END$
 */

/*  $DOC$
 *  $FUNCNAME$
 *      LOG()
 *  $CATEGORY$
 *      Matem ticas
 *  $ONELINER$
 *      Devuelve el logaritmo natural de un n£mero.
 *  $SYNTAX$
 *      LOG( <nNumero> ) --> <nLog>
 *  $ARGUMENTS$
 *      <nNumero> Cualquier expresi¢n num‚rica.
 *  $RETURNS$
 *      <nExponente> El logaritmo natural de <nNumero>.
 *  $DESCRIPTION$
 *      Esta funci¢n devuelve el logaritmo natural del n£mero <nNumero>.
 *      Si <nNumero> es 0 o menor que 0, se produce un desbordamiento
 *      num‚rico, el cual es mostrado en la pantalla como una serie de
 *      asteriscos.
 *      Esta funci¢n es la contraria de EXP().
 *  $EXAMPLES$
 *      ? LOG(632512)
 *  $STATUS$
 *      R
 *  $COMPLIANCE$
 *      Esta es una funci¢n compatible con CA-Cl*pper.
 *  $PLATFORMS$
 *      Todas
 *  $FILES$
 *      Se encuentra en la librer¡a rtl
 *  $SEEALSO$
 *      EXP(),SET DECIMALS,SET FIXED
 *  $END$
 */


/*  $DOC$
 *  $FUNCNAME$
 *      MAX()
 *  $CATEGORY$
 *      Matem ticas
 *  $ONELINER$
 *      Devuelve el mayor de dos n£meros o fechas.
 *  $SYNTAX$
 *      MAX(<xValor>,<xValor1>)  --> <xMax>
 *  $ARGUMENTS$
 *      <xValor> Cualquier fecha o valor n£merico.
 *
 *      <xValor1> Cualquier fecha o valor n£merico (con el mismo tipo de
 *                <xValor>).
 *  $RETURNS$
 *      <xMax> El n£mero mayor (o la fecha mayor).
 *  $DESCRIPTION$
 *      Esta funci¢n devuelve el mayor de las dos expresiones pasadas. Si
 *      <xValor> y <xValor1> son del tipo n£merico, el valor devuelto
 *      por esta funci¢n ser  tambien num‚rico y ser  el mayor de los
 *      numeros pasados a dicha funci¢n. Si <xValor> y <xValor1> son del
 *      tipo fecha el valor devuelto ser  tambien de tipo fecha.  Este ser 
 *      la mayor de ellas.
 *  $EXAMPLES$
 *      ? MAX( 214514214,6251242142 )
 *      ? MAX( CTOD('11/11/2000'), CTOD('21/06/2014') )
 *  $STATUS$
 *      R
 *  $COMPLIANCE$
 *      Esta es una funci¢n compatible con CA-Cl*pper.
 *  $PLATFORMS$
 *      Todas
 *  $FILES$
 *      Se encuentra en la librer¡a rtl
 *  $SEEALSO$
 *      MIN()
 *  $END$
 */

/*  $DOC$
 *  $FUNCNAME$
 *      MIN()
 *  $CATEGORY$
 *      Matem ticas
 *  $ONELINER$
 *      Determina el menor de dos n£meros o fechas.
 *  $SYNTAX$
 *      MIN(<xValor>,<xValor1>)  --> <xMin>
 *  $ARGUMENTS$
 *      <xValor>  Cualquier fecha o valor num‚rico.
 *
 *      <xValor1> Cualquier fecha o valor num‚rico (con el mismo tipo de
 *                <xValor>).
 *  $RETURNS$
 *      <xMin>  El valor o fecha menor.
 *  $DESCRIPTION$
 *      Esta funci¢n devuelve el menor valor del par de expresiones
 *      recibidas <xValor> y <xValor1> deben ser del mismo tipo. Si es
 *      num‚rico, el menor valor es devuelto.  Si es fecha, la fecha menor
 *      es devuelta.
 *  $EXAMPLES$
 *      ? MIN(214514214,6251242142)
 *      ? MIN(CTOD('11/11/2000'),CTOD('21/06/2014')
 *  $STATUS$
 *      R
 *  $COMPLIANCE$
 *      Esta es una funci¢n compatible con CA-Cl*pper.
 *  $PLATFORMS$
 *      Todas
 *  $FILES$
 *      Se encuentra en la librer¡a rtl
 *  $SEEALSO$
 *      MAX()
 *  $END$
 */

/*  $DOC$
 *  $FUNCNAME$
 *      MOD() *
 *  $CATEGORY$
 *      Matem ticas
 *  $ONELINER$
 *      Devuelve el residuo de dos n£meros.
 *  $SYNTAX$
 *      MOD( <nNumero>,<nNumero1>) -->  <nResiduo>
 *  $ARGUMENTS$
 *      <nNumero>   Numerador en una expresi¢n de divisi¢n.
 *
 *      <nNumero1>  Denominador en una expresi¢n de divisi¢n.
 *  $RETURNS$
 *      <nResiduo>  El residuo despues de la operaci¢n de divisi¢n.
 *  $DESCRIPTION$
 *      Esta funci¢n devuleve el residuo de un n£mero dividido entre otro.
 *  $EXAMPLES$
 *      ? MOD( 12,8.521 )
 *      ? MOD( 12,0 )
 *      ? MOD( 62412.5142,4522114.12014 )
 *  $STATUS$
 *      R
 *  $COMPLIANCE$
 *      Esta es una funci¢n compatible con CA-Cl*pper.
 *  $PLATFORMS$
 *      Todas
 *  $FILES$
 *      Se encuentra en la librer¡a rtl
 *  $SEEALSO$
 *      %
 *  $END$
 */

/*  $DOC$
 *  $FUNCNAME$
 *      SQRT()
 *  $CATEGORY$
 *      Matem ticas
 *  $ONELINER$
 *      Calcula la ra¡z cuadrada de un n£mero.
 *  $SYNTAX$
 *      SQRT( <nNumero> ) --> <nSqrt>
 *  $ARGUMENTS$
 *      <nNumero> Cualquier valor num‚rico.
 *  $RETURNS$
 *      <nSqrt>   La ra¡z cuadrada de <nNumero>.
 *  $DESCRIPTION$
 *      Esta funci¢n devuelve la ra¡z cuadrada de <nNumero>.  La presici¢n
 *      de esta evaluaci¢n esta basada £nicamente en la asignaci¢n del
 *      comando SET DECIMAL TO
 *      Cualquier n£mero negativo pasado como <nNumero> siempre retornar  0.
 *  $EXAMPLES$
 *      SET Decimal to 5
 *      ? SQRT( 632512.62541 )
 *      ? SQRT( 845414111.91440 )
 *  $STATUS$
 *      R
 *  $COMPLIANCE$
 *      Esta es una funci¢n compatible con CA-Cl*pper.
 *  $PLATFORMS$
 *      Todas
 *  $FILES$
 *      Se encuentra en la librer¡a rtl
 *  $SEEALSO$
 *      ROUND(),SET DECIMALS,SET FIXED
 *  $END$
 */

/*  $DOC$
 *  $FUNCNAME$
 *      ROUND()
 *  $CATEGORY$
 *      Matem ticas
 *  $ONELINER$
 *      Redondea una expresi¢n num‚rica.
 *  $SYNTAX$
 *      ROUND( <nNumero>, <nLugares> ) --> <nResultado>
 *  $ARGUMENTS$
 *      <nNumero>    Cualquier valor num‚rico.
 *
 *      <nLugares>   El n£mero de lugares decimales a redondear.
 *  $RETURNS$
 *      <nResultado> El n£mero redondeado.
 *  $DESCRIPTION$
 *      Esta funci¢n redondea el valor de <nNumero> a la cantidad de lugares
 *      decimales especificados en <nLugares>. Si el valor de <nLugares> es
 *      un n£mero negativo, la funci¢n intentar  redondear <nNumero> en el
 *      n£mero completo. N£meros de 5 a 9 ser n redondeados hacia arriba, el
 *      resto redondeados hacia abajo.
 *  $EXAMPLES$
 *      ? ROUND(632512.62541,5)
 *      ? ROUND(845414111.91440,3)
 *  $STATUS$
 *      R
 *  $COMPLIANCE$
 *      Esta es una funci¢n compatible con CA-Cl*pper.
 *  $PLATFORMS$
 *      Todas
 *  $FILES$
 *      Se encuentra en la librer¡a rtl
 *  $SEEALSO$
 *      INT(),SET DECIMALS,SET FIXED,STR(),VAL()
 *  $END$
 */

/*  $DOC$
 *  $FUNCNAME$
 *      hb_getMathError()
 *  $CATEGORY$
 *      Matem ticas API
 *  $ONELINER$
 *      Obtener el £ltimo error de la librer¡a matem tica.
 *  $SYNTAX$
 *      C Prototype
 *
 *      #include <hbmath.h>
 *      hb_getMathError (void) --> int iMathError
 *  $ARGUMENTS$
 *      Ninguno
 *  $RETURNS$
 *      Retorna el £ltimo error matem tico
 *  $DESCRIPTION$
 *
 *  $EXAMPLES$
 *
 *  $STATUS$
 *      R
 *  $COMPLIANCE$
 *      Compatibilidad no es aplicable a las llamadas a las APIs.
 *  $FILES$
 *      Se encuentra en la librer¡a rtl
 *  $PLATFORMS$
 *      Todas
 *  $SEEALSO$
 *      hb_setMathError(),hb_resetMathError()
 *  $END$
 */

/*  $DOC$
 *  $FUNCNAME$
 *      hb_resetMathError()
 *  $CATEGORY$
 *      Matem ticas API
 *  $ONELINER$
 *      Inicializa el error matem tico.
 *  $SYNTAX$
 *      C Prototype
 *
 *      #include <hbmath.h>
 *      hb_resetMathError (void) --> void
 *  $ARGUMENTS$
 *      Ninguno
 *  $RETURNS$
 *      Nada
 *  $DESCRIPTION$
 *      Pone en cero (No hay error) a la variable donde se conservan los
 *      errores matem ticos
 *  $EXAMPLES$
 *
 *  $STATUS$
 *      R
 *  $COMPLIANCE$
 *      Compatibilidad no es aplicable a las llamadas a las APIs.
 *  $FILES$
 *      Se encuentra en la librer¡a rtl
 *  $PLATFORMS$
 *      Todas
 *  $SEEALSO$
 *      hb_isMathHandler()
 *  $END$
 */

/*  $DOC$
 *  $FUNCNAME$
 *      hb_isMathHandler()
 *  $CATEGORY$
 *      Matem ticas API
 *  $ONELINER$
 *      Verifica si el manejador de errores de Harbour esta disponible.
 *  $SYNTAX$
 *      C Prototype
 *
 *      #include <hbmath.h>
 *      hb_isMathHandler (void) --> int iIsMathHandler
 *  $ARGUMENTS$
 *      Ninguno
 *  $RETURNS$
 *
 *  $DESCRIPTION$
 *
 *  $EXAMPLES$
 *
 *  $STATUS$
 *      R
 *  $COMPLIANCE$
 *      Compatibilidad no es aplicable a las llamadas a las APIs.
 *  $FILES$
 *      Se encuentra en la librer¡a rtl
 *  $PLATFORMS$
 *      Todas
 *  $SEEALSO$
 *      hb_installMathHandler(),hb_getMathHandlerStatus()
 *  $END$
 */

/*  $DOC$
 *  $FUNCNAME$
 *      hb_installMathHandler()
 *  $CATEGORY$
 *      Matem ticas API
 *  $ONELINER$
 *      Agrega un manejador de errores definido por el usuario
 *  $SYNTAX$
 *      C Prototype
 *
 *      #include <hbmath.h>
 *      hb_installMathHandler (HB_MATH_HANDLERPROC handlerproc)
 *                              --> HB_MATH_HANDLERHANDLE handle
 *  $ARGUMENTS$
 *      <handlerproc> Manejador para el manejador de errores
 *  $RETURNS$
 *      <handle>      Identificador del manejador en la cadena de
 *                    identificadores.
 *  $DESCRIPTION$
 *
 *  $EXAMPLES$
 *
 *  $STATUS$
 *      R
 *  $COMPLIANCE$
 *      Compatibilidad no es aplicable a las llamadas a las APIs.
 *  $FILES$
 *      Se encuentra en la librer¡a rtl
 *  $PLATFORMS$
 *      Todas
 *  $SEEALSO$
 *      hb_deinstallMathHandler()
 *  $END$
 */

/*  $DOC$
 *  $FUNCNAME$
 *      hb_deinstallMathHandler()
 *  $CATEGORY$
 *      Matem ticas API
 *  $ONELINER$
 *      Quita un manejador de errores definido por el usuario.
 *  $SYNTAX$
 *      C Prototype
 *
 *      #include <hbmath.h>
 *      hb_deinstallMathHandler (HB_MATH_HANDLERHANDLE handle)
 *                                --> int iSuccess
 *  $ARGUMENTS$
 *      <handle>      Identificador devuelto por hb_installMathHandler()
 *  $RETURNS$
 *      <iSuccess>    Como termino el proceso.
 *  $DESCRIPTION$
 *
 *  $EXAMPLES$
 *
 *  $STATUS$
 *      R
 *  $COMPLIANCE$
 *      Compatibilidad no es aplicable a las llamadas a las APIs.
 *  $FILES$
 *      Se encuentra en la librer¡a rtl
 *  $PLATFORMS$
 *      Todas
 *  $SEEALSO$
 *      hb_installMathHandler()
 *  $END$
 */

/*  $DOC$
 *  $FUNCNAME$
 *      hb_setMathHandlerStatus()
 *  $CATEGORY$
 *      Matem ticas API
 *  $ONELINER$
 *      Pone el estado del manejador de errores definido por el usuario
 *  $SYNTAX$
 *      C Prototype
 *
 *      #include <hbmath.h>
 *      hb_setMathHandlerStatus (HB_MATH_HANDLERHANDLE handle, int status)
 *                                --> int iSuccess
 *  $ARGUMENTS$
 *      <handle>      Identificador devuelto por hb_installMathHandler()
 *      <status>      nuevo valor del estado, puede ser uno de los
 *                    siguientes:
 *                       HB_MATH_HANDLER_STATUS_INACTIVE
 *                         --> identificador presente pero no activo
 *                       HB_MATH_HANDLER_STATUS_ACTIVE
 *                         --> identificador presente y activo
 *  $RETURNS$
 *      iSuccess      Como termino el proceso.
 *  $DESCRIPTION$
 *
 *  $EXAMPLES$
 *
 *  $STATUS$
 *      R
 *  $COMPLIANCE$
 *      Compatibilidad no es aplicable a las llamadas a las APIs.
 *  $FILES$
 *      Se encuentra en la librer¡a rtl
 *  $PLATFORMS$
 *      Todas
 *  $SEEALSO$
 *      hb_getMathHandlerStatus()
 *  $END$
 */

/*  $DOC$
 *  $FUNCNAME$
 *      hb_getMathHandlerStatus()
 *  $CATEGORY$
 *      Matem ticas API
 *  $ONELINER$
 *      Lee el estado del manejador de errores definido por el usuario
 *  $SYNTAX$
 *      C Prototype
 *
 *      #include <hbmath.h>
 *      hb_getMathHandlerStatus (HB_MATH_HANDLERHANDLE handle)
 *                                --> int iStatus
 *  $ARGUMENTS$
 *      <handle>      Identificador devuelto por hb_installMathHandler()
 *  $RETURNS$
 *      <iStatus>     Estado del manejador de errores.
 *  $DESCRIPTION$
 *
 *  $EXAMPLES$
 *
 *  $STATUS$
 *      R
 *  $COMPLIANCE$
 *      Compatibilidad no es aplicable a las llamadas a las APIs.
 *  $FILES$
 *      Se encuentra en la librer¡a rtl
 *  $PLATFORMS$
 *      Todas
 *  $SEEALSO$
 *      hb_setMathHandlerStatus()
 *  $END$
 */