1
0
Fork 0
cl-sites/HyperSpec-7-0/HyperSpec/Body/f_mod_r.htm
2024-04-01 10:24:07 +02:00

75 lines
4.7 KiB
HTML

<!-- Common Lisp HyperSpec (TM), version 7.0 generated by Kent M. Pitman on Mon, 11-Apr-2005 2:31am EDT -->
<HTML>
<HEAD>
<TITLE>CLHS: Function MOD, REM</TITLE>
<LINK HREF="../Data/clhs.css" REL="stylesheet" TYPE="text/css" />
<META HTTP-EQUIV="Author" CONTENT="Kent M. Pitman">
<META HTTP-EQUIV="Organization" CONTENT="LispWorks Ltd.">
<LINK REL=TOP HREF="../Front/index.htm">
<LINK REL=COPYRIGHT HREF="../Front/Help.htm#Legal">
<LINK REL=DISCLAIMER HREF="../Front/Help.htm#Disclaimer">
<LINK REL=PREV HREF="f_log.htm">
<LINK REL=UP HREF="c_number.htm">
<LINK REL=NEXT HREF="f_signum.htm">
</HEAD>
<BODY>
<H1><A REV=MADE HREF="http://www.lispworks.com/"><IMG WIDTH=80 HEIGHT=65 ALT="[LISPWORKS]" SRC="../Graphics/LWSmall.gif" ALIGN=Bottom></A><A REL=TOP HREF="../Front/index.htm"><IMG WIDTH=237 HEIGHT=65 ALT="[Common Lisp HyperSpec (TM)]" SRC="../Graphics/CLHS_Sm.gif" ALIGN=Bottom></A> <A REL=PREV HREF="f_log.htm"><IMG WIDTH=40 HEIGHT=40 ALT="[Previous]" SRC="../Graphics/Prev.gif" ALIGN=Bottom></A><A REL=UP HREF="c_number.htm"><IMG WIDTH=40 HEIGHT=40 ALT="[Up]" SRC="../Graphics/Up.gif" ALIGN=Bottom></A><A REL=NEXT HREF="f_signum.htm"><IMG WIDTH=40 HEIGHT=40 ALT="[Next]" SRC="../Graphics/Next.gif" ALIGN=Bottom></A></H1>
<HR>
<A NAME="mod"><A NAME="rem"><I>Function</I> <B>MOD, REM</B></A></A> <P>
<P><B>Syntax:</B><P>
<P>
<B>mod</B> <I>number divisor</I> =&gt; <I>modulus</I><P>
<B>rem</B> <I>number divisor</I> =&gt; <I>remainder</I><P>
<P>
<P><B>Arguments and Values:</B><P>
<P>
<I>number</I>---a <A REL=DEFINITION HREF="t_real.htm#real"><I>real</I></A>. <P>
<I>divisor</I>---a <A REL=DEFINITION HREF="t_real.htm#real"><I>real</I></A>. <P>
<I>modulus</I>, <I>remainder</I>---a <A REL=DEFINITION HREF="t_real.htm#real"><I>real</I></A>. <P>
<P><B>Description:</B><P>
<P>
<A REL=DEFINITION HREF="#mod"><B>mod</B></A> and <A REL=DEFINITION HREF="#rem"><B>rem</B></A> are generalizations of the modulus and remainder functions respectively. <P>
<A REL=DEFINITION HREF="#mod"><B>mod</B></A> performs the operation <A REL=DEFINITION HREF="f_floorc.htm#floor"><B>floor</B></A> on <I>number</I> and <I>divisor</I> and returns the remainder of the <A REL=DEFINITION HREF="f_floorc.htm#floor"><B>floor</B></A> operation. <P>
<A REL=DEFINITION HREF="#rem"><B>rem</B></A> performs the operation <A REL=DEFINITION HREF="f_floorc.htm#truncate"><B>truncate</B></A> on <I>number</I> and <I>divisor</I> and returns the remainder of the <A REL=DEFINITION HREF="f_floorc.htm#truncate"><B>truncate</B></A> operation. <P>
<A REL=DEFINITION HREF="#mod"><B>mod</B></A> and <A REL=DEFINITION HREF="#rem"><B>rem</B></A> are the modulus and remainder functions when <I>number</I> and <I>divisor</I> are <A REL=DEFINITION HREF="26_glo_i.htm#integer"><I>integers</I></A>. <P>
<P><B>Examples:</B><P>
<PRE>
(rem -1 5) =&gt; -1
(mod -1 5) =&gt; 4
(mod 13 4) =&gt; 1
(rem 13 4) =&gt; 1
(mod -13 4) =&gt; 3
(rem -13 4) =&gt; -1
(mod 13 -4) =&gt; -3
(rem 13 -4) =&gt; 1
(mod -13 -4) =&gt; -1
(rem -13 -4) =&gt; -1
(mod 13.4 1) =&gt; 0.4
(rem 13.4 1) =&gt; 0.4
(mod -13.4 1) =&gt; 0.6
(rem -13.4 1) =&gt; -0.4
</PRE>
</TT> <P>
<P><B>Side Effects:</B> None.
<P>
<P><B>Affected By:</B> None.
<P>
<P><B>Exceptional Situations:</B> None.
<P>
<P><B>See Also:</B><P>
<P>
<A REL=DEFINITION HREF="f_floorc.htm#floor"><B>floor</B></A>, <A REL=DEFINITION HREF="f_floorc.htm#truncate"><B>truncate</B></A> <P>
<P><B>Notes:</B><P>
<P>
The result of <A REL=DEFINITION HREF="#mod"><B>mod</B></A> is either zero or a <A REL=DEFINITION HREF="t_real.htm#real"><I>real</I></A> with the same sign as <I>divisor</I>. <P><HR>The following <A REL=META HREF="../Front/X3J13Iss.htm">X3J13 cleanup issue</A>, <I>not part of the specification</I>, applies to this section:<P><UL><LI> <A REL=CHILD HREF="../Issues/iss290.htm">REAL-NUMBER-TYPE:X3J13-MAR-89</A><P></UL><HR>
<A REL=NAVIGATOR HREF="../Front/StartPts.htm"><IMG WIDTH=80 HEIGHT=40 ALT="[Starting Points]" SRC="../Graphics/StartPts.gif" ALIGN=Bottom></A><A REL=TOC HREF="../Front/Contents.htm"><IMG WIDTH=80 HEIGHT=40 ALT="[Contents]" SRC="../Graphics/Contents.gif" ALIGN=Bottom></A><A REL=INDEX HREF="../Front/X_Master.htm"><IMG WIDTH=80 HEIGHT=40 ALT="[Index]" SRC="../Graphics/Index.gif" ALIGN=Bottom></A><A REL=INDEX HREF="../Front/X_Symbol.htm"><IMG WIDTH=80 HEIGHT=40 ALT="[Symbols]" SRC="../Graphics/Symbols.gif" ALIGN=Bottom></A><A REL=GLOSSARY HREF="../Body/26_a.htm"><IMG WIDTH=80 HEIGHT=40 ALT="[Glossary]" SRC="../Graphics/Glossary.gif" ALIGN=Bottom></A><A HREF="../Front/X3J13Iss.htm"><IMG WIDTH=80 HEIGHT=40 ALT="[Issues]" SRC="../Graphics/Issues.gif" ALIGN=Bottom></A><BR>
<A REL=COPYRIGHT HREF="../Front/Help.htm#Legal"><I>Copyright 1996-2005, LispWorks Ltd. All rights reserved.</I></A><P>
</BODY>
</HTML>