学习笔记---动态数组实现

看李先静的《系统程序员的成长计划》里面的动态数组的实现甚是巧妙，整理如下：

 

---

 

typedef.h:

#include <stdio.h> #include <assert.h> #include <stdlib.h> #ifndef TYPEDEF_H #define TYPEDEF_H typedef enum _Ret { RET_OK, RET_OOM, RET_STOP, RET_INVALID_PARAMS, RET_FAIL }Ret; typedef void (*DataDestroyFunc)(void* ctx, void* data); typedef int (*DataCompareFunc)(void* ctx, void* data); typedef Ret (*DataVisitFunc)(void* ctx, void* data); #ifdef __cplusplus #define DECLS_BEGIN extern "C" { #define DECLS_END } #else #define DECLS_BEGIN #define DECLS_END #endif/*__cplusplus*/ #define return_if_fail(p) if(!(p)) / {printf("%s:%d Warning: "#p" failed./n", / __func__, __LINE__); return;} #define return_val_if_fail(p, ret) if(!(p)) / {printf("%s:%d Warning: "#p" failed./n",/ __func__, __LINE__); return (ret);} #define SAFE_FREE(p) if(p != NULL) {free(p); p = NULL;} typedef Ret (*SortFunc)(void** array, size_t nr, DataCompareFunc cmp); #endif/*TYPEDEF_H*/ 

darray.h:

#include <stdio.h> #include "typedef.h" #ifndef DARRAY_H #define DARRAY_H DECLS_BEGIN struct _DArray; typedef struct _DArray DArray; DArray* darray_create(DataDestroyFunc data_destroy, void* ctx); Ret darray_insert(DArray* thiz, size_t index, void* data); Ret darray_prepend(DArray* thiz, void* data); Ret darray_append(DArray* thiz, void* data); Ret darray_delete(DArray* thiz, size_t index); Ret darray_get_by_index(DArray* thiz, size_t index, void** data); Ret darray_set_by_index(DArray* thiz, size_t index, void* data); size_t darray_length(DArray* thiz); int darray_find(DArray* thiz, DataCompareFunc cmp, void* ctx); Ret darray_foreach(DArray* thiz, DataVisitFunc visit, void* ctx); void darray_destroy(DArray* thiz); DECLS_END #endif/*DARRAY_H*/ 

darray.cpp:

