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