笨辦法學C 練習34：動態陣列

飛龍發表於2019-05-09
陣列

練習34：動態陣列

原文：Exercise 34: Dynamic Array

譯者：飛龍

動態陣列是自增長的陣列，它與連結串列有很多相同的特性。它通常佔據更少的空間，跑得更快，還有一些其它的優勢屬性。這個練習會涉及到它的一些缺點，比如從開頭移除元素會很慢，並給出解決方案（只從末尾移除）。

動態陣列簡單地實現為void **指標的陣列，它是預分配記憶體的，並且指向資料。在連結串列中你建立了完整的結構體來儲存void *value指標，但是動態陣列中你只需要一個儲存它們的單個陣列。也就是說，你並不需要建立任何其它的指標儲存上一個或下一個元素。它們可以直接索引。

我會給你標頭檔案作為起始，你需要為實現打下它們：

#ifndef _DArray_h
#define _DArray_h
#include <stdlib.h>
#include <assert.h>
#include <lcthw/dbg.h>

typedef struct DArray {
    int end;
    int max;
    size_t element_size;
    size_t expand_rate;
    void **contents;
} DArray;

DArray *DArray_create(size_t element_size, size_t initial_max);

void DArray_destroy(DArray *array);

void DArray_clear(DArray *array);

int DArray_expand(DArray *array);

int DArray_contract(DArray *array);

int DArray_push(DArray *array, void *el);

void *DArray_pop(DArray *array);

void DArray_clear_destroy(DArray *array);

#define DArray_last(A) ((A)->contents[(A)->end - 1])
#define DArray_first(A) ((A)->contents[0])
#define DArray_end(A) ((A)->end)
#define DArray_count(A) DArray_end(A)
#define DArray_max(A) ((A)->max)

#define DEFAULT_EXPAND_RATE 300


static inline void DArray_set(DArray *array, int i, void *el)
{
    check(i < array->max, "darray attempt to set past max");
    if(i > array->end) array->end = i;
    array->contents[i] = el;
error:
    return;
}

static inline void *DArray_get(DArray *array, int i)
{
    check(i < array->max, "darray attempt to get past max");
    return array->contents[i];
error:
    return NULL;
}

static inline void *DArray_remove(DArray *array, int i)
{
    void *el = array->contents[i];

    array->contents[i] = NULL;

    return el;
}

static inline void *DArray_new(DArray *array)
{
    check(array->element_size > 0, "Can`t use DArray_new on 0 size darrays.");

    return calloc(1, array->element_size);

error:
    return NULL;
}

#define DArray_free(E) free((E))

#endif

這個標頭檔案向你展示了static inline的新技巧，它就類似#define巨集的工作方式，但是它們更清楚，並且易於編寫。如果你需要建立一塊程式碼作為巨集，並且不需要程式碼生成，可以使用static inline函式。

為連結串列生成for迴圈的LIST_FOREACH不可能寫為static inline函式，因為它需要生成迴圈的內部程式碼塊。實現它的唯一方式是灰調函式，但是這不夠塊，並且難以使用。

之後我會修改程式碼，並且讓你建立DArray的單元測試。

#include "minunit.h"
#include <lcthw/darray.h>

static DArray *array = NULL;
static int *val1 = NULL;
static int *val2 = NULL;

char *test_create()
{
    array = DArray_create(sizeof(int), 100);
    mu_assert(array != NULL, "DArray_create failed.");
    mu_assert(array->contents != NULL, "contents are wrong in darray");
    mu_assert(array->end == 0, "end isn`t at the right spot");
    mu_assert(array->element_size == sizeof(int), "element size is wrong.");
    mu_assert(array->max == 100, "wrong max length on initial size");

    return NULL;
}

char *test_destroy()
{
    DArray_destroy(array);

    return NULL;
}

char *test_new()
{
    val1 = DArray_new(array);
    mu_assert(val1 != NULL, "failed to make a new element");

    val2 = DArray_new(array);
    mu_assert(val2 != NULL, "failed to make a new element");

    return NULL;
}

