ucx: ucx/utils.h@8170f658f017

     1 /*

     2  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.

     3  *

     4  * Copyright 2013 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  */

    29 #ifndef UCX_UTILS_H

    30 #define	UCX_UTILS_H

    32 #ifdef	__cplusplus

    33 extern "C" {

    34 #endif

    36 #include "ucx.h"

    37 #include <string.h>

    39 /**

    40  * Copies a string.

    41  * @param s the string to copy

    42  * @param data omitted

    43  * @return a pointer to a copy of s1 that can be passed to free(void*)

    44  */

    45 void *ucx_strcpy(void *s, void *data);

    47 /**

    48  * Copies a memory area.

    49  * @param m a pointer to the memory area

    50  * @param n a pointer to the size_t containing the size of the memory area

    51  * @return a pointer to a copy of the specified memory area that can

    52  * be passed to free(void*)

    53  */

    54 void *ucx_memcpy(void *m, void *n);

    56 /**

    57  * Wraps the strcmp function.

    58  * @param s1 string one

    59  * @param s2 string two

    60  * @param data omitted

    61  * @return the result of strcmp(s1, s2)

    62  */

    63 int ucx_strcmp(void *s1, void *s2, void *data);

    65 /**

    66  * Wraps the strncmp function.

    67  * @param s1 string one

    68  * @param s2 string two

    69  * @param n a pointer to the size_t containing the third strncmp parameter

    70  * @return the result of strncmp(s1, s2, *n)

    71  */

    72 int ucx_strncmp(void *s1, void *s2, void *n);

    74 /**

    75  * Compares two integers of type int.

    76  * @param i1 pointer to integer one

    77  * @param i2 pointer to integer two

    78  * @param data omitted

    79  * @return -1, if *i1 is less than *i2, 0 if both are equal,

    80  * 1 if *i1 is greater than *i2

    81  */

    83 int ucx_intcmp(void *i1, void *i2, void *data);

    85 /**

    86  * Compares two real numbers of type float.

    87  * @param f1 pointer to float one

    88  * @param f2 pointer to float two

    89  * @param if provided: a pointer to precision (default: 1e-6f)

    90  * @return -1, if *f1 is less than *f2, 0 if both are equal,

    91  * 1 if *f1 is greater than *f2

    92  */

    94 int ucx_floatcmp(void *f1, void *f2, void *data);

    96 /**

    97  * Compares two real numbers of type double.

    98  * @param f1 pointer to double one

    99  * @param f2 pointer to double two

   100 * @param if provided: a pointer to precision (default: 1e-14)

   101  * @return -1, if *d1 is less than *d2, 0 if both are equal,

   102  * 1 if *d1 is greater than *d2

   103  */

   105 int ucx_doublecmp(void *d1, void *d2, void *data);

   107 /**

   108  * Compares two pointers.

   109  * @param ptr1 pointer one

   110  * @param ptr2 pointer two

   111  * @param data omitted

   112  * @return -1 if ptr1 is less than ptr2, 0 if both are equal,

   113  * 1 if ptr1 is greater than ptr2

   114  */

   115 int ucx_ptrcmp(void *ptr1, void *ptr2, void *data);

   117 /**

   118  * Compares two memory areas.

   119  * @param ptr1 pointer one

   120  * @param ptr2 pointer two

   121  * @param n a pointer to the size_t containing the third parameter for memcmp

   122  * @return the result of memcmp(ptr1, ptr2, *n)

   123  */

   124 int ucx_memcmp(void *ptr1, void *ptr2, void *n);

   126 #ifdef	__cplusplus

   127 }

   128 #endif

   130 #endif	/* UCX_UTILS_H */

Mercurial > hg > ucx / file revision