1
0
Fork 0
cl-sites/HyperSpec-7-0/HyperSpec/Body/f_float.htm

66 lines
4.1 KiB
HTML
Raw Normal View History

2024-04-01 10:24:07 +02:00
<!-- 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 FLOAT</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_dec_fl.htm">
<LINK REL=UP HREF="c_number.htm">
<LINK REL=NEXT HREF="f_floatp.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_dec_fl.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_floatp.htm"><IMG WIDTH=40 HEIGHT=40 ALT="[Next]" SRC="../Graphics/Next.gif" ALIGN=Bottom></A></H1>
<HR>
<A NAME="float"><I>Function</I> <B>FLOAT</B></A> <P>
<P><B>Syntax:</B><P>
<P>
<B>float</B> <I>number <TT>&amp;optional</TT> prototype</I> =&gt; <I>float</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>prototype</I>---a <A REL=DEFINITION HREF="26_glo_f.htm#float"><I>float</I></A>. <P>
<I>float</I>---a <A REL=DEFINITION HREF="26_glo_f.htm#float"><I>float</I></A>. <P>
<P><B>Description:</B><P>
<P>
<A REL=DEFINITION HREF="#float"><B>float</B></A> converts a <A REL=DEFINITION HREF="t_real.htm#real"><I>real</I></A> number to a <A REL=DEFINITION HREF="26_glo_f.htm#float"><I>float</I></A>. <P>
If a <I>prototype</I> is supplied, a <A REL=DEFINITION HREF="26_glo_f.htm#float"><I>float</I></A> is returned that is mathematically equal to <I>number</I> but has the same format as <I>prototype</I>. <P>
If <I>prototype</I> is not supplied, then if the <I>number</I> is already a <A REL=DEFINITION HREF="26_glo_f.htm#float"><I>float</I></A>, it is returned; otherwise, a <A REL=DEFINITION HREF="26_glo_f.htm#float"><I>float</I></A> is returned that is mathematically equal to <I>number</I> but is a <A REL=DEFINITION HREF="26_glo_s.htm#single_float"><I>single float</I></A>. <P>
<P><B>Examples:</B><P>
<P>
<PRE>
(float 0) =&gt; 0.0
(float 1 .5) =&gt; 1.0
(float 1.0) =&gt; 1.0
(float 1/2) =&gt; 0.5
=&gt; 1.0d0
OR=&gt; 1.0
(eql (float 1.0 1.0d0) 1.0d0) =&gt; <A REL=DEFINITION HREF="26_glo_t.htm#true">true</A>
</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_coerce.htm#coerce"><B>coerce</B></A> <P>
<P><B>Notes:</B> None.
<P>
<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>