char *test_set()
{
    DArray_set(array, 0, val1);
    DArray_set(array, 1, val2);

    return NULL;
}

char *test_get()
{
    mu_assert(DArray_get(array, 0) == val1, "Wrong first value.");
    mu_assert(DArray_get(array, 1) == val2, "Wrong second value.");

    return NULL;
}

char *test_remove()
{
    int *val_check = DArray_remove(array, 0);
    mu_assert(val_check != NULL, "Should not get NULL.");
    mu_assert(*val_check == *val1, "Should get the first value.");
    mu_assert(DArray_get(array, 0) == NULL, "Should be gone.");
    DArray_free(val_check);

    val_check = DArray_remove(array, 1);
    mu_assert(val_check != NULL, "Should not get NULL.");
    mu_assert(*val_check == *val2, "Should get the first value.");
    mu_assert(DArray_get(array, 1) == NULL, "Should be gone.");
    DArray_free(val_check);

    return NULL;
}

char *test_expand_contract()
{
    int old_max = array->max;
    DArray_expand(array);
    mu_assert((unsigned int)array->max == old_max + array->expand_rate, "Wrong size after expand.");

    DArray_contract(array);
    mu_assert((unsigned int)array->max == array->expand_rate + 1, "Should stay at the expand_rate at least.");

    DArray_contract(array);
    mu_assert((unsigned int)array->max == array->expand_rate + 1, "Should stay at the expand_rate at least.");

    return NULL;
}

char *test_push_pop()
{
    int i = 0;
    for(i = 0; i < 1000; i++) {
        int *val = DArray_new(array);
        *val = i * 333;
        DArray_push(array, val);
    }

    mu_assert(array->max == 1201, "Wrong max size.");

    for(i = 999; i >= 0; i--) {
        int *val = DArray_pop(array);
        mu_assert(val != NULL, "Shouldn`t get a NULL.");
        mu_assert(*val == i * 333, "Wrong value.");
        DArray_free(val);
    }

    return NULL;
}


char * all_tests() {
    mu_suite_start();

    mu_run_test(test_create);
    mu_run_test(test_new);
    mu_run_test(test_set);
    mu_run_test(test_get);
    mu_run_test(test_remove);
    mu_run_test(test_expand_contract);
    mu_run_test(test_push_pop);
    mu_run_test(test_destroy);

    return NULL;
}

RUN_TESTS(all_tests);

這向你展示了所有操作都如何使用，它會使DArray的實現變得容易：

#include <lcthw/darray.h>
#include <assert.h>


DArray *DArray_create(size_t element_size, size_t initial_max)
{
    DArray *array = malloc(sizeof(DArray));
    check_mem(array);
    array->max = initial_max;
    check(array->max > 0, "You must set an initial_max > 0.");

    array->contents = calloc(initial_max, sizeof(void *));
    check_mem(array->contents);

    array->end = 0;
    array->element_size = element_size;
    array->expand_rate = DEFAULT_EXPAND_RATE;

    return array;

error:
    if(array) free(array);
    return NULL;
}

void DArray_clear(DArray *array)
{
    int i = 0;
    if(array->element_size > 0) {
        for(i = 0; i < array->max; i++) {
            if(array->contents[i] != NULL) {
                free(array->contents[i]);
            }
        }
    }
}

static inline int DArray_resize(DArray *array, size_t newsize)
{
    array->max = newsize;
    check(array->max > 0, "The newsize must be > 0.");

    void *contents = realloc(array->contents, array->max * sizeof(void *));
    // check contents and assume realloc doesn`t harm the original on error

    check_mem(contents);

    array->contents = contents;

    return 0;
error:
    return -1;
}

int DArray_expand(DArray *array)
{
    size_t old_max = array->max;
    check(DArray_resize(array, array->max + array->expand_rate) == 0,
            "Failed to expand array to new size: %d",
            array->max + (int)array->expand_rate);

    memset(array->contents + old_max, 0, array->expand_rate + 1);
    return 0;

error:
    return -1;
}

