package owl-base

  1. Overview
  2. Docs
package owl-base
Legend:
Library
Module
Module type
Parameter
Class
Class type
Type definition and constants
type t = Stdlib.Complex.t

Type definition of a complex number.

val zero : t

Constant value zero.

val one : t

Constant value one.

val i : t

Constant value i.

Unary functions
val neg : t -> t

TODO

val abs : t -> float

TODO

val abs2 : t -> float

TODO

val logabs : t -> float

TODO

val conj : t -> t

TODO

val inv : t -> t

TODO

val sqrt : t -> t

TODO

val exp : t -> t

TODO

val exp2 : t -> t

TODO

val exp10 : t -> t

TODO

val expm1 : t -> t

TODO

val log : t -> t

TODO

val log2 : t -> t

TODO

val log10 : t -> t

TODO

val log1p : t -> t

TODO

val sin : t -> t

TODO

val cos : t -> t

TODO

val tan : t -> t

TODO

val cot : t -> t

TODO

val sec : t -> t

TODO

val csc : t -> t

TODO

val sinh : t -> t

TODO

val cosh : t -> t

TODO

val tanh : t -> t

TODO

val sech : t -> t

TODO

val csch : t -> t

TODO

val coth : t -> t

TODO

val asin : t -> t

TODO

val acos : t -> t

TODO

val atan : t -> t

TODO

val asec : t -> t

TODO

val acsc : t -> t

TODO

val acot : t -> t

TODO

val asinh : t -> t

TODO

val acosh : t -> t

TODO

val atanh : t -> t

TODO

val asech : t -> t

TODO

val acsch : t -> t

TODO

val acoth : t -> t

TODO

val arg : t -> float

``arg x`` returns the angle of a complex number ``x``.

val phase : t -> float

``phase x`` returns the phase of a complex number ``x``.

val floor : t -> t

``floor x``

val ceil : t -> t

``ceil x``

val round : t -> t

``round x``

val trunc : t -> t

``trunc x``

val fix : t -> t

``fix x``

Binary functions
val add : t -> t -> t

TODO

val sub : t -> t -> t

TODO

val mul : t -> t -> t

TODO

val div : t -> t -> t

TODO

val add_re : t -> float -> t

TODO

val add_im : t -> float -> t

TODO

val sub_re : t -> float -> t

TODO

val sub_im : t -> float -> t

TODO

val mul_re : t -> float -> t

TODO

val mul_im : t -> float -> t

TODO

val div_re : t -> float -> t

TODO

val div_im : t -> float -> t

TODO

val pow : t -> t -> t

TODO

val polar : float -> float -> t

TODO

val rect : float -> float -> t

``rect r phi`` return a complex number with polar coordinates ``r`` and ``phi``.

Comparison functions
val equal : t -> t -> bool

TODO

val not_equal : t -> t -> bool

TODO

val less : t -> t -> bool

TODO

val greater : t -> t -> bool

TODO

val less_equal : t -> t -> bool

TODO

val greater_equal : t -> t -> bool

TODO

Helper functions
val complex : float -> float -> t

``complex re im`` returns a complex number ``re; im``.

val of_tuple : (float * float) -> t

``of_tuple (re, im)`` returns a complex number ``re; im``.

val to_tuple : t -> float * float

``to_tuple x`` converts a complex number to tuple ``(x.re; x.im)``.

val is_nan : t -> bool

``is_nan x`` returns ``true`` if ``x.re`` is ``nan`` or ``x.im`` is ``nan``.

val is_inf : t -> bool

``is_inf x`` returns ``true`` if either ``x.re`` or ``x.im`` is ``infinity`` or ``neg_infinity``.

val is_normal : t -> bool

``is_normal x`` returns ``true`` if both ``x.re`` and ``x.im`` are ``normal``.

OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct