diff options
author | enge <enge@211d60ee-9f03-0410-a15a-8952a2c7a4e4> | 2013-07-24 15:02:30 +0000 |
---|---|---|
committer | enge <enge@211d60ee-9f03-0410-a15a-8952a2c7a4e4> | 2013-07-24 15:02:30 +0000 |
commit | d59a55bbc16410ed3bfb820affbd51b24d1c3eb3 (patch) | |
tree | 8307d99b772fc56c00bca45d8fdf7f4e5d802157 /doc | |
parent | 22dad8c9d6bde43cba07f5564b1329bd778f47f5 (diff) | |
download | mpc-d59a55bbc16410ed3bfb820affbd51b24d1c3eb3.tar.gz |
switch to British English in documentation
git-svn-id: svn://scm.gforge.inria.fr/svn/mpc/trunk@1299 211d60ee-9f03-0410-a15a-8952a2c7a4e4
Diffstat (limited to 'doc')
-rw-r--r-- | doc/mpc.texi | 26 |
1 files changed, 13 insertions, 13 deletions
diff --git a/doc/mpc.texi b/doc/mpc.texi index e5c5fcd..ccb338b 100644 --- a/doc/mpc.texi +++ b/doc/mpc.texi @@ -375,23 +375,23 @@ This computes the square of @var{x} with rounding mode @code{rnd_mode} and puts the result back in @var{x}. -Before you can assign to an GNU MPC variable, you need to initialize it by calling +Before you can assign to an GNU MPC variable, you need to initialise it by calling one of the special initialization functions. When you are done with a variable, you need to clear it out, using one of the functions for that purpose. -A variable should only be initialized once, or at least cleared out between -each initialization. After a variable has been initialized, it may be +A variable should only be initialised once, or at least cleared out between +each initialization. After a variable has been initialised, it may be assigned to any number of times. -For efficiency reasons, avoid to initialize and clear out a variable in loops. -Instead, initialize it before entering the loop, and clear it out after the +For efficiency reasons, avoid to initialise and clear out a variable in loops. +Instead, initialise it before entering the loop, and clear it out after the loop has exited. You do not need to be concerned about allocating additional space for GNU MPC variables, since each of its real and imaginary part has a mantissa of fixed size. -Hence unless you change its precision, or clear and reinitialize it, +Hence unless you change its precision, or clear and reinitialise it, a complex variable will have the same allocated space during all its life. @@ -486,19 +486,19 @@ different word size. @node Initializing Complex Numbers @section Initialization Functions -An @code{mpc_t} object must be initialized before storing the first value in +An @code{mpc_t} object must be initialised before storing the first value in it. The functions @code{mpc_init2} and @code{mpc_init3} are used for that purpose. @deftypefun void mpc_init2 (mpc_t @var{z}, mpfr_prec_t @var{prec}) -Initialize @var{z} to precision @var{prec} bits +Initialise @var{z} to precision @var{prec} bits and set its real and imaginary parts to NaN. -Normally, a variable should be initialized once only +Normally, a variable should be initialised once only or at least be cleared, using @code{mpc_clear}, between initializations. @end deftypefun @deftypefun void mpc_init3 (mpc_t @var{z}, mpfr_prec_t @var{prec_r}, mpfr_prec_t @var{prec_i}) -Initialize @var{z} with the precision of its real part being +Initialise @var{z} with the precision of its real part being @var{prec_r} bits and the precision of its imaginary part being @var{prec_i} bits, and set the real and imaginary parts to NaN. @end deftypefun @@ -509,7 +509,7 @@ Free the space occupied by @var{z}. Make sure to call this function for all @end deftypefun @need 2000 -Here is an example on how to initialize complex variables: +Here is an example on how to initialise complex variables: @example @{ mpc_t x, y; @@ -550,7 +550,7 @@ via @var{pi}. @section Assignment Functions @cindex Complex assignment functions -These functions assign new values to already initialized complex numbers +These functions assign new values to already initialised complex numbers (@pxref{Initializing Complex Numbers}). When using any functions with @code{intmax_t} or @code{uintmax_t} parameters, you must include @@ -749,7 +749,7 @@ parentheses, or @code{nan(n-char-sequence)} or @code{@@nan@@(n-char-sequence)} of ascii letters, digits or @code{'_'}. For instance, upon input of @code{"nan(13 1)"}, the function -@code{mpc_inp_str} starts to recognize a value of NaN followed by an +@code{mpc_inp_str} starts to recognise a value of NaN followed by an n-char-sequence indicated by the opening parenthesis; as soon as the space is reached, it becomes clear that the expression in parentheses is not an n-char-sequence, and the error flag -1 is returned after 6 |