1
0
Fork 0
cl-sites/novaspec.org/cl/f_array-in-bounds-p.html

266 lines
5.4 KiB
HTML
Raw Normal View History

2025-02-05 18:52:26 +01:00
<!DOCTYPE HTML>
<HTML LANG="en-us"
><HEAD
><TITLE
>array-in-bounds-p | Common Lisp Nova Spec</TITLE
><META CHARSET="US-ASCII"
><LINK REL="canonical" HREF="f_array-in-bounds-p.html"
><LINK REL="next" HREF="f_array-rank.html" TYPE="text/html" TITLE="array-rank"
><LINK REL="prev" HREF="f_array-displacement.html" TYPE="text/html" TITLE="array-displacement"
><LINK REL="up" HREF="15_2_Arrays_Dictionary.html" TYPE="text/html" TITLE="15.2 Arrays 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="15_Arrays.html"
>15. Arrays</A
></SPAN
> <SPAN CLASS="breadcrumb-item"
>&#8594; <A HREF="15_2_Arrays_Dictionary.html"
>15.2 Arrays Dictionary</A
></SPAN
> <SPAN CLASS="breadcrumb-item"
>&#8594; <A HREF="f_array-in-bounds-p.html"
>array-in-bounds-p</A
></SPAN
></DIV
><DIV CLASS="apropos"
><DIV CLASS="apropos-io"
><A HREF="f_array-displacement.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="f_array-rank.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="array-in-bounds-p"
></SPAN
><B
>array-in-bounds-p</B
></TD
><TD ALIGN="RIGHT" VALIGN="BASELINE" WIDTH="0" NOWRAP="NOWRAP" CLASS="ftype"
><I
>Function</I
></TD
></TR
></TABLE
><HR
></DIV
><UL CLASS="subtoc"
></UL
><DL
><DT
><B
>Syntax</B
></DT
><DD
><P CLASS="j"
><B
>array-in-bounds-p</B
> <SPAN CLASS="cmssi"
>array</SPAN
> <SPAN CLASS="cmtt"
>&amp;rest</SPAN
> <SPAN CLASS="cmssi"
>subscripts</SPAN
> <SPAN CLASS="arrow"
>&#8594;</SPAN
> <SPAN CLASS="cmssi"
>generalized-boolean</SPAN
></P
></DD
><DT
><B
>Arguments and Values</B
></DT
><DD
><P CLASS="j"
><VAR CLASS="param"
>array</VAR
> &#8212; an <A HREF="26_1_Glossary.html#array"
><EM CLASS="term"
>array</EM
></A
>. </P
><P CLASS="j"
><VAR CLASS="param"
>subscripts</VAR
> &#8212; a list of <A HREF="26_1_Glossary.html#integer"
><EM CLASS="term"
>integers</EM
></A
> of length equal to the <A HREF="26_1_Glossary.html#rank"
><EM CLASS="term"
>rank</EM
></A
> of the <A HREF="26_1_Glossary.html#array"
><EM CLASS="term"
>array</EM
></A
>. </P
><P CLASS="j"
><VAR CLASS="param"
>generalized-boolean</VAR
> &#8212; a <A HREF="26_1_Glossary.html#generalized_boolean"
><EM CLASS="term"
>generalized boolean</EM
></A
>.</P
></DD
><DT
><B
>Description</B
></DT
><DD
><P CLASS="j"
>Returns <A HREF="26_1_Glossary.html#true"
><EM CLASS="term"
>true</EM
></A
> if the <VAR CLASS="param"
>subscripts</VAR
> are all in bounds for <VAR CLASS="param"
>array</VAR
>; otherwise returns <A HREF="26_1_Glossary.html#false"
><EM CLASS="term"
>false</EM
></A
>. (If <VAR CLASS="param"
>array</VAR
> is a <A HREF="26_1_Glossary.html#vector"
><EM CLASS="term"
>vector</EM
></A
> with a <A HREF="26_1_Glossary.html#fill_pointer"
><EM CLASS="term"
>fill pointer</EM
></A
>, that <A HREF="26_1_Glossary.html#fill_pointer"
><EM CLASS="term"
>fill pointer</EM
></A
> is ignored.)</P
></DD
><DT
><B
>Examples</B
></DT
><DD
><PRE CLASS="screen"
>(setq a (make-array '(7 11) :element-type 'string-char))
(array-in-bounds-p a 0 0) <SPAN CLASS="cmsy"
><SPAN CLASS="arrow"
>&#8594;</SPAN
></SPAN
> <A HREF="26_1_Glossary.html#true"
><EM CLASS="term"
>true</EM
></A
>
(array-in-bounds-p a 6 10) <SPAN CLASS="cmsy"
><SPAN CLASS="arrow"
>&#8594;</SPAN
></SPAN
> <A HREF="26_1_Glossary.html#true"
><EM CLASS="term"
>true</EM
></A
>
(array-in-bounds-p a 0 -1) <SPAN CLASS="cmsy"
><SPAN CLASS="arrow"
>&#8594;</SPAN
></SPAN
> <A HREF="26_1_Glossary.html#false"
><EM CLASS="term"
>false</EM
></A
>
(array-in-bounds-p a 0 11) <SPAN CLASS="cmsy"
><SPAN CLASS="arrow"
>&#8594;</SPAN
></SPAN
> <A HREF="26_1_Glossary.html#false"
><EM CLASS="term"
>false</EM
></A
>
(array-in-bounds-p a 7 0) <SPAN CLASS="cmsy"
><SPAN CLASS="arrow"
>&#8594;</SPAN
></SPAN
> <A HREF="26_1_Glossary.html#false"
><EM CLASS="term"
>false</EM
></A
></PRE
></DD
><DT
><B
>See Also</B
></DT
><DD
><P CLASS="j"
><A HREF="f_array-dimensions.html" CLASS="funref"
><B
>array-dimensions</B
></A
></P
></DD
><DT
><B
>Notes</B
></DT
><DD
><PRE CLASS="screen"
>(array-in-bounds-p array subscripts)
<SPAN CLASS="cmsy"
><SPAN STYLE="font-size:16px;vertical-align:-2px"
>&#8801;</SPAN
></SPAN
> (and (not (some #'minusp (list subscripts)))
(every #'&lt; (list subscripts) (array-dimensions array)))</PRE
></DD
></DL
></DIV
></DIV
><DIV CLASS="footer"
><DIV CLASS="btmnav"
><A HREF="f_array-displacement.html" CLASS="prev"
>&#8592;</A
><A HREF="f_array-rank.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
>