ucx/cx/compare.h

   1 /*
   2  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
   3  *
   4  * Copyright 2021 Mike Becker, Olaf Wintermann All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions are met:
   8  *
   9  *   1. Redistributions of source code must retain the above copyright
  10  *      notice, this list of conditions and the following disclaimer.
  11  *
  12  *   2. Redistributions in binary form must reproduce the above copyright
  13  *      notice, this list of conditions and the following disclaimer in the
  14  *      documentation and/or other materials provided with the distribution.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  17  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
  20  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  21  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  22  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  23  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  24  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  25  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  26  * POSSIBILITY OF SUCH DAMAGE.
  27  */
  28 /**
  29  * \file compare.h
  30  * \brief A collection of simple compare functions.
  31  * \author Mike Becker
  32  * \author Olaf Wintermann
  33  * \version 3.0
  34  * \copyright 2-Clause BSD License
  35  */
  36
  37 #ifndef UCX_COMPARE_H
  38 #define UCX_COMPARE_H
  39
  40 #include "common.h"
  41
  42 #ifdef __cplusplus
  43 extern "C" {
  44 #endif
  45
  46 /**
  47  * Compares two integers of type int.
  48  *
  49  * @param i1 pointer to integer one
  50  * @param i2 pointer to integer two
  51  * @return -1, if *i1 is less than *i2, 0 if both are equal,
  52  * 1 if *i1 is greater than *i2
  53  */
  54 int cx_cmp_int(void const *i1, void const *i2);
  55
  56 /**
  57  * Compares two integers of type long int.
  58  *
  59  * @param i1 pointer to long integer one
  60  * @param i2 pointer to long integer two
  61  * @return -1, if *i1 is less than *i2, 0 if both are equal,
  62  * 1 if *i1 is greater than *i2
  63  */
  64 int cx_cmp_longint(void const *i1, void const *i2);
  65
  66 /**
  67  * Compares two integers of type long long.
  68  *
  69  * @param i1 pointer to long long one
  70  * @param i2 pointer to long long two
  71  * @return -1, if *i1 is less than *i2, 0 if both are equal,
  72  * 1 if *i1 is greater than *i2
  73  */
  74 int cx_cmp_longlong(void const *i1, void const *i2);
  75
  76 /**
  77  * Compares two integers of type int16_t.
  78  *
  79  * @param i1 pointer to int16_t one
  80  * @param i2 pointer to int16_t two
  81  * @return -1, if *i1 is less than *i2, 0 if both are equal,
  82  * 1 if *i1 is greater than *i2
  83  */
  84 int cx_cmp_int16(void const *i1, void const *i2);
  85
  86 /**
  87  * Compares two integers of type int32_t.
  88  *
  89  * @param i1 pointer to int32_t one
  90  * @param i2 pointer to int32_t two
  91  * @return -1, if *i1 is less than *i2, 0 if both are equal,
  92  * 1 if *i1 is greater than *i2
  93  */
  94 int cx_cmp_int32(void const *i1, void const *i2);
  95
  96 /**
  97  * Compares two integers of type int64_t.
  98  *
  99  * @param i1 pointer to int64_t one
 100  * @param i2 pointer to int64_t two
 101  * @return -1, if *i1 is less than *i2, 0 if both are equal,
 102  * 1 if *i1 is greater than *i2
 103  */
 104 int cx_cmp_int64(void const *i1, void const *i2);
 105
 106 /**
 107  * Compares two integers of type unsigned int.
 108  *
 109  * @param i1 pointer to unsigned integer one
 110  * @param i2 pointer to unsigned integer two
 111  * @return -1, if *i1 is less than *i2, 0 if both are equal,
 112  * 1 if *i1 is greater than *i2
 113  */
 114 int cx_cmp_uint(void const *i1, void const *i2);
 115
 116 /**
 117  * Compares two integers of type unsigned long int.
 118  *
 119  * @param i1 pointer to unsigned long integer one
 120  * @param i2 pointer to unsigned long integer two
 121  * @return -1, if *i1 is less than *i2, 0 if both are equal,
 122  * 1 if *i1 is greater than *i2
 123  */
 124 int cx_cmp_ulongint(void const *i1, void const *i2);
 125
 126 /**
 127  * Compares two integers of type unsigned long long.
 128  *
 129  * @param i1 pointer to unsigned long long one
 130  * @param i2 pointer to unsigned long long two
 131  * @return -1, if *i1 is less than *i2, 0 if both are equal,
 132  * 1 if *i1 is greater than *i2
 133  */
 134 int cx_cmp_ulonglong(void const *i1, void const *i2);
 135
 136 /**
 137  * Compares two integers of type uint16_t.
 138  *
 139  * @param i1 pointer to uint16_t one
 140  * @param i2 pointer to uint16_t two
 141  * @return -1, if *i1 is less than *i2, 0 if both are equal,
 142  * 1 if *i1 is greater than *i2
 143  */
 144 int cx_cmp_uint16(void const *i1, void const *i2);
 145
 146 /**
 147  * Compares two integers of type uint32_t.
 148  *
 149  * @param i1 pointer to uint32_t one
 150  * @param i2 pointer to uint32_t two
 151  * @return -1, if *i1 is less than *i2, 0 if both are equal,
 152  * 1 if *i1 is greater than *i2
 153  */
 154 int cx_cmp_uint32(void const *i1, void const *i2);
 155
 156 /**
 157  * Compares two integers of type uint64_t.
 158  *
 159  * @param i1 pointer to uint64_t one
 160  * @param i2 pointer to uint64_t two
 161  * @return -1, if *i1 is less than *i2, 0 if both are equal,
 162  * 1 if *i1 is greater than *i2
 163  */
 164 int cx_cmp_uint64(void const *i1, void const *i2);
 165
 166 /**
 167  * Compares two real numbers of type float with precision 1e-6f.
 168  *
 169  * @param f1 pointer to float one
 170  * @param f2 pointer to float two
 171  * @return -1, if *f1 is less than *f2, 0 if both are equal,
 172  * 1 if *f1 is greater than *f2
 173  */
 174
 175 int cx_cmp_float(void const *f1, void const *f2);
 176
 177 /**
 178  * Compares two real numbers of type double with precision 1e-14.
 179  *
 180  * @param d1 pointer to double one
 181  * @param d2 pointer to double two
 182  * @return -1, if *d1 is less than *d2, 0 if both are equal,
 183  * 1 if *d1 is greater than *d2
 184  */
 185 int cx_cmp_double(
 186         void const *d1,
 187         void const *d2
 188 );
 189
 190 /**
 191  * Compares the integer representation of two pointers.
 192  *
 193  * @param ptr1 pointer to pointer one (intptr_t const*)
 194  * @param ptr2 pointer to pointer two (intptr_t const*)
 195  * @return -1 if *ptr1 is less than *ptr2, 0 if both are equal,
 196  * 1 if *ptr1 is greater than *ptr2
 197  */
 198 int cx_cmp_intptr(
 199         void const *ptr1,
 200         void const *ptr2
 201 );
 202
 203 /**
 204  * Compares the unsigned integer representation of two pointers.
 205  *
 206  * @param ptr1 pointer to pointer one (uintptr_t const*)
 207  * @param ptr2 pointer to pointer two (uintptr_t const*)
 208  * @return -1 if *ptr1 is less than *ptr2, 0 if both are equal,
 209  * 1 if *ptr1 is greater than *ptr2
 210  */
 211 int cx_cmp_uintptr(
 212         void const *ptr1,
 213         void const *ptr2
 214 );
 215
 216 #ifdef __cplusplus
 217 } // extern "C"
 218 #endif
 219
 220 #endif //UCX_COMPARE_H