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