mmin

Calc Software Package for Number Calc

NAME
    mmin - least-absolute-value residues modulo a specified number

SYNOPSIS
    mmin(x, md)

TYPES
    x		number (real or complex), matrix, list, object
    md		real

    return	real

DESCRIPTION
    If x is real and md is nonzero, mmin(x, md) returns the real
    number v congruent to x modulo md for which abs(v) <= md/2
    and if abs(v) = md/2, then v = md/2.

    If x is real and md is zero, mmin(x, md) returns x.

    For complex, matrix, list or object x, see the help file for mod: for
    all x and md, mmin(x, md) returns the same as mod(x, md, 16).

EXAMPLE
    ; print mmin(3,6), mmin(4,6), mmin(5,6), mmin(6,6), mmin(7,6)
    3 -2 -1 0 1

    ; print mmin(1.25, 2.5), mmin(-1.25,2.5), mmin(1.25, -2.5)
    1.25 1.25 -1.25

LIMITS
    none

LINK LIBRARY
    none

SEE ALSO
    mod

## Copyright (C) 1999  Landon Curt Noll
##
## Calc is open software; you can redistribute it and/or modify it under
## the terms of the version 2.1 of the GNU Lesser General Public License
## as published by the Free Software Foundation.
##
## Calc is distributed in the hope that it will be useful, but WITHOUT
## ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
## or FITNESS FOR A PARTICULAR PURPOSE.	 See the GNU Lesser General
## Public License for more details.
##
## A copy of version 2.1 of the GNU Lesser General Public License is
## distributed with calc under the filename COPYING-LGPL.  You should have
## received a copy with calc; if not, write to Free Software Foundation, Inc.
## 59 Temple Place, Suite 330, Boston, MA  02111-1307, USA.
##
## @(#) $Revision: 29.3 $
## @(#) $Id: mmin,v 29.3 2006/05/07 07:25:46 chongo Exp $
## @(#) $Source: /usr/local/src/cmd/calc/help/RCS/mmin,v $
##
## Under source code control:	1995/12/18 03:30:59
## File existed as early as:	1995
##
## chongo <was here> /\oo/\	http://www.isthe.com/chongo/
## Share and enjoy!  :-)	http://www.isthe.com/chongo/tech/comp/calc/