1 /* 2 * mplogic.h 3 * 4 * Bitwise logical operations on MPI values 5 * 6 * ***** BEGIN LICENSE BLOCK ***** 7 * Version: MPL 1.1/GPL 2.0/LGPL 2.1 8 * 9 * The contents of this file are subject to the Mozilla Public License Version 10 * 1.1 (the "License"); you may not use this file except in compliance with 11 * the License. You may obtain a copy of the License at 12 * http://www.mozilla.org/MPL/ 13 * 14 * Software distributed under the License is distributed on an "AS IS" basis, 15 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License 16 * for the specific language governing rights and limitations under the 17 * License. 18 * 19 * The Original Code is the MPI Arbitrary Precision Integer Arithmetic library. 20 * 21 * The Initial Developer of the Original Code is 22 * Michael J. Fromberger. 23 * Portions created by the Initial Developer are Copyright (C) 1998 24 * the Initial Developer. All Rights Reserved. 25 * 26 * Contributor(s): 27 * 28 * Alternatively, the contents of this file may be used under the terms of 29 * either the GNU General Public License Version 2 or later (the "GPL"), or 30 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"), 31 * in which case the provisions of the GPL or the LGPL are applicable instead 32 * of those above. If you wish to allow use of your version of this file only 33 * under the terms of either the GPL or the LGPL, and not to allow others to 34 * use your version of this file under the terms of the MPL, indicate your 35 * decision by deleting the provisions above and replace them with the notice 36 * and other provisions required by the GPL or the LGPL. If you do not delete 37 * the provisions above, a recipient may use your version of this file under 38 * the terms of any one of the MPL, the GPL or the LGPL. 39 * 40 * ***** END LICENSE BLOCK ***** */ 41 /* 42 * Copyright 2007 Sun Microsystems, Inc. All rights reserved. 43 * Use is subject to license terms. 44 * 45 * Sun elects to use this software under the MPL license. 46 */ 47 48 #ifndef _MPLOGIC_H 49 #define _MPLOGIC_H 50 51 /* $Id: mplogic.h,v 1.7 2004/04/27 23:04:36 gerv%gerv.net Exp $ */ 52 53 #include "mpi.h" 54 55 /* 56 The logical operations treat an mp_int as if it were a bit vector, 57 without regard to its sign (an mp_int is represented in a signed 58 magnitude format). Values are treated as if they had an infinite 59 string of zeros left of the most-significant bit. 60 */ 61 62 /* Parity results */ 63 64 #define MP_EVEN MP_YES 65 #define MP_ODD MP_NO 66 67 /* Bitwise functions */ 68 69 mp_err mpl_not(mp_int *a, mp_int *b); /* one's complement */ 70 mp_err mpl_and(mp_int *a, mp_int *b, mp_int *c); /* bitwise AND */ 71 mp_err mpl_or(mp_int *a, mp_int *b, mp_int *c); /* bitwise OR */ 72 mp_err mpl_xor(mp_int *a, mp_int *b, mp_int *c); /* bitwise XOR */ 73 74 /* Shift functions */ 75 76 mp_err mpl_rsh(const mp_int *a, mp_int *b, mp_digit d); /* right shift */ 77 mp_err mpl_lsh(const mp_int *a, mp_int *b, mp_digit d); /* left shift */ 78 79 /* Bit count and parity */ 80 81 mp_err mpl_num_set(mp_int *a, int *num); /* count set bits */ 82 mp_err mpl_num_clear(mp_int *a, int *num); /* count clear bits */ 83 mp_err mpl_parity(mp_int *a); /* determine parity */ 84 85 /* Get & Set the value of a bit */ 86 87 mp_err mpl_set_bit(mp_int *a, mp_size bitNum, mp_size value); 88 mp_err mpl_get_bit(const mp_int *a, mp_size bitNum); 89 mp_err mpl_get_bits(const mp_int *a, mp_size lsbNum, mp_size numBits); 90 mp_err mpl_significant_bits(const mp_int *a); 91 92 #endif /* _MPLOGIC_H */ 93