X-Git-Url: http://git.silcnet.org/gitweb/?a=blobdiff_plain;f=lib%2Fsilcmath%2Fsilcmp.h;h=662de1720c0072cbfa3f64ff6f623a1c004081d3;hb=e7b6c157b80152bf9fb9266e6bdd93f9fb0db776;hp=aaff041274be97127ee878f6258d72e27daa54da;hpb=410642a14d4185abd75715cee3f5177cd55b1ceb;p=silc.git diff --git a/lib/silcmath/silcmp.h b/lib/silcmath/silcmp.h index aaff0412..662de172 100644 --- a/lib/silcmath/silcmp.h +++ b/lib/silcmath/silcmp.h @@ -4,7 +4,7 @@ Author: Pekka Riikonen - Copyright (C) 1997 - 2005 Pekka Riikonen + Copyright (C) 1997 - 2007 Pekka Riikonen This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by @@ -68,7 +68,7 @@ typedef SILC_MP_INT SilcMPInt; * * DESCRIPTION * - * Initializes the SilcMPInt *that is the actual MP Integer. + * Initializes the SilcMPInt that is the actual MP Integer. * This must be called before any of the silc_mp_ routines can be * used. The integer is uninitialized with the silc_mp_uninit function. * @@ -83,18 +83,11 @@ void silc_mp_init(SilcMPInt *mp); * * DESCRIPTION * - * Initializes the SilcMPInt *that is the actual MP Integer. + * Initializes the SilcMPInt that is the actual MP Integer. * This must be called before any of the silc_mp_ routines can be - * used. The integer is uninitialized with the silc_mp_uninit function. - * This routine is equivalent to silc_mp_init but allocates the memory - * from `stack'. - * - * NOTES - * - * The `stack' is saved into the `mp' for the duration of the existence - * of `mp'. This means that `stack' must not become invalid while `mp' - * is used. It also means that any routine that may need memory allocation - * to for example enlarge `mp' will allocate the memory from `stack'. + * used. The integer is uninitialized with the silc_mp_suninit function. + * If `stack' is non-NULL it will be used as the memory source. If it + * is NULL, this call is equivalent to silc_mp_init. * ***/ SilcBool silc_mp_sinit(SilcStack stack, SilcMPInt *mp); @@ -112,6 +105,19 @@ SilcBool silc_mp_sinit(SilcStack stack, SilcMPInt *mp); ***/ void silc_mp_uninit(SilcMPInt *mp); +/****f* silcmath/SilcMPAPI/silc_mp_suninit + * + * SYNOPSIS + * + * void silc_mp_suninit(SilcStack stack, SilcMPInt *mp); + * + * DESCRIPTION + * + * Uninitializes the MP Integer. + * + ***/ +void silc_mp_suninit(SilcStack stack, SilcMPInt *mp); + /****f* silcmath/SilcMPAPI/silc_mp_size * * SYNOPSIS