sam-t2/devtools/v9/html/python/api/node39.html

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<link rel="STYLESHEET" href="api.css" type='text/css' />
<link rel="SHORTCUT ICON" href="../icons/pyfav.png" type="image/png" />
<link rel='start' href='../index.html' title='Python Documentation Index' />
<link rel="first" href="api.html" title='Python/C API Reference Manual' />
<link rel='contents' href='contents.html' title="Contents" />
<link rel='index' href='genindex.html' title='Index' />
<link rel='last' href='about.html' title='About this document...' />
<link rel='help' href='about.html' title='About this document...' />
<link rel="next" href="node40.html" />
<link rel="prev" href="complexObjects.html" />
<link rel="parent" href="complexObjects.html" />
<link rel="next" href="node40.html" />
<meta name='aesop' content='information' />
<title>7.2.5.1 Complex Numbers as C Structures</title>
</head>
<body>
<DIV CLASS="navigation">
<div id='top-navigation-panel' xml:id='top-navigation-panel'>
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="7.2.5 Complex Number Objects"
  href="complexObjects.html"><img src='../icons/previous.png'
  border='0' height='32'  alt='Previous Page' width='32' /></A></td>
<td class='online-navigation'><a rel="parent" title="7.2.5 Complex Number Objects"
  href="complexObjects.html"><img src='../icons/up.png'
  border='0' height='32'  alt='Up One Level' width='32' /></A></td>
<td class='online-navigation'><a rel="next" title="7.2.5.2 Complex Numbers as"
  href="node40.html"><img src='../icons/next.png'
  border='0' height='32'  alt='Next Page' width='32' /></A></td>
<td align="center" width="100%">Python/C API Reference Manual</td>
<td class='online-navigation'><a rel="contents" title="Table of Contents"
  href="contents.html"><img src='../icons/contents.png'
  border='0' height='32'  alt='Contents' width='32' /></A></td>
<td class='online-navigation'><img src='../icons/blank.png'
  border='0' height='32'  alt='' width='32' /></td>
<td class='online-navigation'><a rel="index" title="Index"
  href="genindex.html"><img src='../icons/index.png'
  border='0' height='32'  alt='Index' width='32' /></A></td>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="complexObjects.html">7.2.5 Complex Number Objects</A>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="complexObjects.html">7.2.5 Complex Number Objects</A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="node40.html">7.2.5.2 Complex Numbers as</A>
</div>
<hr /></div>
</DIV>
<!--End of Navigation Panel-->

<H3><A NAME="SECTION009251000000000000000">
7.2.5.1 Complex Numbers as C Structures</A>
</H3>

<P>
Note that the functions which accept these structures as parameters
and return them as results do so <em>by value</em> rather than
dereferencing them through pointers.  This is consistent throughout
the API.

<P>
<dl><dt><b><tt class="ctype"><a id='l2h-431' xml:id='l2h-431'>Py_complex</a></tt></b></dt>
<dd>
  The C structure which corresponds to the value portion of a Python
  complex number object.  Most of the functions for dealing with
  complex number objects use structures of this type as input or
  output values, as appropriate.  It is defined as:

<P>
<div class="verbatim"><pre>
typedef struct {
   double real;
   double imag;
} Py_complex;
</pre></div>
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td><nobr>Py_complex&nbsp;<b><tt id='l2h-432' xml:id='l2h-432' class="cfunction">_Py_c_sum</tt></b>(</nobr></td><td>Py_complex <var>left</var>, Py_complex <var>right</var>)</td></tr></table></dt>
<dd>
  Return the sum of two complex numbers, using the C
  <tt class="ctype">Py_complex</tt> representation.
</dd></dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td><nobr>Py_complex&nbsp;<b><tt id='l2h-433' xml:id='l2h-433' class="cfunction">_Py_c_diff</tt></b>(</nobr></td><td>Py_complex <var>left</var>, Py_complex <var>right</var>)</td></tr></table></dt>
<dd>
  Return the difference between two complex numbers, using the C
  <tt class="ctype">Py_complex</tt> representation.
</dd></dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td><nobr>Py_complex&nbsp;<b><tt id='l2h-434' xml:id='l2h-434' class="cfunction">_Py_c_neg</tt></b>(</nobr></td><td>Py_complex <var>complex</var>)</td></tr></table></dt>
<dd>
  Return the negation of the complex number <var>complex</var>, using the C
  <tt class="ctype">Py_complex</tt> representation.
</dd></dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td><nobr>Py_complex&nbsp;<b><tt id='l2h-435' xml:id='l2h-435' class="cfunction">_Py_c_prod</tt></b>(</nobr></td><td>Py_complex <var>left</var>, Py_complex <var>right</var>)</td></tr></table></dt>
<dd>
  Return the product of two complex numbers, using the C
  <tt class="ctype">Py_complex</tt> representation.
</dd></dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td><nobr>Py_complex&nbsp;<b><tt id='l2h-436' xml:id='l2h-436' class="cfunction">_Py_c_quot</tt></b>(</nobr></td><td>Py_complex <var>dividend</var>,
                                          Py_complex <var>divisor</var>)</td></tr></table></dt>
<dd>
  Return the quotient of two complex numbers, using the C
  <tt class="ctype">Py_complex</tt> representation.
</dd></dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td><nobr>Py_complex&nbsp;<b><tt id='l2h-437' xml:id='l2h-437' class="cfunction">_Py_c_pow</tt></b>(</nobr></td><td>Py_complex <var>num</var>, Py_complex <var>exp</var>)</td></tr></table></dt>
<dd>
  Return the exponentiation of <var>num</var> by <var>exp</var>, using the C
  <tt class="ctype">Py_complex</tt> representation.
</dd></dl>

<P>

<DIV CLASS="navigation">
<div class='online-navigation'>
<p></p><hr />
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="7.2.5 Complex Number Objects"
  href="complexObjects.html"><img src='../icons/previous.png'
  border='0' height='32'  alt='Previous Page' width='32' /></A></td>
<td class='online-navigation'><a rel="parent" title="7.2.5 Complex Number Objects"
  href="complexObjects.html"><img src='../icons/up.png'
  border='0' height='32'  alt='Up One Level' width='32' /></A></td>
<td class='online-navigation'><a rel="next" title="7.2.5.2 Complex Numbers as"
  href="node40.html"><img src='../icons/next.png'
  border='0' height='32'  alt='Next Page' width='32' /></A></td>
<td align="center" width="100%">Python/C API Reference Manual</td>
<td class='online-navigation'><a rel="contents" title="Table of Contents"
  href="contents.html"><img src='../icons/contents.png'
  border='0' height='32'  alt='Contents' width='32' /></A></td>
<td class='online-navigation'><img src='../icons/blank.png'
  border='0' height='32'  alt='' width='32' /></td>
<td class='online-navigation'><a rel="index" title="Index"
  href="genindex.html"><img src='../icons/index.png'
  border='0' height='32'  alt='Index' width='32' /></A></td>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="complexObjects.html">7.2.5 Complex Number Objects</A>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="complexObjects.html">7.2.5 Complex Number Objects</A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="node40.html">7.2.5.2 Complex Numbers as</A>
</div>
</div>
<hr />
<span class="release-info">Release 2.4.2, documentation updated on 28 September 2005.</span>
</DIV>
<!--End of Navigation Panel-->
<ADDRESS>
See <i><a href="about.html">About this document...</a></i> for information on suggesting changes.
</ADDRESS>
</BODY>
</HTML>