blob: e6b4beaf24db10a66701483036b2e6965a846058 [file]
<html lang="en">
<head>
<title>CMPLX - 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="CHMOD.html#CHMOD" title="CHMOD">
<link rel="next" href="COMMAND_005fARGUMENT_005fCOUNT.html#COMMAND_005fARGUMENT_005fCOUNT" title="COMMAND_ARGUMENT_COUNT">
<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="CMPLX"></a>
<p>
Next:&nbsp;<a rel="next" accesskey="n" href="COMMAND_005fARGUMENT_005fCOUNT.html#COMMAND_005fARGUMENT_005fCOUNT">COMMAND_ARGUMENT_COUNT</a>,
Previous:&nbsp;<a rel="previous" accesskey="p" href="CHMOD.html#CHMOD">CHMOD</a>,
Up:&nbsp;<a rel="up" accesskey="u" href="Intrinsic-Procedures.html#Intrinsic-Procedures">Intrinsic Procedures</a>
<hr>
</div>
<h3 class="section">8.49 <code>CMPLX</code> &mdash; Complex conversion function</h3>
<p><a name="index-CMPLX-521"></a><a name="index-complex-numbers_002c-conversion-to-522"></a><a name="index-conversion_002c-to-complex-523"></a>
<dl>
<dt><em>Description</em>:<dd><code>CMPLX(X [, Y [, KIND]])</code> returns a complex number where <var>X</var> is converted to
the real component. If <var>Y</var> is present it is converted to the imaginary
component. If <var>Y</var> is not present then the imaginary component is set to
0.0. If <var>X</var> is complex then <var>Y</var> must not be present.
<br><dt><em>Standard</em>:<dd>Fortran 77 and later
<br><dt><em>Class</em>:<dd>Elemental function
<br><dt><em>Syntax</em>:<dd><code>RESULT = CMPLX(X [, Y [, KIND]])</code>
<br><dt><em>Arguments</em>:<dd>
<p><table summary=""><tr align="left"><td valign="top" width="15%"><var>X</var> </td><td valign="top" width="70%">The type may be <code>INTEGER</code>, <code>REAL</code>,
or <code>COMPLEX</code>.
<br></td></tr><tr align="left"><td valign="top" width="15%"><var>Y</var> </td><td valign="top" width="70%">(Optional; only allowed if <var>X</var> is not
<code>COMPLEX</code>.) May be <code>INTEGER</code> or <code>REAL</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 <code>COMPLEX</code> type, with a kind equal to
<var>KIND</var> if it is specified. If <var>KIND</var> is not specified, the
result is of the default <code>COMPLEX</code> kind, regardless of the kinds of
<var>X</var> and <var>Y</var>.
<br><dt><em>Example</em>:<dd>
<pre class="smallexample"> program test_cmplx
integer :: i = 42
real :: x = 3.14
complex :: z
z = cmplx(i, x)
print *, z, cmplx(x)
end program test_cmplx
</pre>
<br><dt><em>See also</em>:<dd><a href="COMPLEX.html#COMPLEX">COMPLEX</a>
</dl>
</body></html>