ucx: src/cx/compare.h@b0ebb3d88407 (annotated)

src/cx/compare.h@b0ebb3d88407 (annotated)

src/cx/compare.h

Sun, 31 Dec 2023 14:29:46 +0100

author: Mike Becker <universe@uap-core.de>
date: Sun, 31 Dec 2023 14:29:46 +0100
changeset 786: b0ebb3d88407
parent 762: 4523f6d42512
permissions: -rw-r--r--

declare cx_compare_func in compare.h - fixes #344

 /*
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
  *
  * Copyright 2021 Mike Becker, Olaf Wintermann All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions are met:
  *
  *   1. Redistributions of source code must retain the above copyright
  *      notice, this list of conditions and the following disclaimer.
  *
  *   2. Redistributions in binary form must reproduce the above copyright
  *      notice, this list of conditions and the following disclaimer in the
  *      documentation and/or other materials provided with the distribution.
  *
  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  * POSSIBILITY OF SUCH DAMAGE.
  */
 /**
  * \file compare.h
  * \brief A collection of simple compare functions.
  * \author Mike Becker
  * \author Olaf Wintermann
  * \copyright 2-Clause BSD License
  */
 #ifndef UCX_COMPARE_H
 #define UCX_COMPARE_H
 #include "common.h"
 #ifdef __cplusplus
 extern "C" {
 #endif
 #ifndef CX_COMPARE_FUNC_DEFINED
 #define CX_COMPARE_FUNC_DEFINED
 /**
  * A comparator function comparing two collection elements.
  */
 typedef int(*cx_compare_func)(
         void const *left,
         void const *right
 );
 #endif // CX_COMPARE_FUNC_DEFINED
 /**
  * Compares two integers of type int.
  *
  * @param i1 pointer to integer one
  * @param i2 pointer to integer two
  * @return -1, if *i1 is less than *i2, 0 if both are equal,
  * 1 if *i1 is greater than *i2
  */
 int cx_cmp_int(void const *i1, void const *i2);
 /**
  * Compares two integers of type long int.
  *
  * @param i1 pointer to long integer one
  * @param i2 pointer to long integer two
  * @return -1, if *i1 is less than *i2, 0 if both are equal,
  * 1 if *i1 is greater than *i2
  */
 int cx_cmp_longint(void const *i1, void const *i2);
 /**
  * Compares two integers of type long long.
  *
  * @param i1 pointer to long long one
  * @param i2 pointer to long long two
  * @return -1, if *i1 is less than *i2, 0 if both are equal,
  * 1 if *i1 is greater than *i2
  */
 int cx_cmp_longlong(void const *i1, void const *i2);
 /**
  * Compares two integers of type int16_t.
  *
  * @param i1 pointer to int16_t one
  * @param i2 pointer to int16_t two
  * @return -1, if *i1 is less than *i2, 0 if both are equal,
  * 1 if *i1 is greater than *i2
  */
 int cx_cmp_int16(void const *i1, void const *i2);
 /**
  * Compares two integers of type int32_t.
  *
  * @param i1 pointer to int32_t one
  * @param i2 pointer to int32_t two
  * @return -1, if *i1 is less than *i2, 0 if both are equal,
  * 1 if *i1 is greater than *i2
  */
 int cx_cmp_int32(void const *i1, void const *i2);
 /**
  * Compares two integers of type int64_t.
  *
  * @param i1 pointer to int64_t one
  * @param i2 pointer to int64_t two
  * @return -1, if *i1 is less than *i2, 0 if both are equal,
  * 1 if *i1 is greater than *i2
  */
 int cx_cmp_int64(void const *i1, void const *i2);
 /**
  * Compares two integers of type unsigned int.
  *
  * @param i1 pointer to unsigned integer one
  * @param i2 pointer to unsigned integer two
  * @return -1, if *i1 is less than *i2, 0 if both are equal,
  * 1 if *i1 is greater than *i2
  */
 int cx_cmp_uint(void const *i1, void const *i2);
 /**
  * Compares two integers of type unsigned long int.
  *
  * @param i1 pointer to unsigned long integer one
  * @param i2 pointer to unsigned long integer two
  * @return -1, if *i1 is less than *i2, 0 if both are equal,
  * 1 if *i1 is greater than *i2
  */
 int cx_cmp_ulongint(void const *i1, void const *i2);
 /**
  * Compares two integers of type unsigned long long.
  *
  * @param i1 pointer to unsigned long long one
  * @param i2 pointer to unsigned long long two
  * @return -1, if *i1 is less than *i2, 0 if both are equal,
  * 1 if *i1 is greater than *i2
  */
 int cx_cmp_ulonglong(void const *i1, void const *i2);
 /**
  * Compares two integers of type uint16_t.
  *
  * @param i1 pointer to uint16_t one
  * @param i2 pointer to uint16_t two
  * @return -1, if *i1 is less than *i2, 0 if both are equal,
  * 1 if *i1 is greater than *i2
  */
 int cx_cmp_uint16(void const *i1, void const *i2);
 /**
  * Compares two integers of type uint32_t.
  *
  * @param i1 pointer to uint32_t one
  * @param i2 pointer to uint32_t two
  * @return -1, if *i1 is less than *i2, 0 if both are equal,
  * 1 if *i1 is greater than *i2
  */
 int cx_cmp_uint32(void const *i1, void const *i2);
 /**
  * Compares two integers of type uint64_t.
  *
  * @param i1 pointer to uint64_t one
  * @param i2 pointer to uint64_t two
  * @return -1, if *i1 is less than *i2, 0 if both are equal,
  * 1 if *i1 is greater than *i2
  */
 int cx_cmp_uint64(void const *i1, void const *i2);
 /**
  * Compares two real numbers of type float with precision 1e-6f.
  *
  * @param f1 pointer to float one
  * @param f2 pointer to float two
  * @return -1, if *f1 is less than *f2, 0 if both are equal,
  * 1 if *f1 is greater than *f2
  */
 int cx_cmp_float(void const *f1, void const *f2);
 /**
  * Compares two real numbers of type double with precision 1e-14.
  *
  * @param d1 pointer to double one
  * @param d2 pointer to double two
  * @return -1, if *d1 is less than *d2, 0 if both are equal,
  * 1 if *d1 is greater than *d2
  */
 int cx_cmp_double(
         void const *d1,
         void const *d2
 );
 /**
  * Compares the integer representation of two pointers.
  *
  * @param ptr1 pointer to pointer one (intptr_t const*)
  * @param ptr2 pointer to pointer two (intptr_t const*)
  * @return -1 if *ptr1 is less than *ptr2, 0 if both are equal,
  * 1 if *ptr1 is greater than *ptr2
  */
 int cx_cmp_intptr(
         void const *ptr1,
         void const *ptr2
 );
 /**
  * Compares the unsigned integer representation of two pointers.
  *
  * @param ptr1 pointer to pointer one (uintptr_t const*)
  * @param ptr2 pointer to pointer two (uintptr_t const*)
  * @return -1 if *ptr1 is less than *ptr2, 0 if both are equal,
  * 1 if *ptr1 is greater than *ptr2
  */
 int cx_cmp_uintptr(
         void const *ptr1,
         void const *ptr2
 );
 /**
  * Compares the pointers specified in the arguments without de-referencing.
  *
  * @param ptr1 pointer one
  * @param ptr2 pointer two
  * @return -1 if ptr1 is less than ptr2, 0 if both are equal,
  * 1 if ptr1 is greater than ptr2
  */
 int cx_cmp_ptr(
         void const *ptr1,
         void const *ptr2
 );
 #ifdef __cplusplus
 } // extern "C"
 #endif
 #endif //UCX_COMPARE_H

Mercurial > hg > ucx / annotate

src/cx/compare.h@b0ebb3d88407 (annotated)

src/cx/compare.h