65 lines
4.2 KiB
HTML
65 lines
4.2 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 ARRAY-IN-BOUNDS-P</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_ar_dis.htm">
|
|
<LINK REL=UP HREF="c_arrays.htm">
|
|
<LINK REL=NEXT HREF="f_ar_ran.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_ar_dis.htm"><IMG WIDTH=40 HEIGHT=40 ALT="[Previous]" SRC="../Graphics/Prev.gif" ALIGN=Bottom></A><A REL=UP HREF="c_arrays.htm"><IMG WIDTH=40 HEIGHT=40 ALT="[Up]" SRC="../Graphics/Up.gif" ALIGN=Bottom></A><A REL=NEXT HREF="f_ar_ran.htm"><IMG WIDTH=40 HEIGHT=40 ALT="[Next]" SRC="../Graphics/Next.gif" ALIGN=Bottom></A></H1>
|
|
|
|
<HR>
|
|
|
|
<A NAME="array-in-bounds-p"><I>Function</I> <B>ARRAY-IN-BOUNDS-P</B></A> <P>
|
|
<P><B>Syntax:</B><P>
|
|
<P>
|
|
|
|
<B>array-in-bounds-p</B> <I>array <TT>&rest</TT> subscripts</I> => <I>generalized-boolean</I><P>
|
|
<P>
|
|
<P><B>Arguments and Values:</B><P>
|
|
<P>
|
|
<I>array</I>---an <A REL=DEFINITION HREF="26_glo_a.htm#array"><I>array</I></A>. <P>
|
|
<I>subscripts</I>---a list of <A REL=DEFINITION HREF="26_glo_i.htm#integer"><I>integers</I></A> of length equal to the <A REL=DEFINITION HREF="26_glo_r.htm#rank"><I>rank</I></A> of the <A REL=DEFINITION HREF="26_glo_a.htm#array"><I>array</I></A>. <P>
|
|
<I>generalized-boolean</I>---a <A REL=DEFINITION HREF="26_glo_g.htm#generalized_boolean"><I>generalized boolean</I></A>. <P>
|
|
<P><B>Description:</B><P>
|
|
<P>
|
|
Returns <A REL=DEFINITION HREF="26_glo_t.htm#true"><I>true</I></A> if the <I>subscripts</I> are all in bounds for <I>array</I>; otherwise returns <A REL=DEFINITION HREF="26_glo_f.htm#false"><I>false</I></A>. (If <I>array</I> is a <A REL=DEFINITION HREF="26_glo_v.htm#vector"><I>vector</I></A> with a <A REL=DEFINITION HREF="26_glo_f.htm#fill_pointer"><I>fill pointer</I></A>, that <A REL=DEFINITION HREF="26_glo_f.htm#fill_pointer"><I>fill pointer</I></A> is ignored.) <P>
|
|
<P><B>Examples:</B><P>
|
|
|
|
<PRE>
|
|
(setq a (make-array '(7 11) :element-type 'string-char))
|
|
(array-in-bounds-p a 0 0) => <A REL=DEFINITION HREF="26_glo_t.htm#true">true</A>
|
|
(array-in-bounds-p a 6 10) => <A REL=DEFINITION HREF="26_glo_t.htm#true">true</A>
|
|
(array-in-bounds-p a 0 -1) => <A REL=DEFINITION HREF="26_glo_f.htm#false">false</A>
|
|
(array-in-bounds-p a 0 11) => <A REL=DEFINITION HREF="26_glo_f.htm#false">false</A>
|
|
(array-in-bounds-p a 7 0) => <A REL=DEFINITION HREF="26_glo_f.htm#false">false</A>
|
|
</PRE>
|
|
</TT> <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_ar_d_1.htm#array-dimensions"><B>array-dimensions</B></A> <P>
|
|
<P><B>Notes:</B><P>
|
|
|
|
<PRE>
|
|
(array-in-bounds-p array subscripts)
|
|
== (and (not (some #'minusp (list subscripts)))
|
|
(every #'< (list subscripts) (array-dimensions array)))
|
|
</PRE>
|
|
</TT> <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>
|