<-- Previous || Up || Next -->

Mod Sym Function
Math Reals Class

Public Function ModSym( _
      ByVal vX As Variant _
    , ByVal vY As Variant _
    ) As Variant

"Symmetric Modulo" or "Symmetric Modulus"
Floating-point symmetric modulus of real numbers.

Plots:
    Y = 6:
     *     *   | *     *
    *     *    |*     *
    -----*-----*-----*-----
        *     *|    *     *
       *     * |   *     *
      *     *  |  *     *
    Y = -6:
      *     *  |  *     *
     *     *   | *     *
    *     *    |*     *
    -----*-----*-----*-----
        *     *|    *     *
       *     * |   *     *

Examples:
    ModSym(1, 4) = 1
    ModSym(2, 4) = -2
    ModSym(3, 4) = -1
    ModSym(4, 4) = 0
    ModSym(5, 4) = 1
    ModSym(1, -4) = 1
    ModSym(2, -4) = 2
    ModSym(3, -4) = -1
    ModSym(4, -4) = 0
    ModSym(5, -4) = 1
See also:
    ModSymVerify Subroutine
    ModAlt Function
    ModStd Function
    ModOffsetByOne Function
    Floor Function
    Mod Operator (Visual Basic)
    Int Function (Visual Basic)
vX: See the Definition. Function returns Null if vX is Null or cannot be fixed up to a number.

vY: See the Definition. Function returns Null if vY is Null or cannot be fixed up to a number.

Definitions:

    X - Y * Floor(X / Y + .5)
    X - Y * Int(X / Y + .5)

Copyright 1996-1999 Entisoft
Entisoft Tools is a trademark of Entisoft.