marcuskammer/cl-sites
1
0
Fork 0
Code Activity
cl-sites/novaspec.org/cl/f_array-total-size.html
Marcus Kammer 00674f4c59
Add novaspec
2025-02-05 18:52:26 +01:00

268 lines
No EOL
5.4 KiB
HTML
Raw Blame History

<!DOCTYPE HTML>
<HTML LANG="en-us"
><HEAD
><TITLE
>array-total-size | Common Lisp Nova Spec</TITLE
><META CHARSET="US-ASCII"
><LINK REL="canonical" HREF="f_array-total-size.html"
><LINK REL="next" HREF="f_arrayp.html" TYPE="text/html" TITLE="arrayp"
><LINK REL="prev" HREF="f_array-row-major-index.html" TYPE="text/html" TITLE="array-row-major-index"
><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-total-size.html"
>array-total-size</A
></SPAN
></DIV
><DIV CLASS="apropos"
><DIV CLASS="apropos-io"
><A HREF="f_array-row-major-index.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_arrayp.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-total-size"
></SPAN
><B
>array-total-size</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-total-size</B
> <SPAN CLASS="cmssi"
>array</SPAN
> <SPAN CLASS="arrow"
>&#8594;</SPAN
> <SPAN CLASS="cmssi"
>size</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"
>size</VAR
> &#8212; a non-negative <A HREF="26_1_Glossary.html#integer"
><EM CLASS="term"
>integer</EM
></A
>.</P
></DD
><DT
><B
>Description</B
></DT
><DD
><P CLASS="j"
>Returns the <A HREF="26_1_Glossary.html#array_total_size"
><EM CLASS="term"
>array total size</EM
></A
> of the <VAR CLASS="param"
>array</VAR
>.</P
></DD
><DT
><B
>Examples</B
></DT
><DD
><PRE CLASS="screen"
>(array-total-size (make-array 4)) <SPAN CLASS="cmsy"
><SPAN CLASS="arrow"
>&#8594;</SPAN
></SPAN
> 4
(array-total-size (make-array 4 :fill-pointer 2)) <SPAN CLASS="cmsy"
><SPAN CLASS="arrow"
>&#8594;</SPAN
></SPAN
> 4
(array-total-size (make-array 0)) <SPAN CLASS="cmsy"
><SPAN CLASS="arrow"
>&#8594;</SPAN
></SPAN
> 0
(array-total-size (make-array '(4 2))) <SPAN CLASS="cmsy"
><SPAN CLASS="arrow"
>&#8594;</SPAN
></SPAN
> 8
(array-total-size (make-array '(4 0))) <SPAN CLASS="cmsy"
><SPAN CLASS="arrow"
>&#8594;</SPAN
></SPAN
> 0
(array-total-size (make-array '())) <SPAN CLASS="cmsy"
><SPAN CLASS="arrow"
>&#8594;</SPAN
></SPAN
> 1</PRE
></DD
><DT
><B
>Exceptional Situations</B
></DT
><DD
><P CLASS="j"
>Should signal an error of <A HREF="26_1_Glossary.html#type"
><EM CLASS="term"
>type</EM
></A
> <A HREF="t_type-error.html" CLASS="typeref"
><B
>type-error</B
></A
> if its argument is not an <A HREF="26_1_Glossary.html#array"
><EM CLASS="term"
>array</EM
></A
>.</P
></DD
><DT
><B
>See Also</B
></DT
><DD
><P CLASS="j"
><A HREF="f_make-array.html" CLASS="funref"
><B
>make-array</B
></A
>, <A HREF="f_array-dimensions.html" CLASS="funref"
><B
>array-dimensions</B
></A
></P
></DD
><DT
><B
>Notes</B
></DT
><DD
><P CLASS="j"
>If the <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
>, the <A HREF="26_1_Glossary.html#fill_pointer"
><EM CLASS="term"
>fill pointer</EM
></A
> is ignored when calculating the <A HREF="26_1_Glossary.html#array_total_size"
><EM CLASS="term"
>array total size</EM
></A
>. </P
><P CLASS="j"
>Since the product of no arguments is one, the <A HREF="26_1_Glossary.html#array_total_size"
><EM CLASS="term"
>array total size</EM
></A
> of a zero-dimensional <A HREF="26_1_Glossary.html#array"
><EM CLASS="term"
>array</EM
></A
> is one.</P
><PRE CLASS="screen"
>(array-total-size x)
<SPAN CLASS="cmsy"
><SPAN STYLE="font-size:16px;vertical-align:-2px"
>&#8801;</SPAN
></SPAN
> (apply #'* (array-dimensions x))
<SPAN CLASS="cmsy"
><SPAN STYLE="font-size:16px;vertical-align:-2px"
>&#8801;</SPAN
></SPAN
> (reduce #'* (array-dimensions x))</PRE
></DD
></DL
></DIV
></DIV
><DIV CLASS="footer"
><DIV CLASS="btmnav"
><A HREF="f_array-row-major-index.html" CLASS="prev"
>&#8592;</A
><A HREF="f_arrayp.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
>
View git blame Copy permalink