blob: 92ec6c93add783dbe1b9b574ada0c0079a043b83 [file]
<html lang="en">
<head>
<title>UBOUND - The GNU Fortran Compiler</title>
<meta http-equiv="Content-Type" content="text/html">
<meta name="description" content="The GNU Fortran Compiler">
<meta name="generator" content="makeinfo 4.13">
<link title="Top" rel="start" href="index.html#Top">
<link rel="up" href="Intrinsic-Procedures.html#Intrinsic-Procedures" title="Intrinsic Procedures">
<link rel="prev" href="TTYNAM.html#TTYNAM" title="TTYNAM">
<link rel="next" href="UCOBOUND.html#UCOBOUND" title="UCOBOUND">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
<!--
Copyright (C) 1999-2013 Free Software Foundation, Inc.
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3 or
any later version published by the Free Software Foundation; with the
Invariant Sections being ``Funding Free Software'', the Front-Cover
Texts being (a) (see below), and with the Back-Cover Texts being (b)
(see below). A copy of the license is included in the section entitled
``GNU Free Documentation License''.
(a) The FSF's Front-Cover Text is:
A GNU Manual
(b) The FSF's Back-Cover Text is:
You have freedom to copy and modify this GNU Manual, like GNU
software. Copies published by the Free Software Foundation raise
funds for GNU development.-->
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
pre.display { font-family:inherit }
pre.format { font-family:inherit }
pre.smalldisplay { font-family:inherit; font-size:smaller }
pre.smallformat { font-family:inherit; font-size:smaller }
pre.smallexample { font-size:smaller }
pre.smalllisp { font-size:smaller }
span.sc { font-variant:small-caps }
span.roman { font-family:serif; font-weight:normal; }
span.sansserif { font-family:sans-serif; font-weight:normal; }
--></style>
</head>
<body>
<div class="node">
<a name="UBOUND"></a>
<p>
Next:&nbsp;<a rel="next" accesskey="n" href="UCOBOUND.html#UCOBOUND">UCOBOUND</a>,
Previous:&nbsp;<a rel="previous" accesskey="p" href="TTYNAM.html#TTYNAM">TTYNAM</a>,
Up:&nbsp;<a rel="up" accesskey="u" href="Intrinsic-Procedures.html#Intrinsic-Procedures">Intrinsic Procedures</a>
<hr>
</div>
<h3 class="section">8.251 <code>UBOUND</code> &mdash; Upper dimension bounds of an array</h3>
<p><a name="index-UBOUND-1123"></a><a name="index-array_002c-upper-bound-1124"></a>
<dl>
<dt><em>Description</em>:<dd>Returns the upper bounds of an array, or a single upper bound
along the <var>DIM</var> dimension.
<br><dt><em>Standard</em>:<dd>Fortran 95 and later, with <var>KIND</var> argument Fortran 2003 and later
<br><dt><em>Class</em>:<dd>Inquiry function
<br><dt><em>Syntax</em>:<dd><code>RESULT = UBOUND(ARRAY [, DIM [, KIND]])</code>
<br><dt><em>Arguments</em>:<dd>
<p><table summary=""><tr align="left"><td valign="top" width="15%"><var>ARRAY</var> </td><td valign="top" width="70%">Shall be an array, of any type.
<br></td></tr><tr align="left"><td valign="top" width="15%"><var>DIM</var> </td><td valign="top" width="70%">(Optional) Shall be a scalar <code>INTEGER</code>.
<br></td></tr><tr align="left"><td valign="top" width="15%"><var>KIND</var></td><td valign="top" width="70%">(Optional) An <code>INTEGER</code> initialization
expression indicating the kind parameter of the result.
<br></td></tr></table>
<br><dt><em>Return value</em>:<dd>The return value is of type <code>INTEGER</code> and of kind <var>KIND</var>. If
<var>KIND</var> is absent, the return value is of default integer kind.
If <var>DIM</var> is absent, the result is an array of the upper bounds of
<var>ARRAY</var>. If <var>DIM</var> is present, the result is a scalar
corresponding to the upper bound of the array along that dimension. If
<var>ARRAY</var> is an expression rather than a whole array or array
structure component, or if it has a zero extent along the relevant
dimension, the upper bound is taken to be the number of elements along
the relevant dimension.
<br><dt><em>See also</em>:<dd><a href="LBOUND.html#LBOUND">LBOUND</a>, <a href="LCOBOUND.html#LCOBOUND">LCOBOUND</a>
</dl>
</body></html>