xref: /php-src/ext/bcmath/libbcmath/src/raisemod.c (revision be4b10e9)
1 /* raisemod.c: bcmath library file. */
2 /*
3     Copyright (C) 1991, 1992, 1993, 1994, 1997 Free Software Foundation, Inc.
4     Copyright (C) 2000 Philip A. Nelson
5 
6     This library is free software; you can redistribute it and/or
7     modify it under the terms of the GNU Lesser General Public
8     License as published by the Free Software Foundation; either
9     version 2 of the License, or (at your option) any later version.
10 
11     This library is distributed in the hope that it will be useful,
12     but WITHOUT ANY WARRANTY; without even the implied warranty of
13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14     Lesser General Public License for more details.  (LICENSE)
15 
16     You should have received a copy of the GNU Lesser General Public
17     License along with this library; if not, write to:
18 
19       The Free Software Foundation, Inc.
20       59 Temple Place, Suite 330
21       Boston, MA 02111-1307 USA.
22 
23     You may contact the author by:
24        e-mail:  philnelson@acm.org
25       us-mail:  Philip A. Nelson
26                 Computer Science Department, 9062
27                 Western Washington University
28                 Bellingham, WA 98226-9062
29 
30 *************************************************************************/
31 
32 #include "bcmath.h"
33 #include "private.h"
34 #include <stddef.h>
35 
36 /* Raise BASE to the EXPO power, reduced modulo MOD.  The result is placed in RESULT. */
bc_raisemod(bc_num base,bc_num expo,bc_num mod,bc_num * result,size_t scale)37 raise_mod_status bc_raisemod(bc_num base, bc_num expo, bc_num mod, bc_num *result, size_t scale)
38 {
39 	bc_num power, exponent, modulus, parity, temp;
40 
41 	/* Check the base for scale digits. */
42 	if (base->n_scale != 0) {
43 		return BASE_HAS_FRACTIONAL;
44 	}
45 	/* Check the exponent for scale digits. */
46 	if (expo->n_scale != 0) {
47 		return EXPO_HAS_FRACTIONAL;
48 	}
49 	if (bc_is_neg(expo)) {
50 		return EXPO_IS_NEGATIVE;
51 	}
52 	/* Check the modulus for scale digits. */
53 	if (mod->n_scale != 0) {
54 		return MOD_HAS_FRACTIONAL;
55 	}
56 	/* Modulus cannot be 0 */
57 	if (bc_is_zero(mod)) {
58 		return MOD_IS_ZERO;
59 	}
60 
61 	/* Any integer number mod 1 (or -1) must be equal to 0 */
62 	if (_bc_do_compare(mod, BCG(_one_), mod->n_scale, false) == BCMATH_EQUAL) {
63 		bc_free_num (result);
64 		*result = bc_new_num(1, scale);
65 		return OK;
66 	}
67 
68 	/* Set initial values. */
69 	power = bc_copy_num(base);
70 	exponent = bc_copy_num(expo);
71 	modulus = bc_copy_num(mod);
72 	temp = bc_copy_num(BCG(_one_));
73 	bc_init_num(&parity);
74 
75 	/* Do the calculation. */
76 	while (!bc_is_zero(exponent)) {
77 		(void) bc_divmod(exponent, BCG(_two_), &exponent, &parity, 0);
78 		if (!bc_is_zero(parity)) {
79 			bc_multiply_ex(temp, power, &temp, scale);
80 			(void) bc_modulo(temp, modulus, &temp, scale);
81 		}
82 		bc_multiply_ex(power, power, &power, scale);
83 		(void) bc_modulo(power, modulus, &power, scale);
84 	}
85 
86 	/* Assign the value. */
87 	bc_free_num (&power);
88 	bc_free_num (&exponent);
89 	bc_free_num (&modulus);
90 	bc_free_num (result);
91 	bc_free_num (&parity);
92 	*result = temp;
93 	return OK;
94 }
95