1
0
Fork 0
cl-sites/novaspec.org/cl/m_optimize.html
2025-02-05 18:52:26 +01:00

467 lines
No EOL
9.5 KiB
HTML

<!DOCTYPE HTML>
<HTML LANG="en-us"
><HEAD
><TITLE
>optimize | Common Lisp Nova Spec</TITLE
><META CHARSET="US-ASCII"
><LINK REL="canonical" HREF="m_optimize.html"
><LINK REL="next" HREF="m_special.html" TYPE="text/html" TITLE="special"
><LINK REL="prev" HREF="m_declaration.html" TYPE="text/html" TITLE="declaration"
><LINK REL="up" HREF="3_8_Evaluation_and_Compilation_Dictionary.html" TYPE="text/html" TITLE="3.8 Evaluation and Compilation Dictionary"
><LINK REL="start" HREF="index.html" TYPE="text/html" TITLE="Common Lisp Nova Spec"
><META NAME="VIEWPORT" CONTENT="width=device-width, initial-scale=1.0"
><LINK REL="STYLESHEET" HREF="dpans.css%3F3909942064.css"
><SCRIPT SRC="dpans.js%3F3909942064"
></SCRIPT
><SCRIPT SRC="apropos.js%3F3909942064"
></SCRIPT
></HEAD
><BODY
><DIV
><DIV CLASS="topnav"
><DIV CLASS="breadcrumb"
><SPAN CLASS="breadcrumb-item"
><A HREF="index.html"
>Common Lisp Nova Spec</A
></SPAN
> <SPAN CLASS="breadcrumb-item"
>&#8594; <A HREF="3_Evaluation_and_Compilation.html"
>3. Evaluation and Compilation</A
></SPAN
> <SPAN CLASS="breadcrumb-item"
>&#8594; <A HREF="3_8_Evaluation_and_Compilation_Dictionary.html"
>3.8 Evaluation and Compilation Dictionary</A
></SPAN
> <SPAN CLASS="breadcrumb-item"
>&#8594; <A HREF="m_optimize.html"
>optimize</A
></SPAN
></DIV
><DIV CLASS="apropos"
><DIV CLASS="apropos-io"
><A HREF="m_declaration.html" CLASS="prev"
>&#8592;</A
><SPAN ID="apropos-label"
>Apropos </SPAN
><INPUT ID="apropos" AUTOFOCUS="AUTOFOCUS" PLACEHOLDER="Type here to search" ONINPUT="aproposInput(this);" ONKEYUP="aproposKeyup(event);" ONCHANGE="aproposChange(this);" ONFOCUS="aproposFocus(this);" ONFOCUSOUT="aproposFocusout(this);"
><A HREF="m_special.html" CLASS="next"
>&#8594;</A
></DIV
><DIV ID="apropos-res"
></DIV
></DIV
></DIV
><DIV CLASS="matter"
><DIV CLASS="com"
><DIV CLASS="begincom"
><HR
><TABLE WIDTH="100%" CELLSPACING="0" CELLPADDING="0"
><TR
><TD ALIGN="LEFT" VALIGN="BASELINE" WIDTH="100%" CLASS="name"
><SPAN CLASS="idx" DATA-KIND="idxref" DATA-TERM="optimize"
></SPAN
><B
>optimize</B
></TD
><TD ALIGN="RIGHT" VALIGN="BASELINE" WIDTH="0" NOWRAP="NOWRAP" CLASS="ftype"
><I
>Declaration</I
></TD
></TR
></TABLE
><HR
></DIV
><UL CLASS="subtoc"
></UL
><DL
><DT
><B
>Syntax</B
></DT
><DD
><P CLASS="j"
><CODE CLASS="f"
>(optimize <SPAN CLASS="cmsy"
>{</SPAN
><VAR CLASS="param"
>quality</VAR
> | (<VAR CLASS="param"
>quality</VAR
> <VAR CLASS="param"
>value</VAR
>)<SPAN CLASS="cmsy"
>}</SPAN
><SPAN CLASS="cmr"
>*</SPAN
>)</CODE
></P
></DD
><DT
><SPAN CLASS="idx" DATA-KIND="idxref" DATA-TERM="compilation-speed"
></SPAN
><SPAN CLASS="idx" DATA-KIND="idxref" DATA-TERM="debug"
></SPAN
><SPAN CLASS="idx" DATA-KIND="idxref" DATA-TERM="safety"
></SPAN
><SPAN CLASS="idx" DATA-KIND="idxref" DATA-TERM="space"
></SPAN
><SPAN CLASS="idx" DATA-KIND="idxref" DATA-TERM="speed"
></SPAN
><B
>Arguments</B
></DT
><DD
><P CLASS="j"
><VAR CLASS="param"
>quality</VAR
> &#8212; an <A HREF="26_1_Glossary.html#optimize_quality"
><EM CLASS="term"
>optimize quality</EM
></A
>. </P
><P CLASS="j"
><VAR CLASS="param"
>value</VAR
> &#8212; one of the <A HREF="26_1_Glossary.html#integer"
><EM CLASS="term"
>integers</EM
></A
> <CODE CLASS="f"
>0</CODE
>, <CODE CLASS="f"
>1</CODE
>, <CODE CLASS="f"
>2</CODE
>, or <CODE CLASS="f"
>3</CODE
>.</P
></DD
><DT
><B
>Valid Context</B
></DT
><DD
><P CLASS="j"
><A HREF="26_1_Glossary.html#declaration"
><EM CLASS="term"
>declaration</EM
></A
> or <A HREF="26_1_Glossary.html#proclamation"
><EM CLASS="term"
>proclamation</EM
></A
></P
></DD
><DT
><B
>Description</B
></DT
><DD
><P CLASS="j"
>Advises the compiler that each <VAR CLASS="param"
>quality</VAR
> should be given attention according to the specified corresponding <VAR CLASS="param"
>value</VAR
>. Each <VAR CLASS="param"
>quality</VAR
> must be a <A HREF="26_1_Glossary.html#symbol"
><EM CLASS="term"
>symbol</EM
></A
> naming an <A HREF="26_1_Glossary.html#optimize_quality"
><EM CLASS="term"
>optimize quality</EM
></A
>; the names and meanings of the standard <VAR CLASS="param"
>optimize qualities</VAR
> are shown in Figure 3&#8211;25.</P
><FIGURE CLASS="boxfig"
><DIV CLASS="figbody"
><TABLE CELLSPACING="0" CELLPADDING="0" RULES="GROUPS" STYLE="margin: 1ex 0" WIDTH="100%"
><THEAD
><TR
><TH ALIGN="LEFT" VALIGN="BASELINE" STYLE=";padding-right:3px"
><B
>Name</B
></TH
><TH ALIGN="LEFT" VALIGN="BASELINE" STYLE="padding-left:3px;"
> <B
>Meaning</B
></TH
></TR
></THEAD
><TBODY
><TR
><TD ALIGN="LEFT" VALIGN="BASELINE" STYLE=";padding-right:3px"
> <SPAN CLASS="declref"
><B
>compilation-speed</B
></SPAN
></TD
><TD ALIGN="LEFT" VALIGN="BASELINE" STYLE="padding-left:3px;"
> <SPAN CLASS="cmr"
>speed</SPAN
> <SPAN CLASS="cmr"
>of</SPAN
> <SPAN CLASS="cmr"
>the</SPAN
> <SPAN CLASS="cmr"
>compilation</SPAN
> <SPAN CLASS="cmr"
>process</SPAN
></TD
></TR
><TR
><TD ALIGN="LEFT" VALIGN="BASELINE" STYLE=";padding-right:3px"
> <SPAN CLASS="declref"
><B
>debug</B
></SPAN
></TD
><TD ALIGN="LEFT" VALIGN="BASELINE" STYLE="padding-left:3px;"
> <SPAN CLASS="cmr"
>ease</SPAN
> <SPAN CLASS="cmr"
>of</SPAN
> <SPAN CLASS="cmr"
>debugging</SPAN
></TD
></TR
><TR
><TD ALIGN="LEFT" VALIGN="BASELINE" STYLE=";padding-right:3px"
> <SPAN CLASS="declref"
><B
>safety</B
></SPAN
></TD
><TD ALIGN="LEFT" VALIGN="BASELINE" STYLE="padding-left:3px;"
> <SPAN CLASS="cmr"
>run-time</SPAN
> <SPAN CLASS="cmr"
>error</SPAN
> <SPAN CLASS="cmr"
>checking</SPAN
></TD
></TR
><TR
><TD ALIGN="LEFT" VALIGN="BASELINE" STYLE=";padding-right:3px"
> <SPAN CLASS="declref"
><B
>space</B
></SPAN
></TD
><TD ALIGN="LEFT" VALIGN="BASELINE" STYLE="padding-left:3px;"
> <SPAN CLASS="cmr"
>both</SPAN
> <SPAN CLASS="cmr"
>code</SPAN
> <SPAN CLASS="cmr"
>size</SPAN
> <SPAN CLASS="cmr"
>and</SPAN
> <SPAN CLASS="cmr"
>run-time</SPAN
> <SPAN CLASS="cmr"
>space</SPAN
></TD
></TR
><TR
><TD ALIGN="LEFT" VALIGN="BASELINE" STYLE=";padding-right:3px"
> <SPAN CLASS="declref"
><B
>speed</B
></SPAN
></TD
><TD ALIGN="LEFT" VALIGN="BASELINE" STYLE="padding-left:3px;"
> <SPAN CLASS="cmr"
>speed</SPAN
> <SPAN CLASS="cmr"
>of</SPAN
> <SPAN CLASS="cmr"
>the</SPAN
> <SPAN CLASS="cmr"
>object</SPAN
> <SPAN CLASS="cmr"
>code</SPAN
></TD
></TR
></TBODY
></TABLE
></DIV
><FIGCAPTION CLASS="caption"
><B
>Figure 3&#8211;25. Optimize qualities</B
></FIGCAPTION
></FIGURE
><P CLASS="j"
>There may be other, <A HREF="26_1_Glossary.html#implementation-defined"
><EM CLASS="term"
>implementation-defined</EM
></A
> <EM CLASS="term"
>optimize qualities</EM
>. </P
><P CLASS="j"
>A <VAR CLASS="param"
>value</VAR
> <CODE CLASS="f"
>0</CODE
> means that the corresponding <VAR CLASS="param"
>quality</VAR
> is totally unimportant, and <CODE CLASS="f"
>3</CODE
> that the <VAR CLASS="param"
>quality</VAR
> is extremely important; <CODE CLASS="f"
>1</CODE
> and <CODE CLASS="f"
>2</CODE
> are intermediate values, with <CODE CLASS="f"
>1</CODE
> the neutral value. <CODE CLASS="f"
>(<VAR CLASS="param"
>quality</VAR
> 3)</CODE
> can be abbreviated to <VAR CLASS="param"
>quality</VAR
>. </P
><P CLASS="j"
>Note that <A HREF="26_1_Glossary.html#code"
><EM CLASS="term"
>code</EM
></A
> which has the optimization <CODE CLASS="f"
>(safety 3)</CODE
>, or just <SPAN CLASS="typeref"
><B
>safety</B
></SPAN
>, is called <A HREF="26_1_Glossary.html#safe"
><EM CLASS="term"
>safe</EM
></A
> <A HREF="26_1_Glossary.html#code"
><EM CLASS="term"
>code</EM
></A
>. </P
><P CLASS="j"
>The consequences are unspecified if a <VAR CLASS="param"
>quality</VAR
> appears more than once with <A HREF="26_1_Glossary.html#different"
><EM CLASS="term"
>different</EM
></A
> <VAR CLASS="param"
>values</VAR
>.</P
></DD
><DT
><B
>Examples</B
></DT
><DD
><PRE CLASS="screen"
>(defun often-used-subroutine (x y)
(declare (optimize (safety 2)))
(error-check x y)
(hairy-setup x)
(do ((i 0 (+ i 1))
(z x (cdr z)))
((null z))
;; This inner loop really needs to burn.
(declare (optimize speed))
(declare (fixnum i))
))</PRE
></DD
><DT
><B
>See Also</B
></DT
><DD
><P CLASS="j"
><A HREF="m_declare.html" CLASS="misc"
><B
>declare</B
></A
>, <A HREF="f_declaim.html" CLASS="macref"
><B
>declaim</B
></A
>, <A HREF="f_proclaim.html" CLASS="funref"
><B
>proclaim</B
></A
>, <A HREF="3_3_Declarations.html#sec_3_3_4" CLASS="secref"
><SPAN CLASS="cmr"
>Section</SPAN
> <SPAN CLASS="cmr"
>3.3.4</SPAN
> <SPAN CLASS="cmr"
>(Declaration</SPAN
> <SPAN CLASS="cmr"
>Scope)</SPAN
></A
></P
></DD
><DT
><B
>Notes</B
></DT
><DD
><P CLASS="j"
>An <A HREF="m_optimize.html" CLASS="declref"
><B
>optimize</B
></A
> declaration never applies to either a <A HREF="26_1_Glossary.html#variable"
><EM CLASS="term"
>variable</EM
></A
> or a <A HREF="26_1_Glossary.html#function"
><EM CLASS="term"
>function</EM
></A
> <A HREF="26_1_Glossary.html#binding"
><EM CLASS="term"
>binding</EM
></A
>. An <A HREF="m_optimize.html" CLASS="declref"
><B
>optimize</B
></A
> declaration can only be a <A HREF="26_1_Glossary.html#free_declaration"
><EM CLASS="term"
>free declaration</EM
></A
>. For more information, see <A HREF="3_3_Declarations.html#sec_3_3_4" CLASS="secref"
><SPAN CLASS="cmr"
>Section</SPAN
> <SPAN CLASS="cmr"
>3.3.4</SPAN
> <SPAN CLASS="cmr"
>(Declaration</SPAN
> <SPAN CLASS="cmr"
>Scope)</SPAN
></A
>.</P
></DD
></DL
></DIV
></DIV
><DIV CLASS="footer"
><DIV CLASS="btmnav"
><A HREF="m_declaration.html" CLASS="prev"
>&#8592;</A
><A HREF="m_special.html" CLASS="next"
>&#8594;</A
></DIV
><DIV CLASS="trail"
>Conversion to HTML copyright 2023 by Gilbert Baumann</DIV
></DIV
></DIV
><SCRIPT
>domReady();</SCRIPT
></BODY
></HTML
>