xref: /openbsd-src/lib/libm/man/carg.3 (revision 86f9d4cdda0e0267dccd8755ac0035525579c4a7)
1*86f9d4cdStedu.\"	$OpenBSD: carg.3,v 1.2 2013/06/05 03:40:26 tedu Exp $
22bfdbafeSmartynas.\"
32bfdbafeSmartynas.\" Copyright (c) 2011 Martynas Venckus <martynas@openbsd.org>
42bfdbafeSmartynas.\"
52bfdbafeSmartynas.\" Permission to use, copy, modify, and distribute this software for any
62bfdbafeSmartynas.\" purpose with or without fee is hereby granted, provided that the above
72bfdbafeSmartynas.\" copyright notice and this permission notice appear in all copies.
82bfdbafeSmartynas.\"
92bfdbafeSmartynas.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
102bfdbafeSmartynas.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
112bfdbafeSmartynas.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
122bfdbafeSmartynas.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
132bfdbafeSmartynas.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
142bfdbafeSmartynas.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
152bfdbafeSmartynas.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
162bfdbafeSmartynas.\"
17*86f9d4cdStedu.Dd $Mdocdate: June 5 2013 $
182bfdbafeSmartynas.Dt CARG 3
192bfdbafeSmartynas.Os
202bfdbafeSmartynas.Sh NAME
212bfdbafeSmartynas.Nm carg ,
222bfdbafeSmartynas.Nm cargf ,
232bfdbafeSmartynas.Nm cargl
242bfdbafeSmartynas.Nd complex argument functions
252bfdbafeSmartynas.Sh SYNOPSIS
26*86f9d4cdStedu.In complex.h
272bfdbafeSmartynas.Ft double
282bfdbafeSmartynas.Fn carg "double complex z"
292bfdbafeSmartynas.Ft float
302bfdbafeSmartynas.Fn cargf "float complex z"
312bfdbafeSmartynas.Ft long double
322bfdbafeSmartynas.Fn cargl "long double complex z"
332bfdbafeSmartynas.Sh DESCRIPTION
342bfdbafeSmartynasThe
352bfdbafeSmartynas.Fn carg ,
362bfdbafeSmartynas.Fn cargf
372bfdbafeSmartynasand
382bfdbafeSmartynas.Fn cargl
392bfdbafeSmartynasfunctions compute the argument (also called phase angle) of
402bfdbafeSmartynas.Fa z ,
412bfdbafeSmartynaswith a branch cut on the negative real axis.
422bfdbafeSmartynas.Sh RETURN VALUES
432bfdbafeSmartynasThe
442bfdbafeSmartynas.Fn carg ,
452bfdbafeSmartynas.Fn cargf
462bfdbafeSmartynasand
472bfdbafeSmartynas.Fn cargl
482bfdbafeSmartynasfunctions return the argument in the interval
492bfdbafeSmartynas.Bq -Pi, Pi .
502bfdbafeSmartynas.Sh SEE ALSO
512bfdbafeSmartynas.Xr cimag 3
522bfdbafeSmartynas.Sh STANDARDS
532bfdbafeSmartynasThe
542bfdbafeSmartynas.Fn carg ,
552bfdbafeSmartynas.Fn cargf
562bfdbafeSmartynasand
572bfdbafeSmartynas.Fn cargl
582bfdbafeSmartynasfunctions conform to
592bfdbafeSmartynas.St -isoC-99 .
60