【玩转cocos2d-x之二十五】数据结构CCArray

cocos2d-x

CCArray是从cocos2d中移植过来的，类似于Apple的NSMutableArray，但是比NSMutableArray更为的好用。要注意的是虽然CCArray和CCDictionary可以管理cocos2d-x中绝大多数的类，但是仍然无法替代STL库，STL库更为强有力。

API

先看一下CCArray可以帮我们做什么。

创建

创建
1
2
3
4
5
6
7
8
9
10
//创建array  
static CCArray* create();  
//使用一系列CCObject创建array  
static CCArray* create(CCObject* pObject, …);  
//使用一个CCObject创建array  
static CCArray* createWithObject(CCObject* pObject);  
//创建array并设置容量  
static CCArray* createWithCapacity(unsigned int capacity);  
//用一个已存在的array创建另一个array  
static CCArray* createWithArray(CCArray* otherArray);

添加

添加
1
2
3
4
5
6
//添加一个元素  
void addObject(CCObject* object);  
//添加一个已存在array中所有元素  
void addObjectsFromArray(CCArray* otherArray);  
//在指定位置插入元素  
void insertObject(CCObject* object, unsigned int index);

删除

删除
1
2
3
4
5
6
7
8
9
10
11
12
13
14
//移除最后一个元素  
void removeLastObject(bool bReleaseObj = true);  
//移除某个元素  
void removeObject(CCObject* object, bool bReleaseObj = true);  
//移除一个指定位置的元素  
void removeObjectAtIndex(unsigned int index, bool bReleaseObj = true);  
//移除某个array  
void removeObjectsInArray(CCArray* otherArray);  
//移除所有元素  
void removeAllObjects();  
//快速移除某个元素  
void fastRemoveObject(CCObject* object);  
//快速移除某个指定位置的元素  
void fastRemoveObjectAtIndex(unsigned int index);

操作元素

操作元素
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
//返回元素个数  
unsigned int count() const;  
//返回array容量  
unsigned int capacity() const;  
//返回指定CCObject的位置，如果不存在返回UINT_MAX  
unsigned int indexOfObject(CCObject* object) const;  
//返回指定位置的CCObject  
CCObject* objectAtIndex(unsigned int index);  
//返回最后一个元素  
CCObject* lastObject();  
//返回随机元素  
CCObject* randomObject();  
//返回某个元素是否存在于array中  
bool containsObject(CCObject* object) const;  
//判断array是否相等  
bool isEqualToArray(CCArray* pOtherArray);

操作array内容

操作array内容
1
2
3
4
5
6
7
8
9
10
//交换2个元素  
void exchangeObject(CCObject* object1, CCObject* object2);  
//交换2个指定位置元素  
void exchangeObjectAtIndex(unsigned int index1, unsigned int index2);  
//用一个对象替代指定位置元素  
void replaceObjectAtIndex(unsigned int uIndex, CCObject* pObject, bool bReleaseObject = true);  
//反转array  
void reverseObjects();  
//收缩array内存以匹配元素个数  
void reduceMemoryFootprint();

remove和fastremove

从API-删除可以看出删除有两种方式，普通删除和快速删除，它们有什么区别呢？

普通删除

普通删除
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
//普通删除  
void ccArrayRemoveObjectAtIndex(ccArray *arr, unsigned int index, bool bReleaseObj/* = true*/)  
{  
	CCAssert(arr && arr->num > 0 && index < arr->num, "Invalid index. Out of bounds");  
	//删除元素内容，位置仍保留着  
	if (bReleaseObj)  
	{  
		CC_SAFE_RELEASE(arr->arr[index]);  
	}  
	//长度减1  
	arr->num--;  
	//获得要删除的元素后的元素个数  
	unsigned int remaining = arr->num - index;  
	if(remaining>0)  
	{  
		//将要删除元素后的所有元素逐个向前移动  
		memmove((void *)&arr->arr[index], (void *)&arr->arr[index+1], remaining * sizeof(CCObject*));  
	}  
}

快速删除

快速删除
1
2
3
4
5
6
7
8
9
10
//快速删除  
void ccArrayFastRemoveObjectAtIndex(ccArray *arr, unsigned int index)  
{  
	//删除元素内容，位置仍保留着  
	CC_SAFE_RELEASE(arr->arr[index]);  
	//获取最后一个元素  
	unsigned int last = --arr->num;  
	//把最后一个元素插到删除元素的位置上  
	arr->arr[index] = arr->arr[last];  
}

