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