Tcl Library Source Code

Bounty program for improvements to Tcl and certain Tcl packages.

[ Main Table Of Contents | Table Of Contents | Keyword Index | Categories | Modules | Applications ]


math::complexnumbers - Straightforward complex number package

Table Of Contents


package require Tcl 8.3
package require math::complexnumbers ?1.0.2?

::math::complexnumbers::+ z1 z2
::math::complexnumbers::- z1 z2
::math::complexnumbers::* z1 z2
::math::complexnumbers::/ z1 z2
::math::complexnumbers::conj z1
::math::complexnumbers::real z1
::math::complexnumbers::imag z1
::math::complexnumbers::mod z1
::math::complexnumbers::arg z1
::math::complexnumbers::complex real imag
::math::complexnumbers::tostring z1
::math::complexnumbers::exp z1
::math::complexnumbers::sin z1
::math::complexnumbers::cos z1
::math::complexnumbers::tan z1
::math::complexnumbers::log z1
::math::complexnumbers::sqrt z1
::math::complexnumbers::pow z1 z2


The mathematical module complexnumbers provides a straightforward implementation of complex numbers in pure Tcl. The philosophy is that the user knows he or she is dealing with complex numbers in an abstract way and wants as high a performance as can be had within the limitations of an interpreted language.

Therefore the procedures defined in this package assume that the arguments are valid (representations of) "complex numbers", that is, lists of two numbers defining the real and imaginary part of a complex number (though this is a mere detail: rely on the complex command to construct a valid number.)

Most procedures implement the basic arithmetic operations or elementary functions whereas several others convert to and from different representations:

set z [complex 0 1]
puts "z = [tostring $z]"
puts "z**2 = [* $z $z]

would result in:

z = i
z**2 = -1


The package implements all or most basic operations and elementary functions.

The arithmetic operations are:

Conversion/inquiry procedures:

Elementary functions:

Bugs, Ideas, Feedback

This document, and the package it describes, will undoubtedly contain bugs and other problems. Please report such in the category math :: complexnumbers of the Tcllib Trackers. Please also report any ideas for enhancements you may have for either package and/or documentation.

When proposing code changes, please provide unified diffs, i.e the output of diff -u.

Note further that attachments are strongly preferred over inlined patches. Attachments can be made by going to the Edit form of the ticket immediately after its creation, and then using the left-most button in the secondary navigation bar.


complex numbers, math




Copyright © 2004 Arjen Markus