summaryrefslogtreecommitdiff
path: root/list.c
blob: 8163b4dc25e06bfc23ac51c3d11c8703479afe80 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
/*
 * Copyright (c) 2009, 2010 Richard Braun.
 * 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 AUTHOR ``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 AUTHOR 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.
 *
 *
 * List sorting implementation.
 *
 * In addition to most common list operations, this implementation includes
 * a sort operation. The algorithm used is a variant of the bottom-up
 * mergesort algorithm. It has the following properties :
 *  - It is iterative (no recursion overhead).
 *  - It is stable (the relative order of equal entries is preserved).
 *  - It only requires constant additional space (as it works on linked lists).
 *  - It performs at O(n log n) for average and worst cases.
 *  - It is adaptive, performing faster on already sorted lists.
 */

#include "list.h"

/*
 * Split input_list into two lists.
 *
 * The list_size first entries of input_list are moved into left_list while
 * the "right" list is actually the list_size first entries of input_list
 * after completion.
 */
static void
_list_divide(struct list *input_list, struct list *left_list,
             unsigned int list_size)
{
    struct list *node;
    unsigned int i;

    node = input_list->next;

    for (i = 0; (i < list_size) && !list_end(input_list, node); i++)
        node = node->next;

    list_split(left_list, input_list, node);
}

/*
 * Merge left_list and right_list at the tail of output_list.
 */
static void
_list_merge(struct list *left_list, struct list *right_list,
            struct list *output_list, unsigned int right_list_size,
            list_sort_cmp_fn_t cmp_fn)
{
    struct list *left, *right;

    left = left_list->prev;
    right = right_list->next;

    /*
     * Try to concatenate lists instead of merging first. This reduces
     * complexity for already sorted lists.
     */
    if (!list_end(left_list, left)
        && ((right_list_size > 0) && !list_end(right_list, right))
        && (cmp_fn(left, right) <= 0)) {
        struct list tmp_list;

        list_concat(output_list, left_list);
        list_init(left_list);

        while ((right_list_size > 0) && !list_end(right_list, right)) {
            right = right->next;
            right_list_size--;
        }

        list_split(&tmp_list, right_list, right);
        list_concat(output_list, &tmp_list);
        return;
    }

    left = left_list->next;

    while (!list_end(left_list, left)
           || ((right_list_size > 0) && !list_end(right_list, right)))
        if (((right_list_size == 0) || list_end(right_list, right))
            || (!list_end(left_list, left) && (cmp_fn(left, right) <= 0))) {
            list_remove(left);
            list_insert_tail(output_list, left);
            left = left_list->next;
        } else {
            list_remove(right);
            list_insert_tail(output_list, right);
            right = right_list->next;
            right_list_size--;
        }
}

void
list_sort(struct list *list, list_sort_cmp_fn_t cmp_fn)
{
    struct list left_list, output_list;
    unsigned int list_size, nr_merges;

    list_init(&left_list);
    list_init(&output_list);

    for (list_size = 1; /* no condition */; list_size <<= 1) {
        for (nr_merges = 0; /* no condition */; nr_merges++) {
            if (list_empty(list))
                break;

            _list_divide(list, &left_list, list_size);
            _list_merge(&left_list, list, &output_list, list_size, cmp_fn);
        }

        list_concat(list, &output_list);
        list_init(&output_list);

        if (nr_merges <= 1)
            return;
    }
}