Liking cljdoc? Tell your friends :D

sicmutils.complex

This namespace provides a number of functions and constructors for working with [[Complex]] numbers in Clojure and Clojurescript, and installs [[Complex]] into the SICMUtils generic arithmetic system.

For other numeric extensions, see sicmutils.ratio and [[sicmutils.numbers]].

This namespace provides a number of functions and constructors for working
with [[Complex]] numbers in Clojure and Clojurescript, and
installs [[Complex]] into the SICMUtils generic arithmetic system.

For other numeric extensions, see [[sicmutils.ratio]]
and [[sicmutils.numbers]].
raw docstring

-Iclj/s

A [[Complex]] value equal to -i.

A [[Complex]] value equal to `-i`.
sourceraw docstring

complexclj/s

(complex re)
(complex re im)

Returns a [[Complex]] number with the supplied real part re and imaginary part im. im defaults to 0.

Returns a [[Complex]] number with the supplied real part `re` and imaginary
part `im`. `im` defaults to 0.
sourceraw docstring

complex-formatclj

source

complex?clj/s

(complex? a)

Returns true if a is an instance of [[Complex]], false otherwise.

Returns true if `a` is an instance of [[Complex]], false otherwise.
sourceraw docstring

gaussian-integer?clj/s

(gaussian-integer? z)

Returns true if z is a Gaussian integer, ie, a complex entry with integral real and imaginary components.

gaussian-integer? will return true if the real and imaginary components are within epsilon of integral values. See value/almost-integral? for details.

Returns true if `z` is a [Gaussian
integer](https://en.wikipedia.org/wiki/Gaussian_integer), ie, a complex entry
with integral real and imaginary components.

[[gaussian-integer?]] will return true if the real and imaginary components
are within `epsilon` of integral values. See [[value/almost-integral?]] for
details.
sourceraw docstring

Iclj/s

A [[Complex]] value equal to i.

A [[Complex]] value equal to `i`.
sourceraw docstring

ONEclj/s

A [[Complex]] value equal to 1.

A [[Complex]] value equal to 1.
sourceraw docstring

roundclj/s

(round z)

Generates a Gaussian integer from the complex number z by rounding the real and imaginary components of z to their nearest integral values.

Generates a [Gaussian integer](https://en.wikipedia.org/wiki/Gaussian_integer)
from the complex number `z` by rounding the real and imaginary components of
`z` to their nearest integral values.
sourceraw docstring

ZEROclj/s

A [[Complex]] value equal to 0 (south pole on the Riemann Sphere).

A [[Complex]] value equal to 0 (south pole on the Riemann Sphere).
sourceraw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close