summaryrefslogtreecommitdiffstats
path: root/doc/crypto/bn.pod
diff options
context:
space:
mode:
authorDr. Stephen Henson <steve@openssl.org>2000-01-30 01:39:40 +0000
committerDr. Stephen Henson <steve@openssl.org>2000-01-30 01:39:40 +0000
commit15701211b57b63f1f91a9c3781ea91c019b1dc1d (patch)
tree86796032e60d1f140a5429da70cf3571d2469c17 /doc/crypto/bn.pod
parent1e264ff3251d63c67e2778f4d58228579173efbc (diff)
Update docs.
Diffstat (limited to 'doc/crypto/bn.pod')
-rw-r--r--doc/crypto/bn.pod10
1 files changed, 6 insertions, 4 deletions
diff --git a/doc/crypto/bn.pod b/doc/crypto/bn.pod
index 3d4840f095..823561fa8d 100644
--- a/doc/crypto/bn.pod
+++ b/doc/crypto/bn.pod
@@ -144,14 +144,14 @@ The following description is based on the SSLeay documentation:
int neg;
} BIGNUM;
-The big number is stored in B<d>, a malloc()ed array of B<BN_ULONG>s.
-A B<BN_ULONG> can be either 16, 32 or 64 bits in size, depending on
-the 'number of bits' specified in bn.h.
+The big number is stored in B<d>, a malloc()ed array of B<BN_ULONG>s,
+least significant first. A B<BN_ULONG> can be either 16, 32 or 64 bits
+in size, depending on the 'number of bits' specified in bn.h.
B<max> is the size of the B<d> array that has been allocated. B<top>
is the 'last' entry being used, so for a value of 4, bn.d[0]=4 and
bn.top=1. B<neg> is 1 if the number is negative. When a BIGNUM is
-'0', the B<d> field can be NULL and B<top> == 0. Various routines in
+'0', the B<d> field can be NULL and B<top> == 0. Various routines in
this library require the use of temporary B<BIGNUM> variables during
their execution. Since dynamic memory allocation to create B<BIGNUM>s
is rather expensive when used in conjunction with repeated subroutine
@@ -166,6 +166,8 @@ temporary B<BIGNUM>s any publicly exported function will use.
BIGNUM *bn[BN_CTX_NUM]; /* The variables */
} BN_CTX;
+B<tos> is the index of the first unused B<BIGNUM> in the B<bn> array.
+
=head1 SEE ALSO
L<dh(3)|dh(3)>, L<err(3)|err(3)>, L<rand(3)|rand(3)>, L<rsa(3)|rsa(3)>,