int DArray_contract(DArray *array)
{
    int new_size = array->end < (int)array->expand_rate ? (int)array->expand_rate : array->end;

    return DArray_resize(array, new_size + 1);
}


void DArray_destroy(DArray *array)
{
    if(array) {
        if(array->contents) free(array->contents);
        free(array);
    }
}

void DArray_clear_destroy(DArray *array)
{
    DArray_clear(array);
    DArray_destroy(array);
}

int DArray_push(DArray *array, void *el)
{
    array->contents[array->end] = el;
    array->end++;

    if(DArray_end(array) >= DArray_max(array)) {
        return DArray_expand(array);
    } else {
        return 0;
    }
}

void *DArray_pop(DArray *array)
{
    check(array->end - 1 >= 0, "Attempt to pop from empty array.");

    void *el = DArray_remove(array, array->end - 1);
    array->end--;

    if(DArray_end(array) > (int)array->expand_rate && DArray_end(array) % array->expand_rate) {
        DArray_contract(array);
    }

    return el;
error:
    return NULL;
}

這佔你展示了另一種處理複雜程式碼的方法，觀察標頭檔案並閱讀單元測試，而不是一頭扎進.c實現中。這種“具體的抽象”讓你理解程式碼如何一起工作，並且更容易記住。

優點和缺點

DArray在你需要這些操作時佔優勢。

  • 迭代。你可以僅僅使用基本的for迴圈，使用DArray_count和DArray_get來完成任務。不需要任何特殊的巨集。並且由於不處理指標，它非常快。

  • 索引。你可以使用DArray_get和DArray_set來隨機訪問任何元素，但是List上你就必須經過第N個元素來訪問第N+1個元素。

  • 銷燬。你只需要以兩個操作銷燬結構體和content。但是List需要一些列的free呼叫同時遍歷每個元素。

  • 克隆。你只需要複製結構體和content，用兩步複製整個結構。List需要遍歷所有元素並且複製每個ListNode和值。

  • 排序。你已經見過了，如果你需要對資料排序，List非常麻煩。DArray上可以實現所有高效的排序演算法，因為你可以隨機訪問任何元素。

  • 大量資料。如果你需要儲存大量資料，DArray由於基於content，比起相同數量的ListNode佔用更少空間而佔優。

然而List在這些操作上佔優勢。

  • 在開頭插入和移除元素。DArray需要特殊的優化來高效地完成它，並且通常還需要一些複製操作。

  • 分割和連線。List只需要複製一些指標就能完成，但是DArray需要複製涉及到的所有陣列。

  • 少量資料。如果你只需要儲存幾個元素，通常使用List所需的空間要少於DArray，因為DArray需要考慮到日後的新增而擴充套件背後的空間，但是List只需要元素所需的空間。

考慮到這些，我更傾向使用DArray來完成其它人使用List所做的大部分事情。對於任何需要少量節點並且在兩端插入刪除的，我會使用List。我會想你展示兩個相似的資料結構，叫做Stack和Queue，它們也很重要。

如何改進

像往常一樣，瀏覽每個函式和操作，並且執行防禦性程式設計檢查，以及新增先決條件、不變數等任何可以使實現更健壯的東西。

附加題

  • 改進單元測試來覆蓋耕作操作，並使用for迴圈來測試迭代。

  • 研究DArray上如何實現氣泡排序和歸併排序，但是不要馬上實現它們。我會在下一張實現DArray的演算法，之後你可以完成它。

  • 為一些常用的操作編寫一些效能測試，並與List中的相同操作比較。你已經做過很多次了，但是這次需要編寫重複執行所涉及操作的單元測試，之後在主執行器中計時。

  • 觀察DArray_expand如何使用固定增長（size + 300）來實現。通常動態陣列都以倍數增長（size * 2）的方式實現，但是我發現它會花費無用的記憶體並且沒有真正取得效能收益。測試我的斷言，並且看看什麼情況下需要倍數增長而不是固定增長。

相關文章