总结

如果有array={0,1,2,3,4,5}，如果要删除3，使用普通删除得到的结果{0,1,2,4,5}，使用快速删除得到的结果是{0,1,2,5,4}。可以看出快速删除的效率比普通删除效率高，就差在移动元素的时间复杂度上。

内存分配

容量和个数

CCArray中容量和个数并不是同一个概念。个数<=容量。从添加元素的源码中可以看到在添加之前会先进行空间分配，所以它是一个动态分配内存的过程。如下

内存分配
1
2
3
4
5
6
7
void ccArrayEnsureExtraCapacity(ccArray *arr, unsigned int extra)//确保有额外的空间  
{  
	while (arr->max < arr->num + extra)//判断空间是否足够  
	{  
		ccArrayDoubleCapacity(arr);//增加一倍空间  
	}  
}

所以，每次CCArray在插入数据时检测到空间不足会增加一倍空间，再进行检测，直到空间满足分配为止。

判等

判断2个CCArray是否相等使用isEqualToArray()，判断相等的条件是CCArray中的每个元素相等即可，与CCArray的容量无关。

效率

比起NSMutableArray，CCArray效率能高出10%左右，原因有三：

（1）它使用的是C接口，所以它不有Objective-C消息开销。

（2）它假定你知道你在做什么，所以它不花时间在安全检查上（如边界溢出，空间需求等）。

（3）在比较上使用了指针而不是isEqual。

除了CCArray，我们还看到了ccCArray，CCArray基本上都是调用了ccCArray的函数，为什么要分为2种？
仔细看一下CCArray是继承于CCObject，所以CCArray是用于处理cocos2d-x对象的，内存管理上也有cocos2d-x的autorelease等诸多特性。而ccCArray可以直接操作标准的C数据结构和类型。

CCARRAY_FOREACH和CCARRAY_FOREACH_REVERSE

宏定义，用于正向遍历和反向遍历CCArray元素

正反向遍历CCArray
1
2
3
4
5
6
7
8
9
10
11
#define CCARRAY_FOREACH(__array__, __object__)                                                                         \  
   	if ((__array__) && (__array__)->data->num > 0)                                                                     \  
   	for(CCObject** __arr__ = (__array__)->data->arr, **__end__ = (__array__)->data->arr + (__array__)->data->num-1;    \  
   	__arr__ <= __end__ && (((__object__) = *__arr__) != NULL/* || true*/);                                             \  
   	__arr__++)  
 
#define CCARRAY_FOREACH_REVERSE(__array__, __object__)                                                                  \  
   	if ((__array__) && (__array__)->data->num > 0)                                                                      \  
   	for(CCObject** __arr__ = (__array__)->data->arr + (__array__)->data->num-1, **__end__ = (__array__)->data->arr;     \  
   	__arr__ >= __end__ && (((__object__) = *__arr__) != NULL/* || true*/);                                              \  
   	__arr__--)

示例

CCArray的使用示例在此文中有比较典型的应用，这里就不再详述。

注意

一般来说，CCArray不会被add到其他类，所以它的引用计数是1，而且被设置为自动释放。所以创建CCArray对象时要记得调用retain，而且在析构的时候也要调用release来释放内存。真心想吐槽。。。

本文标题:【玩转cocos2d-x之二十五】数据结构CCArray

文章作者:偶尔e网事

发布时间:2013年11月25日 - 13时53分

最后更新:2016年04月24日 - 21时40分

原始链接:http://fusijie.github.io/2013/11/25/play-cocos2dx-25/

许可协议: "署名-非商用-相同方式共享 3.0" 转载请保留原文链接及作者。

文章目录
  1. 1. API
    1. 1.1. 创建
    2. 1.2. 添加
    3. 1.3. 删除
    4. 1.4. 操作元素
    5. 1.5. 操作array内容
  2. 2. remove和fastremove
    1. 2.1. 普通删除
    2. 2.2. 快速删除
    3. 2.3. 总结
  3. 3. 内存分配
    1. 3.1. 容量和个数
    2. 3.2. 判等
  4. 4. 效率
  5. 5. CCARRAY_FOREACH和CCARRAY_FOREACH_REVERSE
  6. 6. 示例
  7. 7. 注意
,