ucx: src/cx/tree.h@425234b05dff

     1 /*

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

     3  *

     4  * Copyright 2024 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 tree.h

    30  * \brief Interface for tree implementations.

    31  * \author Mike Becker

    32  * \author Olaf Wintermann

    33  * \copyright 2-Clause BSD License

    34  */

    36 #ifndef UCX_TREE_H

    37 #define UCX_TREE_H

    39 #include "common.h"

    41 #ifdef __cplusplus

    42 extern "C" {

    43 #endif

    46 __attribute__((__nonnull__))

    47 void cx_tree_link(

    48         void * restrict parent,

    49         void * restrict node,

    50         ptrdiff_t loc_parent,

    51         ptrdiff_t loc_children,

    52         ptrdiff_t loc_prev,

    53         ptrdiff_t loc_next

    54 );

    56 __attribute__((__nonnull__))

    57 void cx_tree_unlink(

    58         void *node,

    59         ptrdiff_t loc_parent,

    60         ptrdiff_t loc_children,

    61         ptrdiff_t loc_prev,

    62         ptrdiff_t loc_next

    63 );

    65 #ifdef __cplusplus

    66 } // extern "C"

    67 #endif

    69 #endif //UCX_TREE_H

Mercurial > hg > ucx / file revision