From ef91b70de9b68c40df88c38e31908264e2fced3c Mon Sep 17 00:00:00 2001 From: fluffymormegil Date: Sun, 24 Oct 2010 00:47:44 +0100 Subject: [PATCH] Adjusted manpage for libmormegil::abs --- man/libmormegil::abs.3 | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/man/libmormegil::abs.3 b/man/libmormegil::abs.3 index 379b8e8..cd29f81 100644 --- a/man/libmormegil::abs.3 +++ b/man/libmormegil::abs.3 @@ -2,9 +2,9 @@ .SH NAME libmormegil::abs \- compute absolute value .SH SYNOPSIS -#include +#include -template T abs(const T& i) { i < T(0) ? -i : i; } +template T libmormegil::abs(const T& i); .SH DESCRIPTION .I libmormegil::abs @@ -13,13 +13,18 @@ written for libmormegil because the C++ standard library provides only floating point (via / ) or complex (via ) implementations of this function. +.SH RETURNS + +The absolute value (magnitude) of \fIi\fP. + .SH CAVEATS -Implemented as naively as possible. +Implemented as naively as possible. Breaks horribly if type T has exotic +behaviour for its lessthan or unary minus operators. .SH AUTHOR Martin Read .SH SEE ALSO -libmormegil(3), libmormegil::S20prng(3) +libmormegil(3) -- 2.11.0