changed: info about Big::ToString()

the changes which were made in revision 60 and 63
	 (I forgot to change the info there)


git-svn-id: svn://ttmath.org/publicrep/ttmath/trunk@67 e52654a7-88a9-db11-a3e9-0013d4bc506e
This commit is contained in:
Tomasz Sowa 2008-06-07 16:17:37 +00:00
parent 4d0241c9c9
commit 2933213a02
1 changed files with 10 additions and 10 deletions

View File

@ -2371,25 +2371,20 @@ public:
/*!
a method for converting the value into the string with a base equal 'base'
a method for converting the value into a string with a base equal 'base'
input:
base - the base on which the value will be shown
if 'always_scientific' is true the result will be shown in 'scientific' mode
* base - a base (radix) on which the value will be shown
* if 'always_scientific' is true the result will be shown in 'scientific' mode
if 'always_scientific' is false the result will be shown
either as 'scientific' or 'normal' mode, it depends whether the abs(exponent)
is greater than 'when_scientific' or not, if it's greater the value
will be printed as 'scientific'
* 'max_digit_after_comma' - rounding
if 'max_digit_after_comma' is equal -1 that all digits in the mantissa
will be printed
if 'max_digit_after_comma' is equal -2 that not mattered digits
in the mantissa will be cut off
(zero characters at the end -- after the comma operator)
if 'max_digit_after_comma' is equal or greater than zero
that only 'max_digit_after_comma' after the comma operator will be shown
(if 'max_digit_after_comma' is equal zero there'll be shown only
@ -2398,10 +2393,15 @@ public:
12.345678 and max_digit_after_comma is 4
then the result will be
12.3457 (the last digit was rounded)
if there isn't the comma operator (when the value is too big and we're printing
it not as scientific) 'max_digit_after_comma' will be ignored
* if 'remove_trailing_zeroes' is true that not mattered digits
in the mantissa will be cut off
(zero characters at the end -- after the comma operator)
* decimal_point - a character which will be used as a decimal point
output:
return value:
0 - ok and 'result' will be an object of type std::string which holds the value