contrib/openbsd_libm/man/carg.3

   1 .\"     $OpenBSD: carg.3,v 1.2 2013/06/05 03:40:26 tedu Exp $
   2 .\"
   3 .\" Copyright (c) 2011 Martynas Venckus <martynas@openbsd.org>
   4 .\"
   5 .\" Permission to use, copy, modify, and distribute this software for any
   6 .\" purpose with or without fee is hereby granted, provided that the above
   7 .\" copyright notice and this permission notice appear in all copies.
   8 .\"
   9 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  10 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  11 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  12 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  13 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  14 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  15 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  16 .\"
  17 .Dd $Mdocdate: June 5 2013 $
  18 .Dt CARG 3
  19 .Os
  20 .Sh NAME
  21 .Nm carg ,
  22 .Nm cargf ,
  23 .Nm cargl
  24 .Nd complex argument functions
  25 .Sh SYNOPSIS
  26 .In complex.h
  27 .Ft double
  28 .Fn carg "double complex z"
  29 .Ft float
  30 .Fn cargf "float complex z"
  31 .Ft long double
  32 .Fn cargl "long double complex z"
  33 .Sh DESCRIPTION
  34 The
  35 .Fn carg ,
  36 .Fn cargf
  37 and
  38 .Fn cargl
  39 functions compute the argument (also called phase angle) of
  40 .Fa z ,
  41 with a branch cut on the negative real axis.
  42 .Sh RETURN VALUES
  43 The
  44 .Fn carg ,
  45 .Fn cargf
  46 and
  47 .Fn cargl
  48 functions return the argument in the interval
  49 .Bq -Pi, Pi .
  50 .Sh SEE ALSO
  51 .Xr cimag 3
  52 .Sh STANDARDS
  53 The
  54 .Fn carg ,
  55 .Fn cargf
  56 and
  57 .Fn cargl
  58 functions conform to
  59 .St -isoC-99 .