#include "stdafx.h" #include <stdlib.h> #include "darray.h" struct _DArray { void** data;//数组中存放的数据 size_t size;//数组内元素的个数 size_t alloc_size;//数组分配的大小--即最大容量 void* data_destroy_ctx; DataDestroyFunc data_destroy; }; // static void darray_destroy_data(DArray* thiz, void* data) { if(thiz->data_destroy != NULL) { thiz->data_destroy(thiz->data_destroy_ctx, data); } return; } //创建一个动态数组： DArray* darray_create(DataDestroyFunc data_destroy, void* ctx) { DArray* thiz = (DArray*)malloc(sizeof(DArray)); if(thiz != NULL) { thiz->data = NULL; thiz->size = 0; thiz->alloc_size = 0; thiz->data_destroy = data_destroy; thiz->data_destroy_ctx = ctx;//? } return thiz; } //增加空间： #define MIN_PRE_ALLOCATE_NR 10 //预分配空间 static Ret darray_expand(DArray* thiz, size_t need)//私有方法，其他文件不能使用 { //return_val_if_fail(thiz != NULL, RET_INVALID_PARAMS); //? assert(thiz != NULL); if((thiz->size + need) > thiz->alloc_size)//元素个数+需求>最大容量 { size_t alloc_size = thiz->alloc_size + (thiz->alloc_size>>1) + MIN_PRE_ALLOCATE_NR;//扩展为1.5倍 void** data = (void**)realloc(thiz->data, sizeof(void*) * alloc_size); if(data != NULL) { thiz->data = data; thiz->alloc_size = alloc_size; } } return ((thiz->size + need) <= thiz->alloc_size) ? RET_OK : RET_FAIL; } //紧缩空间： static Ret darray_shrink(DArray* thiz)//private { //return_val_if_fail(thiz != NULL, RET_INVALID_PARAMS); assert(thiz != NULL); if((thiz->size < (thiz->alloc_size >> 1)) && (thiz->alloc_size > MIN_PRE_ALLOCATE_NR))//元素<最大容量的0.5倍且最大容量>最大分配阈值 { size_t alloc_size = thiz->size + (thiz->size >> 1);//紧缩为元素个数的1.5倍 void** data = (void**)realloc(thiz->data, sizeof(void*) * alloc_size); if(data != NULL) { thiz->data = data; thiz->alloc_size = alloc_size; } } return RET_OK; } //在指定的位置插入一个元素 Ret darray_insert(DArray* thiz, size_t index, void* data) { Ret ret = RET_OOM; size_t cursor = index; //return_val_if_fail(thiz != NULL, RET_INVALID_PARAMS); assert(thiz != NULL); cursor = cursor < thiz->size ? cursor : thiz->size;//是否到了最后 if(darray_expand(thiz, 1) == RET_OK)//分配1个空间 { size_t i = 0; for(i = thiz->size; i > cursor; i--)//依次平移cursor后面的元素一个位置 { thiz->data[i] = thiz->data[i-1]; } thiz->data[cursor] = data; thiz->size++; ret = RET_OK; } return ret; } //头部插入一个元素 Ret darray_prepend(DArray* thiz, void* data) { return darray_insert(thiz, 0, data); } //尾部插入一个元素 Ret darray_append(DArray* thiz, void* data) { return darray_insert(thiz, -1, data); } //删除指定位置的元素 Ret darray_delete(DArray* thiz, size_t index) { size_t i = 0; Ret ret = RET_OK; //return_val_if_fail(thiz != NULL && thiz->size > index, RET_INVALID_PARAMS); assert(thiz != NULL && thiz->size > index); darray_destroy_data(thiz, thiz->data[index]); for(i = index; (i+1) < thiz->size; i++) { thiz->data[i] = thiz->data[i+1]; } thiz->size--; darray_shrink(thiz); return RET_OK; } //获得指定索引处的值 Ret darray_get_by_index(DArray* thiz, size_t index, void** data) { //return_val_if_fail(thiz != NULL && data != NULL && index < thiz->size, RET_INVALID_PARAMS); assert(thiz != NULL && data != NULL && index < thiz->size); *data = thiz->data[index]; return RET_OK; } //将指定索引处设为指定的值 Ret darray_set_by_index(DArray* thiz, size_t index, void* data) { //return_val_if_fail(thiz != NULL && index < thiz->size, RET_INVALID_PARAMS); assert(thiz != NULL && data != NULL && index < thiz->size); thiz->data[index] = data; return RET_OK; } //获得数组元素的个数 size_t darray_length(DArray* thiz) { //return_val_if_fail(thiz != NULL, 0); assert(thiz != NULL); return thiz->size; } //按照传入的规则(回调函数)依次访问每个元素 Ret darray_foreach(DArray* thiz, DataVisitFunc visit, void* ctx)//ctx:回调函数上下文 { size_t i = 0; Ret ret = RET_OK; //return_val_if_fail(thiz != NULL && visit != NULL, RET_INVALID_PARAMS); assert(thiz != NULL && visit != NULL); for(i = 0; i < thiz->size; i++) { ret = visit(ctx, thiz->data[i]); } return ret; } //按照传入的规则(回调函数)查找给定值所在的位置 int darray_find(DArray* thiz, DataCompareFunc cmp, void* ctx) { size_t i = 0; //return_val_if_fail(thiz != NULL && cmp != NULL, -1); assert(thiz != NULL && cmp != NULL); for(i = 0; i < thiz->size; i++) { if(cmp(ctx, thiz->data[i]) == 0) { break; } } return i; } //删除数组 void darray_destroy(DArray* thiz) { size_t i = 0; if(thiz != NULL) { for(i = 0; i < thiz->size; i++) { darray_destroy_data(thiz, thiz->data[i]); } SAFE_FREE(thiz->data); SAFE_FREE(thiz); } return; } //test static Ret vistFuc(void* ctx, void* data){ printf("%d ",(int)data); return RET_OK; } //test static int compareFuc(void* ctx, void* data){ return (int )ctx - (int)data; } int _tmain(int argc, _TCHAR* argv[]) { //test create DArray* thiz = darray_create(NULL,NULL); int data1 = 11; darray_insert(thiz,0,(void*)data1); //test set by index int modfyData = 13; darray_set_by_index(thiz,0,(void*)modfyData); //test append int appendData = 24; darray_append(thiz,(void*)appendData); //test append int prependData = 30; darray_prepend(thiz,(void*)prependData); //test get by index int resultData = 0; darray_get_by_index(thiz,0,(void**)&resultData); printf("%d/n",resultData); //test darray length printf("length:%d/n",darray_length(thiz)); //test darray_foreach darray_foreach(thiz,vistFuc,NULL); printf("/n"); //test darray_find int findData = 13; printf("find index:%d/n",darray_find(thiz,compareFuc,(void*)findData)); return 0; }  

 

---

 

学到了什么：

1、返回值统一管理

typedef enum _Ret { RET_OK, RET_OOM, RET_STOP, RET_INVALID_PARAMS, RET_FAIL }Ret; 

2、宏定义安全的删除，防止出现野指针

#define SAFE_FREE(p) if(p != NULL) {free(p); p = NULL;} 

3、宏定义extern "C"

#ifdef __cplusplus #define DECLS_BEGIN extern "C" { #define DECLS_END } #else #define DECLS_BEGIN #define DECLS_END #endif/*__cplusplus*/ //.... #endif/*TYPEDEF_H*/ 

4、分配空间时有个预分配过程，释放空间时不马上释放空闲空间。

5、让数组支持多种类型的数据：使用void*

用下面这种方式传入数值：

int data1 = 11; darray_insert(thiz,0,(void*)data1); 

用下面这种方式输出数值：

static Ret vistFuc(void* ctx, void* data){ //... printf("%d ",(int)data); //... }