66 lines
5.3 KiB
HTML
66 lines
5.3 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 COMPLEX</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_cis.htm">
|
|
<LINK REL=UP HREF="c_number.htm">
|
|
<LINK REL=NEXT HREF="f_comp_3.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_cis.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_comp_3.htm"><IMG WIDTH=40 HEIGHT=40 ALT="[Next]" SRC="../Graphics/Next.gif" ALIGN=Bottom></A></H1>
|
|
|
|
<HR>
|
|
|
|
<A NAME="complex"><I>Function</I> <B>COMPLEX</B></A> <P>
|
|
<P><B>Syntax:</B><P>
|
|
<P>
|
|
|
|
<B>complex</B> <I>realpart <TT>&optional</TT> imagpart</I> => <I>complex</I><P>
|
|
<P>
|
|
<P><B>Arguments and Values:</B><P>
|
|
<P>
|
|
<I>realpart</I>---a <A REL=DEFINITION HREF="t_real.htm#real"><I>real</I></A>. <P>
|
|
<I>imagpart</I>---a <A REL=DEFINITION HREF="t_real.htm#real"><I>real</I></A>. <P>
|
|
<I>complex</I>---a <A REL=DEFINITION HREF="26_glo_r.htm#rational"><I>rational</I></A> or a <A REL=DEFINITION HREF="26_glo_c.htm#complex"><I>complex</I></A>. <P>
|
|
<P><B>Description:</B><P>
|
|
<P>
|
|
<A REL=DEFINITION HREF="#complex"><B>complex</B></A> returns a <A REL=DEFINITION HREF="26_glo_n.htm#number"><I>number</I></A> whose real part is <I>realpart</I> and whose imaginary part is <I>imagpart</I>. <P>
|
|
If <I>realpart</I> is a <A REL=DEFINITION HREF="26_glo_r.htm#rational"><I>rational</I></A> and <I>imagpart</I> is the <A REL=DEFINITION HREF="26_glo_r.htm#rational"><I>rational</I></A> number zero, the result of <A REL=DEFINITION HREF="#complex"><B>complex</B></A> is <I>realpart</I>, a <A REL=DEFINITION HREF="26_glo_r.htm#rational"><I>rational</I></A>. Otherwise, the result is a <A REL=DEFINITION HREF="26_glo_c.htm#complex"><I>complex</I></A>. <P>
|
|
If either <I>realpart</I> or <I>imagpart</I> is a <A REL=DEFINITION HREF="26_glo_f.htm#float"><I>float</I></A>, the non-<A REL=DEFINITION HREF="26_glo_f.htm#float"><I>float</I></A> is converted to a <A REL=DEFINITION HREF="26_glo_f.htm#float"><I>float</I></A> before the <A REL=DEFINITION HREF="26_glo_c.htm#complex"><I>complex</I></A> is created. If <I>imagpart</I> is not supplied, the imaginary part is a zero of the same <A REL=DEFINITION HREF="26_glo_t.htm#type"><I>type</I></A> as <I>realpart</I>; i.e., <TT>(coerce 0 (type-of </TT><I>realpart</I><TT>))</TT> is effectively used. <P>
|
|
<P>
|
|
Type upgrading implies a movement upwards in the type hierarchy lattice. In the case of <A REL=DEFINITION HREF="26_glo_c.htm#complex"><I>complexes</I></A>, the <I>type-specifier</I> must be a subtype of <TT>(upgraded-complex-part-type </TT><I>type-specifier</I><TT>)</TT>. If <I>type-specifier1</I> is a subtype of <I>type-specifier2</I>, then <TT>(upgraded-complex-element-type '</TT><I>type-specifier1</I><TT>)</TT> must also be a subtype of <TT>(upgraded-complex-element-type '</TT><I>type-specifier2</I><TT>)</TT>. Two disjoint types can be upgraded into the same thing. <P>
|
|
<P>
|
|
<P><B>Examples:</B><P>
|
|
|
|
<PRE>
|
|
(complex 0) => 0
|
|
(complex 0.0) => #C(0.0 0.0)
|
|
(complex 1 1/2) => #C(1 1/2)
|
|
(complex 1 .99) => #C(1.0 0.99)
|
|
(complex 3/2 0.0) => #C(1.5 0.0)
|
|
</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_realpa.htm#realpart"><B>realpart</B></A>, <A REL=DEFINITION HREF="f_realpa.htm#imagpart"><B>imagpart</B></A>, <A REL=CHILD HREF="02_dhk.htm">Section 2.4.8.11 (Sharpsign C)</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/iss015.htm">ARRAY-TYPE-ELEMENT-TYPE-SEMANTICS:UNIFY-UPGRADING</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>
|